diff options
Diffstat (limited to 'documentation/ref-manual/ref-variables.rst')
-rw-r--r-- | documentation/ref-manual/ref-variables.rst | 724 |
1 files changed, 259 insertions, 465 deletions
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index 880e76a0ed..410fe9042b 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst | |||
@@ -78,7 +78,7 @@ system and gives an overview of their function and contents. | |||
78 | 78 | ||
79 | .. note:: | 79 | .. note:: |
80 | 80 | ||
81 | If ALTERNATIVE_LINK_NAME is not defined, it defaults to ${bindir}/ name. | 81 | If ``ALTERNATIVE_LINK_NAME`` is not defined, it defaults to ``${bindir}/name``. |
82 | 82 | ||
83 | For more information on the alternatives system, see the | 83 | For more information on the alternatives system, see the |
84 | ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" | 84 | ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" |
@@ -237,15 +237,9 @@ system and gives an overview of their function and contents. | |||
237 | 237 | ||
238 | .. note:: | 238 | .. note:: |
239 | 239 | ||
240 | It is assumed that all changes to | 240 | It is assumed that all changes to ``COMMON_LICENSE_DIR`` and |
241 | COMMON_LICENSE_DIR | 241 | ``LICENSE_PATH`` have been done before ``AVAILABLE_LICENSES`` |
242 | and | 242 | is defined (in :ref:`ref-classes-license`). |
243 | LICENSE_PATH | ||
244 | have been done before | ||
245 | AVAILABLE_LICENSES | ||
246 | is defined (in | ||
247 | license.bbclass | ||
248 | ). | ||
249 | 243 | ||
250 | :term:`AVAILTUNES` | 244 | :term:`AVAILTUNES` |
251 | The list of defined CPU and Application Binary Interface (ABI) | 245 | The list of defined CPU and Application Binary Interface (ABI) |
@@ -389,7 +383,8 @@ system and gives an overview of their function and contents. | |||
389 | add the ``BB_DISKMON_DIRS`` variable to your ``conf/local.conf`` file | 383 | add the ``BB_DISKMON_DIRS`` variable to your ``conf/local.conf`` file |
390 | found in the :term:`Build Directory`. Use the | 384 | found in the :term:`Build Directory`. Use the |
391 | following form: | 385 | following form: |
392 | :: | 386 | |
387 | .. code-block:: none | ||
393 | 388 | ||
394 | BB_DISKMON_DIRS = "action,dir,threshold [...]" | 389 | BB_DISKMON_DIRS = "action,dir,threshold [...]" |
395 | 390 | ||
@@ -473,7 +468,8 @@ system and gives an overview of their function and contents. | |||
473 | 468 | ||
474 | When specifying the variable in your configuration file, use the | 469 | When specifying the variable in your configuration file, use the |
475 | following form: | 470 | following form: |
476 | :: | 471 | |
472 | .. code-block:: none | ||
477 | 473 | ||
478 | BB_DISKMON_WARNINTERVAL = "disk_space_interval,disk_inode_interval" | 474 | BB_DISKMON_WARNINTERVAL = "disk_space_interval,disk_inode_interval" |
479 | 475 | ||
@@ -619,8 +615,7 @@ system and gives an overview of their function and contents. | |||
619 | 615 | ||
620 | .. tip:: | 616 | .. tip:: |
621 | 617 | ||
622 | You can use the command | 618 | You can use the command ``bitbake-layers show-layers`` |
623 | bitbake-layers show-layers | ||
624 | to list all configured layers along with their priorities. | 619 | to list all configured layers along with their priorities. |
625 | 620 | ||
626 | :term:`BBFILES` | 621 | :term:`BBFILES` |
@@ -653,7 +648,8 @@ system and gives an overview of their function and contents. | |||
653 | 648 | ||
654 | This next example shows an error message that occurs because invalid | 649 | This next example shows an error message that occurs because invalid |
655 | entries are found, which cause parsing to abort: | 650 | entries are found, which cause parsing to abort: |
656 | :: | 651 | |
652 | .. code-block:: none | ||
657 | 653 | ||
658 | ERROR: BBFILES_DYNAMIC entries must be of the form <collection name>:<filename pattern>, not: | 654 | ERROR: BBFILES_DYNAMIC entries must be of the form <collection name>:<filename pattern>, not: |
659 | /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend | 655 | /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend |
@@ -675,7 +671,8 @@ system and gives an overview of their function and contents. | |||
675 | :: | 671 | :: |
676 | 672 | ||
677 | BBLAYERS = " \ | 673 | BBLAYERS = " \ |
678 | /home/scottrif/poky/meta \ /home/scottrif/poky/meta-poky \ | 674 | /home/scottrif/poky/meta \ |
675 | /home/scottrif/poky/meta-poky \ | ||
679 | /home/scottrif/poky/meta-yocto-bsp \ | 676 | /home/scottrif/poky/meta-yocto-bsp \ |
680 | /home/scottrif/poky/meta-mykernel \ | 677 | /home/scottrif/poky/meta-mykernel \ |
681 | " | 678 | " |
@@ -799,16 +796,12 @@ system and gives an overview of their function and contents. | |||
799 | 796 | ||
800 | .. note:: | 797 | .. note:: |
801 | 798 | ||
802 | The | 799 | The ``BINCONFIG_GLOB`` variable uses |
803 | BINCONFIG_GLOB | 800 | `shell globbing <https://tldp.org/LDP/abs/html/globbingref.html>`__, |
804 | variable uses | 801 | which is recognition and expansion of wildcards during pattern |
805 | shell globbing | ||
806 | , which is recognition and expansion of wildcards during pattern | ||
807 | matching. Shell globbing is very similar to | 802 | matching. Shell globbing is very similar to |
808 | fnmatch | 803 | `fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__ |
809 | and | 804 | and `glob <https://docs.python.org/3/library/glob.html>`__. |
810 | glob | ||
811 | . | ||
812 | 805 | ||
813 | For more information on how this variable works, see | 806 | For more information on how this variable works, see |
814 | ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`. | 807 | ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`. |
@@ -944,7 +937,7 @@ system and gives an overview of their function and contents. | |||
944 | :term:`BUILDDIR` | 937 | :term:`BUILDDIR` |
945 | Points to the location of the :term:`Build Directory`. | 938 | Points to the location of the :term:`Build Directory`. |
946 | You can define this directory indirectly through the | 939 | You can define this directory indirectly through the |
947 | ````` <#structure-core-script>`__ script by passing in a Build | 940 | :ref:`structure-core-script` script by passing in a Build |
948 | Directory path when you run the script. If you run the script and do | 941 | Directory path when you run the script. If you run the script and do |
949 | not provide a Build Directory path, the ``BUILDDIR`` defaults to | 942 | not provide a Build Directory path, the ``BUILDDIR`` defaults to |
950 | ``build`` in the current directory. | 943 | ``build`` in the current directory. |
@@ -1133,10 +1126,8 @@ system and gives an overview of their function and contents. | |||
1133 | 1126 | ||
1134 | .. note:: | 1127 | .. note:: |
1135 | 1128 | ||
1136 | CLASSOVERRIDE | 1129 | ``CLASSOVERRIDE`` gets its default "class-target" value from the |
1137 | gets its default "class-target" value from the | 1130 | ``bitbake.conf`` file. |
1138 | bitbake.conf | ||
1139 | file. | ||
1140 | 1131 | ||
1141 | As an example, the following override allows you to install extra | 1132 | As an example, the following override allows you to install extra |
1142 | files, but only when building for the target: | 1133 | files, but only when building for the target: |
@@ -1208,13 +1199,10 @@ system and gives an overview of their function and contents. | |||
1208 | 1199 | ||
1209 | .. note:: | 1200 | .. note:: |
1210 | 1201 | ||
1211 | The | 1202 | The ``COMPLEMENTARY_GLOB`` variable uses Unix filename pattern matching |
1212 | COMPLEMENTARY_GLOB | 1203 | (`fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__), |
1213 | variable uses Unix filename pattern matching ( | 1204 | which is similar to the Unix style pathname pattern expansion |
1214 | fnmatch | 1205 | (`glob <https://docs.python.org/3/library/glob.html>`__). |
1215 | ), which is similar to the Unix style pathname pattern expansion ( | ||
1216 | glob | ||
1217 | ). | ||
1218 | 1206 | ||
1219 | The resulting list of complementary packages is associated with an | 1207 | The resulting list of complementary packages is associated with an |
1220 | item that can be added to | 1208 | item that can be added to |
@@ -1274,22 +1262,12 @@ system and gives an overview of their function and contents. | |||
1274 | 1262 | ||
1275 | .. note:: | 1263 | .. note:: |
1276 | 1264 | ||
1277 | When specifying paths as part of the | 1265 | When specifying paths as part of the ``CONFFILES`` variable, it is |
1278 | CONFFILES | 1266 | good practice to use appropriate path variables. |
1279 | variable, it is good practice to use appropriate path variables. | 1267 | For example, ``${sysconfdir}`` rather than ``/etc`` or ``${bindir}`` |
1280 | For example, | 1268 | rather than ``/usr/bin``. You can find a list of these variables at |
1281 | ${sysconfdir} | 1269 | the top of the ``meta/conf/bitbake.conf`` file in the |
1282 | rather than | 1270 | :term:`Source Directory`. |
1283 | /etc | ||
1284 | or | ||
1285 | ${bindir} | ||
1286 | rather than | ||
1287 | /usr/bin | ||
1288 | . You can find a list of these variables at the top of the | ||
1289 | meta/conf/bitbake.conf | ||
1290 | file in the | ||
1291 | Source Directory | ||
1292 | . | ||
1293 | 1271 | ||
1294 | :term:`CONFIG_INITRAMFS_SOURCE` | 1272 | :term:`CONFIG_INITRAMFS_SOURCE` |
1295 | Identifies the initial RAM filesystem (initramfs) source files. The | 1273 | Identifies the initial RAM filesystem (initramfs) source files. The |
@@ -1339,11 +1317,8 @@ system and gives an overview of their function and contents. | |||
1339 | 1317 | ||
1340 | .. note:: | 1318 | .. note:: |
1341 | 1319 | ||
1342 | The | 1320 | The ``COPYLEFT_LICENSE_EXCLUDE`` variable takes precedence over the |
1343 | COPYLEFT_LICENSE_EXCLUDE | 1321 | :term:`COPYLEFT_LICENSE_INCLUDE` variable. |
1344 | variable takes precedence over the | ||
1345 | COPYLEFT_LICENSE_INCLUDE | ||
1346 | variable. | ||
1347 | 1322 | ||
1348 | The default value, which is "CLOSED Proprietary", for | 1323 | The default value, which is "CLOSED Proprietary", for |
1349 | ``COPYLEFT_LICENSE_EXCLUDE`` is set by the | 1324 | ``COPYLEFT_LICENSE_EXCLUDE`` is set by the |
@@ -1410,15 +1385,12 @@ system and gives an overview of their function and contents. | |||
1410 | 1385 | ||
1411 | .. note:: | 1386 | .. note:: |
1412 | 1387 | ||
1413 | The | 1388 | The ``COPY_LIC_DIRS`` does not offer a path for adding licenses for |
1414 | COPY_LIC_DIRS | 1389 | newly installed packages to an image, which might be most suitable for |
1415 | does not offer a path for adding licenses for newly installed | 1390 | read-only filesystems that cannot be upgraded. See the |
1416 | packages to an image, which might be most suitable for read-only | 1391 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. |
1417 | filesystems that cannot be upgraded. See the | 1392 | You can also reference the ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" |
1418 | LICENSE_CREATE_PACKAGE | 1393 | section in the Yocto Project Development Tasks Manual for |
1419 | variable for additional information. You can also reference the " | ||
1420 | Providing License Text | ||
1421 | " section in the Yocto Project Development Tasks Manual for | ||
1422 | information on providing license text. | 1394 | information on providing license text. |
1423 | 1395 | ||
1424 | :term:`COPY_LIC_MANIFEST` | 1396 | :term:`COPY_LIC_MANIFEST` |
@@ -1429,15 +1401,12 @@ system and gives an overview of their function and contents. | |||
1429 | 1401 | ||
1430 | .. note:: | 1402 | .. note:: |
1431 | 1403 | ||
1432 | The | 1404 | The ``COPY_LIC_MANIFEST`` does not offer a path for adding licenses for |
1433 | COPY_LIC_MANIFEST | 1405 | newly installed packages to an image, which might be most suitable for |
1434 | does not offer a path for adding licenses for newly installed | 1406 | read-only filesystems that cannot be upgraded. See the |
1435 | packages to an image, which might be most suitable for read-only | 1407 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. |
1436 | filesystems that cannot be upgraded. See the | 1408 | You can also reference the ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" |
1437 | LICENSE_CREATE_PACKAGE | 1409 | section in the Yocto Project Development Tasks Manual for |
1438 | variable for additional information. You can also reference the " | ||
1439 | Providing License Text | ||
1440 | " section in the Yocto Project Development Tasks Manual for | ||
1441 | information on providing license text. | 1410 | information on providing license text. |
1442 | 1411 | ||
1443 | :term:`CORE_IMAGE_EXTRA_INSTALL` | 1412 | :term:`CORE_IMAGE_EXTRA_INSTALL` |
@@ -1500,8 +1469,7 @@ system and gives an overview of their function and contents. | |||
1500 | 1469 | ||
1501 | .. note:: | 1470 | .. note:: |
1502 | 1471 | ||
1503 | The OpenEmbedded build system sets the | 1472 | The OpenEmbedded build system sets the ``CROSS_COMPILE`` |
1504 | CROSS_COMPILE | ||
1505 | variable only in certain contexts (e.g. when building for kernel | 1473 | variable only in certain contexts (e.g. when building for kernel |
1506 | and kernel module recipes). | 1474 | and kernel module recipes). |
1507 | 1475 | ||
@@ -1541,8 +1509,7 @@ system and gives an overview of their function and contents. | |||
1541 | .. note:: | 1509 | .. note:: |
1542 | 1510 | ||
1543 | Tasks that read from or write to this directory should run under | 1511 | Tasks that read from or write to this directory should run under |
1544 | fakeroot | 1512 | :ref:`fakeroot <overview-manual/overview-manual-concepts:fakeroot and pseudo>`. |
1545 | . | ||
1546 | 1513 | ||
1547 | :term:`DATE` | 1514 | :term:`DATE` |
1548 | The date the build was started. Dates appear using the year, month, | 1515 | The date the build was started. Dates appear using the year, month, |
@@ -1593,12 +1560,9 @@ system and gives an overview of their function and contents. | |||
1593 | 1560 | ||
1594 | .. note:: | 1561 | .. note:: |
1595 | 1562 | ||
1596 | The bias provided by | 1563 | The bias provided by ``DEFAULT_PREFERENCE`` is weak and is overridden |
1597 | DEFAULT_PREFERENCE | 1564 | by :term:`BBFILE_PRIORITY` if that variable is different between two |
1598 | is weak and is overridden by | 1565 | layers that contain different versions of the same recipe. |
1599 | BBFILE_PRIORITY | ||
1600 | if that variable is different between two layers that contain | ||
1601 | different versions of the same recipe. | ||
1602 | 1566 | ||
1603 | :term:`DEFAULTTUNE` | 1567 | :term:`DEFAULTTUNE` |
1604 | The default CPU and Application Binary Interface (ABI) tunings (i.e. | 1568 | The default CPU and Application Binary Interface (ABI) tunings (i.e. |
@@ -1635,8 +1599,7 @@ system and gives an overview of their function and contents. | |||
1635 | 1599 | ||
1636 | .. note:: | 1600 | .. note:: |
1637 | 1601 | ||
1638 | It seldom is necessary to reference, for example, | 1602 | It seldom is necessary to reference, for example, ``STAGING_DIR_HOST`` |
1639 | STAGING_DIR_HOST | ||
1640 | explicitly. The standard classes and build-related variables are | 1603 | explicitly. The standard classes and build-related variables are |
1641 | configured to automatically use the appropriate staging sysroots. | 1604 | configured to automatically use the appropriate staging sysroots. |
1642 | 1605 | ||
@@ -1807,7 +1770,7 @@ system and gives an overview of their function and contents. | |||
1807 | is set in the ``deploy`` class as follows: | 1770 | is set in the ``deploy`` class as follows: |
1808 | :: | 1771 | :: |
1809 | 1772 | ||
1810 | DEPLOYDIR = "${WORKDIR}/deploy-${:term:`PN`}" | 1773 | DEPLOYDIR = "${WORKDIR}/deploy-${PN}" |
1811 | 1774 | ||
1812 | Recipes inheriting the ``deploy`` class should copy files to be | 1775 | Recipes inheriting the ``deploy`` class should copy files to be |
1813 | deployed into ``DEPLOYDIR``, and the class will take care of copying | 1776 | deployed into ``DEPLOYDIR``, and the class will take care of copying |
@@ -1844,12 +1807,9 @@ system and gives an overview of their function and contents. | |||
1844 | 1807 | ||
1845 | .. note:: | 1808 | .. note:: |
1846 | 1809 | ||
1847 | If the | 1810 | If the ``DISTRO`` variable is blank, a set of default configurations |
1848 | DISTRO | 1811 | are used, which are specified within |
1849 | variable is blank, a set of default configurations are used, which | 1812 | ``meta/conf/distro/defaultsetup.conf`` also in the Source Directory. |
1850 | are specified within | ||
1851 | meta/conf/distro/defaultsetup.conf | ||
1852 | also in the Source Directory. | ||
1853 | 1813 | ||
1854 | :term:`DISTRO_CODENAME` | 1814 | :term:`DISTRO_CODENAME` |
1855 | Specifies a codename for the distribution being built. | 1815 | Specifies a codename for the distribution being built. |
@@ -1884,8 +1844,7 @@ system and gives an overview of their function and contents. | |||
1884 | 1844 | ||
1885 | Two more examples are Bluetooth and NFS support. For a more complete | 1845 | Two more examples are Bluetooth and NFS support. For a more complete |
1886 | list of features that ships with the Yocto Project and that you can | 1846 | list of features that ships with the Yocto Project and that you can |
1887 | provide with this variable, see the "`Distro | 1847 | provide with this variable, see the ":ref:`ref-features-distro`" section. |
1888 | Features <#ref-features-distro>`__" section. | ||
1889 | 1848 | ||
1890 | :term:`DISTRO_FEATURES_BACKFILL` | 1849 | :term:`DISTRO_FEATURES_BACKFILL` |
1891 | Features to be added to ``DISTRO_FEATURES`` if not also present in | 1850 | Features to be added to ``DISTRO_FEATURES`` if not also present in |
@@ -1894,15 +1853,13 @@ system and gives an overview of their function and contents. | |||
1894 | This variable is set in the ``meta/conf/bitbake.conf`` file. It is | 1853 | This variable is set in the ``meta/conf/bitbake.conf`` file. It is |
1895 | not intended to be user-configurable. It is best to just reference | 1854 | not intended to be user-configurable. It is best to just reference |
1896 | the variable to see which distro features are being backfilled for | 1855 | the variable to see which distro features are being backfilled for |
1897 | all distro configurations. See the "`Feature | 1856 | all distro configurations. See the ":ref:`ref-features-backfill`" section |
1898 | Backfilling <#ref-features-backfill>`__" section for more | 1857 | for more information. |
1899 | information. | ||
1900 | 1858 | ||
1901 | :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` | 1859 | :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` |
1902 | Features from ``DISTRO_FEATURES_BACKFILL`` that should not be | 1860 | Features from ``DISTRO_FEATURES_BACKFILL`` that should not be |
1903 | backfilled (i.e. added to ``DISTRO_FEATURES``) during the build. See | 1861 | backfilled (i.e. added to ``DISTRO_FEATURES``) during the build. See |
1904 | the "`Feature Backfilling <#ref-features-backfill>`__" section for | 1862 | the ":ref:`ref-features-backfill`" section for more information. |
1905 | more information. | ||
1906 | 1863 | ||
1907 | :term:`DISTRO_FEATURES_DEFAULT` | 1864 | :term:`DISTRO_FEATURES_DEFAULT` |
1908 | A convenience variable that gives you the default list of distro | 1865 | A convenience variable that gives you the default list of distro |
@@ -1973,12 +1930,9 @@ system and gives an overview of their function and contents. | |||
1973 | 1930 | ||
1974 | .. note:: | 1931 | .. note:: |
1975 | 1932 | ||
1976 | If the | 1933 | If the ``DISTRO_NAME`` variable is blank, a set of default |
1977 | DISTRO_NAME | 1934 | configurations are used, which are specified within |
1978 | variable is blank, a set of default configurations are used, which | 1935 | ``meta/conf/distro/defaultsetup.conf`` also in the Source Directory. |
1979 | are specified within | ||
1980 | meta/conf/distro/defaultsetup.conf | ||
1981 | also in the Source Directory. | ||
1982 | 1936 | ||
1983 | :term:`DISTRO_VERSION` | 1937 | :term:`DISTRO_VERSION` |
1984 | The version of the distribution. | 1938 | The version of the distribution. |
@@ -2028,8 +1982,7 @@ system and gives an overview of their function and contents. | |||
2028 | You can safely share this directory between multiple builds on the | 1982 | You can safely share this directory between multiple builds on the |
2029 | same development machine. For additional information on how the build | 1983 | same development machine. For additional information on how the build |
2030 | process gets source files when working behind a firewall or proxy | 1984 | process gets source files when working behind a firewall or proxy |
2031 | server, see this specific question in the | 1985 | server, see this specific question in the ":doc:`faq`" |
2032 | "`FAQ <#how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server>`__" | ||
2033 | chapter. You can also refer to the | 1986 | chapter. You can also refer to the |
2034 | ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" | 1987 | ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" |
2035 | Wiki page. | 1988 | Wiki page. |
@@ -2089,12 +2042,10 @@ system and gives an overview of their function and contents. | |||
2089 | .. note:: | 2042 | .. note:: |
2090 | 2043 | ||
2091 | The shared libraries resolver's functionality results in part from | 2044 | The shared libraries resolver's functionality results in part from |
2092 | the internal function | 2045 | the internal function ``package_do_shlibs``, which is part of the |
2093 | package_do_shlibs | 2046 | :ref:`ref-tasks-package` task. You should be aware that the shared |
2094 | , which is part of the | 2047 | libraries resolver might implicitly define some dependencies between |
2095 | do_package | 2048 | packages. |
2096 | task. You should be aware that the shared libraries resolver might | ||
2097 | implicitly define some dependencies between packages. | ||
2098 | 2049 | ||
2099 | The ``EXCLUDE_FROM_SHLIBS`` variable is similar to the | 2050 | The ``EXCLUDE_FROM_SHLIBS`` variable is similar to the |
2100 | :term:`PRIVATE_LIBS` variable, which excludes a | 2051 | :term:`PRIVATE_LIBS` variable, which excludes a |
@@ -2117,13 +2068,10 @@ system and gives an overview of their function and contents. | |||
2117 | 2068 | ||
2118 | .. note:: | 2069 | .. note:: |
2119 | 2070 | ||
2120 | Recipes added to | 2071 | Recipes added to ``EXCLUDE_FROM_WORLD`` may still be built during a |
2121 | EXCLUDE_FROM_WORLD | 2072 | world build in order to satisfy dependencies of other recipes. Adding |
2122 | may still be built during a world build in order to satisfy | 2073 | a recipe to ``EXCLUDE_FROM_WORLD`` only ensures that the recipe is not |
2123 | dependencies of other recipes. Adding a recipe to | 2074 | explicitly added to the list of build targets in a world build. |
2124 | EXCLUDE_FROM_WORLD | ||
2125 | only ensures that the recipe is not explicitly added to the list | ||
2126 | of build targets in a world build. | ||
2127 | 2075 | ||
2128 | :term:`EXTENDPE` | 2076 | :term:`EXTENDPE` |
2129 | Used with file and pathnames to create a prefix for a recipe's | 2077 | Used with file and pathnames to create a prefix for a recipe's |
@@ -2205,8 +2153,7 @@ system and gives an overview of their function and contents. | |||
2205 | .. note:: | 2153 | .. note:: |
2206 | 2154 | ||
2207 | To enable primary features from within the image recipe, use the | 2155 | To enable primary features from within the image recipe, use the |
2208 | IMAGE_FEATURES | 2156 | :term:`IMAGE_FEATURES` variable. |
2209 | variable. | ||
2210 | 2157 | ||
2211 | Here are some examples of features you can add: | 2158 | Here are some examples of features you can add: |
2212 | 2159 | ||
@@ -2215,8 +2162,8 @@ system and gives an overview of their function and contents. | |||
2215 | 2162 | ||
2216 | - "debug-tweaks" - Makes an image suitable for debugging. For example, allows root logins without passwords and | 2163 | - "debug-tweaks" - Makes an image suitable for debugging. For example, allows root logins without passwords and |
2217 | enables post-installation logging. See the 'allow-empty-password' and | 2164 | enables post-installation logging. See the 'allow-empty-password' and |
2218 | 'post-install-logging' features in the "`Image | 2165 | 'post-install-logging' features in the ":ref:`ref-features-image`" |
2219 | Features <#ref-features-image>`__" section for more information. | 2166 | section for more information. |
2220 | - "dev-pkgs" - Adds -dev packages for all installed packages. This is | 2167 | - "dev-pkgs" - Adds -dev packages for all installed packages. This is |
2221 | useful if you want to develop against the libraries in the image. | 2168 | useful if you want to develop against the libraries in the image. |
2222 | - "read-only-rootfs" - Creates an image whose root filesystem is | 2169 | - "read-only-rootfs" - Creates an image whose root filesystem is |
@@ -2231,7 +2178,7 @@ system and gives an overview of their function and contents. | |||
2231 | such as ts_print, aplay, arecord and so forth. | 2178 | such as ts_print, aplay, arecord and so forth. |
2232 | 2179 | ||
2233 | For a complete list of image features that ships with the Yocto | 2180 | For a complete list of image features that ships with the Yocto |
2234 | Project, see the "`Image Features <#ref-features-image>`__" section. | 2181 | Project, see the ":ref:`ref-features-image`" section. |
2235 | 2182 | ||
2236 | For an example that shows how to customize your image by using this | 2183 | For an example that shows how to customize your image by using this |
2237 | variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" | 2184 | variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" |
@@ -2258,8 +2205,7 @@ system and gives an overview of their function and contents. | |||
2258 | .. note:: | 2205 | .. note:: |
2259 | 2206 | ||
2260 | To add packages to the root filesystem, see the various | 2207 | To add packages to the root filesystem, see the various |
2261 | \*RDEPENDS and \*RRECOMMENDS | 2208 | \*:term:`RDEPENDS` and \*:term:`RRECOMMENDS` variables. |
2262 | variables. | ||
2263 | 2209 | ||
2264 | :term:`EXTRANATIVEPATH` | 2210 | :term:`EXTRANATIVEPATH` |
2265 | A list of subdirectories of | 2211 | A list of subdirectories of |
@@ -2332,13 +2278,10 @@ system and gives an overview of their function and contents. | |||
2332 | 2278 | ||
2333 | .. note:: | 2279 | .. note:: |
2334 | 2280 | ||
2335 | Packages installed by features defined through | 2281 | Packages installed by features defined through ``FEATURE_PACKAGES`` |
2336 | FEATURE_PACKAGES | ||
2337 | are often package groups. While similarly named, you should not | 2282 | are often package groups. While similarly named, you should not |
2338 | confuse the | 2283 | confuse the ``FEATURE_PACKAGES`` variable with package groups, which |
2339 | FEATURE_PACKAGES | 2284 | are discussed elsewhere in the documentation. |
2340 | variable with package groups, which are discussed elsewhere in the | ||
2341 | documentation. | ||
2342 | 2285 | ||
2343 | :term:`FEED_DEPLOYDIR_BASE_URI` | 2286 | :term:`FEED_DEPLOYDIR_BASE_URI` |
2344 | Points to the base URL of the server and location within the | 2287 | Points to the base URL of the server and location within the |
@@ -2471,9 +2414,7 @@ system and gives an overview of their function and contents. | |||
2471 | .. note:: | 2414 | .. note:: |
2472 | 2415 | ||
2473 | For a layer that supports a single BSP, the override could just be | 2416 | For a layer that supports a single BSP, the override could just be |
2474 | the value of | 2417 | the value of ``MACHINE``. |
2475 | MACHINE | ||
2476 | . | ||
2477 | 2418 | ||
2478 | By prepending paths in ``.bbappend`` files, you allow multiple append | 2419 | By prepending paths in ``.bbappend`` files, you allow multiple append |
2479 | files that reside in different layers but are used for the same | 2420 | files that reside in different layers but are used for the same |
@@ -2498,10 +2439,9 @@ system and gives an overview of their function and contents. | |||
2498 | 2439 | ||
2499 | .. note:: | 2440 | .. note:: |
2500 | 2441 | ||
2501 | Do not hand-edit the | 2442 | Do not hand-edit the ``FILESOVERRIDES`` variable. The values match up |
2502 | FILESOVERRIDES | 2443 | with expected overrides and are used in an expected manner by the |
2503 | variable. The values match up with expected overrides and are used | 2444 | build system. |
2504 | in an expected manner by the build system. | ||
2505 | 2445 | ||
2506 | :term:`FILESPATH` | 2446 | :term:`FILESPATH` |
2507 | The default set of directories the OpenEmbedded build system uses | 2447 | The default set of directories the OpenEmbedded build system uses |
@@ -2651,11 +2591,8 @@ system and gives an overview of their function and contents. | |||
2651 | 2591 | ||
2652 | .. note:: | 2592 | .. note:: |
2653 | 2593 | ||
2654 | If you specifically remove the locale | 2594 | If you specifically remove the locale ``en_US.UTF-8``, you must set |
2655 | en_US.UTF-8 | 2595 | :term:`IMAGE_LINGUAS` appropriately. |
2656 | , you must set | ||
2657 | IMAGE_LINGUAS | ||
2658 | appropriately. | ||
2659 | 2596 | ||
2660 | You can set ``GLIBC_GENERATE_LOCALES`` in your ``local.conf`` file. | 2597 | You can set ``GLIBC_GENERATE_LOCALES`` in your ``local.conf`` file. |
2661 | By default, all locales are generated. | 2598 | By default, all locales are generated. |
@@ -2748,7 +2685,7 @@ system and gives an overview of their function and contents. | |||
2748 | - :term:`TARGET_CC_ARCH` when building for the | 2685 | - :term:`TARGET_CC_ARCH` when building for the |
2749 | target | 2686 | target |
2750 | 2687 | ||
2751 | - ``BUILD_CC_ARCH`` when building for the build host (i.e. | 2688 | - :term:`BUILD_CC_ARCH` when building for the build host (i.e. |
2752 | ``-native``) | 2689 | ``-native``) |
2753 | 2690 | ||
2754 | - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e. | 2691 | - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e. |
@@ -2847,9 +2784,7 @@ system and gives an overview of their function and contents. | |||
2847 | .. note:: | 2784 | .. note:: |
2848 | 2785 | ||
2849 | The options passed affect builds on all enabled machines on the | 2786 | The options passed affect builds on all enabled machines on the |
2850 | network, which are machines running the | 2787 | network, which are machines running the ``iceccd`` daemon. |
2851 | iceccd | ||
2852 | daemon. | ||
2853 | 2788 | ||
2854 | If your enabled machines support multiple cores, coming up with the | 2789 | If your enabled machines support multiple cores, coming up with the |
2855 | maximum number of parallel threads that gives you the best | 2790 | maximum number of parallel threads that gives you the best |
@@ -2987,11 +2922,10 @@ system and gives an overview of their function and contents. | |||
2987 | .. note:: | 2922 | .. note:: |
2988 | 2923 | ||
2989 | To enable extra features from outside the image recipe, use the | 2924 | To enable extra features from outside the image recipe, use the |
2990 | EXTRA_IMAGE_FEATURES | 2925 | :term:`EXTRA_IMAGE_FEATURES` variable. |
2991 | variable. | ||
2992 | 2926 | ||
2993 | For a list of image features that ships with the Yocto Project, see | 2927 | For a list of image features that ships with the Yocto Project, see |
2994 | the "`Image Features <#ref-features-image>`__" section. | 2928 | the ":ref:`ref-features-image`" section. |
2995 | 2929 | ||
2996 | For an example that shows how to customize your image by using this | 2930 | For an example that shows how to customize your image by using this |
2997 | variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" | 2931 | variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" |
@@ -3045,7 +2979,7 @@ system and gives an overview of their function and contents. | |||
3045 | .. note:: | 2979 | .. note:: |
3046 | 2980 | ||
3047 | - When working with a | 2981 | - When working with a |
3048 | ```core-image-minimal-initramfs`` <#images-core-image-minimal-initramfs>`__ | 2982 | :ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>` |
3049 | image, do not use the ``IMAGE_INSTALL`` variable to specify | 2983 | image, do not use the ``IMAGE_INSTALL`` variable to specify |
3050 | packages for installation. Instead, use the | 2984 | packages for installation. Instead, use the |
3051 | :term:`PACKAGE_INSTALL` variable, which | 2985 | :term:`PACKAGE_INSTALL` variable, which |
@@ -3160,10 +3094,8 @@ system and gives an overview of their function and contents. | |||
3160 | 3094 | ||
3161 | .. note:: | 3095 | .. note:: |
3162 | 3096 | ||
3163 | The | 3097 | The ``package_tar`` class is broken and is not supported. It is |
3164 | package_tar | 3098 | recommended that you do not use it. |
3165 | class is broken and is not supported. It is recommended that you | ||
3166 | do not use it. | ||
3167 | 3099 | ||
3168 | The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` and | 3100 | The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` and |
3169 | :ref:`image <ref-classes-image>` classes use the ``IMAGE_PKGTYPE`` | 3101 | :ref:`image <ref-classes-image>` classes use the ``IMAGE_PKGTYPE`` |
@@ -3178,10 +3110,9 @@ system and gives an overview of their function and contents. | |||
3178 | 3110 | ||
3179 | .. note:: | 3111 | .. note:: |
3180 | 3112 | ||
3181 | Files using the | 3113 | Files using the ``.tar`` format are never used as a substitute |
3182 | .tar | 3114 | packaging format for DEB, RPM, and IPK formatted files for your image |
3183 | format are never used as a substitute packaging format for DEB, | 3115 | or SDK. |
3184 | RPM, and IPK formatted files for your image or SDK. | ||
3185 | 3116 | ||
3186 | :term:`IMAGE_POSTPROCESS_COMMAND` | 3117 | :term:`IMAGE_POSTPROCESS_COMMAND` |
3187 | Specifies a list of functions to call once the OpenEmbedded build | 3118 | Specifies a list of functions to call once the OpenEmbedded build |
@@ -3388,23 +3319,17 @@ system and gives an overview of their function and contents. | |||
3388 | 3319 | ||
3389 | It is possible to define a list of licenses that are allowed to be | 3320 | It is possible to define a list of licenses that are allowed to be |
3390 | used instead of the licenses that are excluded. To do this, define | 3321 | used instead of the licenses that are excluded. To do this, define |
3391 | a variable | 3322 | a variable ``COMPATIBLE_LICENSES`` with the names of the licences |
3392 | COMPATIBLE_LICENSES | 3323 | that are allowed. Then define ``INCOMPATIBLE_LICENSE`` as: |
3393 | with the names of the licences that are allowed. Then define | ||
3394 | INCOMPATIBLE_LICENSE | ||
3395 | as: | ||
3396 | :: | 3324 | :: |
3397 | 3325 | ||
3398 | INCOMPATIBLE_LICENSE = "${@' '.join(sorted(set(d.getVar('AVAILABLE_LICENSES').split()) - set(d.getVar('COMPATIBLE_LICENSES').split())))}" | 3326 | INCOMPATIBLE_LICENSE = "${@' '.join(sorted(set(d.getVar('AVAILABLE_LICENSES').split()) - set(d.getVar('COMPATIBLE_LICENSES').split())))}" |
3399 | 3327 | ||
3400 | 3328 | ||
3401 | This will result in | 3329 | This will result in ``INCOMPATIBLE_LICENSE`` containing the names of |
3402 | INCOMPATIBLE_LICENSE | 3330 | all licences from :term:`AVAILABLE_LICENSES` except the ones specified |
3403 | containing the names of all licences from | 3331 | in ``COMPATIBLE_LICENSES`` , thus only allowing the latter licences to |
3404 | AVAILABLE_LICENSES | 3332 | be used. |
3405 | except the ones specified in | ||
3406 | COMPATIBLE_LICENSES | ||
3407 | , thus only allowing the latter licences to be used. | ||
3408 | 3333 | ||
3409 | :term:`INHERIT` | 3334 | :term:`INHERIT` |
3410 | Causes the named class or classes to be inherited globally. Anonymous | 3335 | Causes the named class or classes to be inherited globally. Anonymous |
@@ -3477,13 +3402,11 @@ system and gives an overview of their function and contents. | |||
3477 | 3402 | ||
3478 | .. note:: | 3403 | .. note:: |
3479 | 3404 | ||
3480 | Use of the | 3405 | Use of the ``INHIBIT_SYSROOT_STRIP`` variable occurs in rare and |
3481 | INHIBIT_SYSROOT_STRIP | 3406 | special circumstances. For example, suppose you are building |
3482 | variable occurs in rare and special circumstances. For example, | 3407 | bare-metal firmware by using an external GCC toolchain. Furthermore, |
3483 | suppose you are building bare-metal firmware by using an external | 3408 | even if the toolchain's binaries are strippable, other files exist |
3484 | GCC toolchain. Furthermore, even if the toolchain's binaries are | 3409 | that are needed for the build that are not strippable. |
3485 | strippable, other files exist that are needed for the build that | ||
3486 | are not strippable. | ||
3487 | 3410 | ||
3488 | :term:`INITRAMFS_FSTYPES` | 3411 | :term:`INITRAMFS_FSTYPES` |
3489 | Defines the format for the output image of an initial RAM filesystem | 3412 | Defines the format for the output image of an initial RAM filesystem |
@@ -3514,13 +3437,10 @@ system and gives an overview of their function and contents. | |||
3514 | 3437 | ||
3515 | .. note:: | 3438 | .. note:: |
3516 | 3439 | ||
3517 | See the | 3440 | See the ``meta/recipes-core/images/core-image-minimal-initramfs.bb`` |
3518 | meta/recipes-core/images/core-image-minimal-initramfs.bb | 3441 | recipe in the :term:`Source Directory` |
3519 | recipe in the | ||
3520 | Source Directory | ||
3521 | for an example initramfs recipe. To select this sample recipe as | 3442 | for an example initramfs recipe. To select this sample recipe as |
3522 | the one built to provide the initramfs image, set | 3443 | the one built to provide the initramfs image, set ``INITRAMFS_IMAGE`` |
3523 | INITRAMFS_IMAGE | ||
3524 | to "core-image-minimal-initramfs". | 3444 | to "core-image-minimal-initramfs". |
3525 | 3445 | ||
3526 | You can also find more information by referencing the | 3446 | You can also find more information by referencing the |
@@ -3578,10 +3498,8 @@ system and gives an overview of their function and contents. | |||
3578 | 3498 | ||
3579 | .. note:: | 3499 | .. note:: |
3580 | 3500 | ||
3581 | You must set the | 3501 | You must set the ``INITRAMFS_IMAGE_BUNDLE`` variable in a |
3582 | INITRAMFS_IMAGE_BUNDLE | 3502 | configuration file. You cannot set the variable in a recipe file. |
3583 | variable in a configuration file. You cannot set the variable in a | ||
3584 | recipe file. | ||
3585 | 3503 | ||
3586 | See the | 3504 | See the |
3587 | :yocto_git:`local.conf.sample.extended </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>` | 3505 | :yocto_git:`local.conf.sample.extended </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>` |
@@ -3802,7 +3720,7 @@ system and gives an overview of their function and contents. | |||
3802 | 3720 | ||
3803 | .. note:: | 3721 | .. note:: |
3804 | 3722 | ||
3805 | The IMAGE_VERSION_SUFFIX variable is set to DATETIME. | 3723 | The ``IMAGE_VERSION_SUFFIX`` variable is set to :term:`DATETIME`. |
3806 | 3724 | ||
3807 | :term:`KERNEL_CLASSES` | 3725 | :term:`KERNEL_CLASSES` |
3808 | A list of classes defining kernel image types that the | 3726 | A list of classes defining kernel image types that the |
@@ -3820,7 +3738,7 @@ system and gives an overview of their function and contents. | |||
3820 | .. note:: | 3738 | .. note:: |
3821 | 3739 | ||
3822 | Legacy support exists for specifying the full path to the device | 3740 | Legacy support exists for specifying the full path to the device |
3823 | tree. However, providing just the .dtb file is preferred. | 3741 | tree. However, providing just the ``.dtb`` file is preferred. |
3824 | 3742 | ||
3825 | In order to use this variable, the | 3743 | In order to use this variable, the |
3826 | :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must | 3744 | :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must |
@@ -3979,8 +3897,7 @@ system and gives an overview of their function and contents. | |||
3979 | 3897 | ||
3980 | .. note:: | 3898 | .. note:: |
3981 | 3899 | ||
3982 | This variable replaces the deprecated | 3900 | This variable replaces the deprecated :term:`module_autoload` |
3983 | module_autoload | ||
3984 | variable. | 3901 | variable. |
3985 | 3902 | ||
3986 | You can use the ``KERNEL_MODULE_AUTOLOAD`` variable anywhere that it | 3903 | You can use the ``KERNEL_MODULE_AUTOLOAD`` variable anywhere that it |
@@ -4175,9 +4092,8 @@ system and gives an overview of their function and contents. | |||
4175 | 4092 | ||
4176 | .. note:: | 4093 | .. note:: |
4177 | 4094 | ||
4178 | Setting | 4095 | Setting ``LAYERSERIES_COMPAT`` is required by the Yocto Project |
4179 | LAYERSERIES_COMPAT | 4096 | Compatible version 2 standard. |
4180 | is required by the Yocto Project Compatible version 2 standard. | ||
4181 | The OpenEmbedded build system produces a warning if the variable | 4097 | The OpenEmbedded build system produces a warning if the variable |
4182 | is not set for any given layer. | 4098 | is not set for any given layer. |
4183 | 4099 | ||
@@ -4425,9 +4341,7 @@ system and gives an overview of their function and contents. | |||
4425 | .. note:: | 4341 | .. note:: |
4426 | 4342 | ||
4427 | Adding additional Board Support Package (BSP) layers to your | 4343 | Adding additional Board Support Package (BSP) layers to your |
4428 | configuration adds new possible settings for | 4344 | configuration adds new possible settings for ``MACHINE``. |
4429 | MACHINE | ||
4430 | . | ||
4431 | 4345 | ||
4432 | :term:`MACHINE_ARCH` | 4346 | :term:`MACHINE_ARCH` |
4433 | Specifies the name of the machine-specific architecture. This | 4347 | Specifies the name of the machine-specific architecture. This |
@@ -4492,13 +4406,10 @@ system and gives an overview of their function and contents. | |||
4492 | 4406 | ||
4493 | .. note:: | 4407 | .. note:: |
4494 | 4408 | ||
4495 | In this example, the | 4409 | In this example, the ``kernel-module-ab123`` recipe needs to |
4496 | kernel-module-ab123 | 4410 | explicitly set its :term:`PACKAGES` variable to ensure that BitBake |
4497 | recipe needs to explicitly set its | 4411 | does not use the kernel recipe's :term:`PACKAGES_DYNAMIC` variable to |
4498 | PACKAGES | 4412 | satisfy the dependency. |
4499 | variable to ensure that BitBake does not use the kernel recipe's | ||
4500 | PACKAGES_DYNAMIC | ||
4501 | variable to satisfy the dependency. | ||
4502 | 4413 | ||
4503 | Some examples of these machine essentials are flash, screen, | 4414 | Some examples of these machine essentials are flash, screen, |
4504 | keyboard, mouse, or touchscreen drivers (depending on the machine). | 4415 | keyboard, mouse, or touchscreen drivers (depending on the machine). |
@@ -4566,8 +4477,7 @@ system and gives an overview of their function and contents. | |||
4566 | :term:`IMAGE_FEATURES` variables. | 4477 | :term:`IMAGE_FEATURES` variables. |
4567 | 4478 | ||
4568 | For a list of hardware features supported by the Yocto Project as | 4479 | For a list of hardware features supported by the Yocto Project as |
4569 | shipped, see the "`Machine Features <#ref-features-machine>`__" | 4480 | shipped, see the ":ref:`ref-features-machine`" section. |
4570 | section. | ||
4571 | 4481 | ||
4572 | :term:`MACHINE_FEATURES_BACKFILL` | 4482 | :term:`MACHINE_FEATURES_BACKFILL` |
4573 | Features to be added to ``MACHINE_FEATURES`` if not also present in | 4483 | Features to be added to ``MACHINE_FEATURES`` if not also present in |
@@ -4576,15 +4486,13 @@ system and gives an overview of their function and contents. | |||
4576 | This variable is set in the ``meta/conf/bitbake.conf`` file. It is | 4486 | This variable is set in the ``meta/conf/bitbake.conf`` file. It is |
4577 | not intended to be user-configurable. It is best to just reference | 4487 | not intended to be user-configurable. It is best to just reference |
4578 | the variable to see which machine features are being backfilled for | 4488 | the variable to see which machine features are being backfilled for |
4579 | all machine configurations. See the "`Feature | 4489 | all machine configurations. See the ":ref:`ref-features-backfill`" |
4580 | Backfilling <#ref-features-backfill>`__" section for more | 4490 | section for more information. |
4581 | information. | ||
4582 | 4491 | ||
4583 | :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` | 4492 | :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` |
4584 | Features from ``MACHINE_FEATURES_BACKFILL`` that should not be | 4493 | Features from ``MACHINE_FEATURES_BACKFILL`` that should not be |
4585 | backfilled (i.e. added to ``MACHINE_FEATURES``) during the build. See | 4494 | backfilled (i.e. added to ``MACHINE_FEATURES``) during the build. See |
4586 | the "`Feature Backfilling <#ref-features-backfill>`__" section for | 4495 | the ":ref:`ref-features-backfill`" section for more information. |
4587 | more information. | ||
4588 | 4496 | ||
4589 | :term:`MACHINEOVERRIDES` | 4497 | :term:`MACHINEOVERRIDES` |
4590 | A colon-separated list of overrides that apply to the current | 4498 | A colon-separated list of overrides that apply to the current |
@@ -4638,16 +4546,10 @@ system and gives an overview of their function and contents. | |||
4638 | 4546 | ||
4639 | .. note:: | 4547 | .. note:: |
4640 | 4548 | ||
4641 | The "ML" in | 4549 | The "ML" in ``MLPREFIX`` stands for "MultiLib". This representation is |
4642 | MLPREFIX | 4550 | historical and comes from a time when ``nativesdk`` was a suffix |
4643 | stands for "MultiLib". This representation is historical and comes | 4551 | rather than a prefix on the recipe name. When ``nativesdk`` was turned |
4644 | from a time when | 4552 | into a prefix, it made sense to set ``MLPREFIX`` for it as well. |
4645 | nativesdk | ||
4646 | was a suffix rather than a prefix on the recipe name. When | ||
4647 | nativesdk | ||
4648 | was turned into a prefix, it made sense to set | ||
4649 | MLPREFIX | ||
4650 | for it as well. | ||
4651 | 4553 | ||
4652 | To help understand when ``MLPREFIX`` might be needed, consider when | 4554 | To help understand when ``MLPREFIX`` might be needed, consider when |
4653 | :term:`BBCLASSEXTEND` is used to provide a | 4555 | :term:`BBCLASSEXTEND` is used to provide a |
@@ -4832,7 +4734,7 @@ system and gives an overview of their function and contents. | |||
4832 | 4734 | ||
4833 | Some recommended packages might be required for certain system | 4735 | Some recommended packages might be required for certain system |
4834 | functionality, such as kernel modules. It is up to you to add | 4736 | functionality, such as kernel modules. It is up to you to add |
4835 | packages with the IMAGE_INSTALL variable. | 4737 | packages with the :term:`IMAGE_INSTALL` variable. |
4836 | 4738 | ||
4837 | Support for this variable exists only when using the IPK and RPM | 4739 | Support for this variable exists only when using the IPK and RPM |
4838 | packaging backend. Support does not exist for DEB. | 4740 | packaging backend. Support does not exist for DEB. |
@@ -4910,7 +4812,7 @@ system and gives an overview of their function and contents. | |||
4910 | :term:`OEROOT` | 4812 | :term:`OEROOT` |
4911 | The directory from which the top-level build environment setup script | 4813 | The directory from which the top-level build environment setup script |
4912 | is sourced. The Yocto Project provides a top-level build environment | 4814 | is sourced. The Yocto Project provides a top-level build environment |
4913 | setup script: ````` <#structure-core-script>`__. When you run this | 4815 | setup script: :ref:`structure-core-script`. When you run this |
4914 | script, the ``OEROOT`` variable resolves to the directory that | 4816 | script, the ``OEROOT`` variable resolves to the directory that |
4915 | contains the script. | 4817 | contains the script. |
4916 | 4818 | ||
@@ -4961,14 +4863,10 @@ system and gives an overview of their function and contents. | |||
4961 | 4863 | ||
4962 | .. note:: | 4864 | .. note:: |
4963 | 4865 | ||
4964 | An easy way to see what overrides apply is to search for | 4866 | An easy way to see what overrides apply is to search for ``OVERRIDES`` |
4965 | OVERRIDES | 4867 | in the output of the ``bitbake -e`` command. See the |
4966 | in the output of the | 4868 | ":ref:`dev-debugging-viewing-variable-values`" section in the Yocto |
4967 | bitbake -e | 4869 | Project Development Tasks Manual for more information. |
4968 | command. See the " | ||
4969 | Viewing Variable Values | ||
4970 | " section in the Yocto Project Development Tasks Manual for more | ||
4971 | information. | ||
4972 | 4870 | ||
4973 | :term:`P` | 4871 | :term:`P` |
4974 | The recipe name and version. ``P`` is comprised of the following: | 4872 | The recipe name and version. ``P`` is comprised of the following: |
@@ -5003,9 +4901,7 @@ system and gives an overview of their function and contents. | |||
5003 | 4901 | ||
5004 | .. note:: | 4902 | .. note:: |
5005 | 4903 | ||
5006 | See | 4904 | See :term:`SDK_ARCH` for more information. |
5007 | SDK_ARCH | ||
5008 | for more information. | ||
5009 | 4905 | ||
5010 | However, if your recipe's output packages are built specific to the | 4906 | However, if your recipe's output packages are built specific to the |
5011 | target machine rather than generally for the architecture of the | 4907 | target machine rather than generally for the architecture of the |
@@ -5039,8 +4935,7 @@ system and gives an overview of their function and contents. | |||
5039 | 4935 | ||
5040 | .. note:: | 4936 | .. note:: |
5041 | 4937 | ||
5042 | While it is a legal option, the | 4938 | While it is a legal option, the ``package_tar`` |
5043 | package_tar | ||
5044 | class has limited functionality due to no support for package | 4939 | class has limited functionality due to no support for package |
5045 | dependencies by that backend. Therefore, it is recommended that | 4940 | dependencies by that backend. Therefore, it is recommended that |
5046 | you do not use it. | 4941 | you do not use it. |
@@ -5150,8 +5045,7 @@ system and gives an overview of their function and contents. | |||
5150 | 5045 | ||
5151 | .. note:: | 5046 | .. note:: |
5152 | 5047 | ||
5153 | You can use the | 5048 | You can use the ``PACKAGE_FEEDS_ARCHS`` |
5154 | PACKAGE_FEEDS_ARCHS | ||
5155 | variable to whitelist specific package architectures. If you do | 5049 | variable to whitelist specific package architectures. If you do |
5156 | not need to whitelist specific architectures, which is a common | 5050 | not need to whitelist specific architectures, which is a common |
5157 | case, you can omit this variable. Omitting the variable results in | 5051 | case, you can omit this variable. Omitting the variable results in |
@@ -5169,7 +5063,8 @@ system and gives an overview of their function and contents. | |||
5169 | PACKAGE_FEED_ARCHS = "all core2-64" | 5063 | PACKAGE_FEED_ARCHS = "all core2-64" |
5170 | 5064 | ||
5171 | Given these settings, the resulting package feeds are as follows: | 5065 | Given these settings, the resulting package feeds are as follows: |
5172 | :: | 5066 | |
5067 | .. code-block:: none | ||
5173 | 5068 | ||
5174 | https://example.com/packagerepos/release/rpm/all | 5069 | https://example.com/packagerepos/release/rpm/all |
5175 | https://example.com/packagerepos/release/rpm/core2-64 | 5070 | https://example.com/packagerepos/release/rpm/core2-64 |
@@ -5198,7 +5093,8 @@ system and gives an overview of their function and contents. | |||
5198 | PACKAGE_FEED_ARCHS = "all core2-64" | 5093 | PACKAGE_FEED_ARCHS = "all core2-64" |
5199 | 5094 | ||
5200 | Given these settings, the resulting package feeds are as follows: | 5095 | Given these settings, the resulting package feeds are as follows: |
5201 | :: | 5096 | |
5097 | .. code-block:: none | ||
5202 | 5098 | ||
5203 | https://example.com/packagerepos/release/rpm/all | 5099 | https://example.com/packagerepos/release/rpm/all |
5204 | https://example.com/packagerepos/release/rpm/core2-64 | 5100 | https://example.com/packagerepos/release/rpm/core2-64 |
@@ -5227,7 +5123,8 @@ system and gives an overview of their function and contents. | |||
5227 | PACKAGE_FEED_ARCHS = "all core2-64" | 5123 | PACKAGE_FEED_ARCHS = "all core2-64" |
5228 | 5124 | ||
5229 | Given these settings, the resulting package feeds are as follows: | 5125 | Given these settings, the resulting package feeds are as follows: |
5230 | :: | 5126 | |
5127 | .. code-block:: none | ||
5231 | 5128 | ||
5232 | https://example.com/packagerepos/release/rpm/all | 5129 | https://example.com/packagerepos/release/rpm/all |
5233 | https://example.com/packagerepos/release/rpm/core2-64 | 5130 | https://example.com/packagerepos/release/rpm/core2-64 |
@@ -5249,8 +5146,7 @@ system and gives an overview of their function and contents. | |||
5249 | general, you should use the | 5146 | general, you should use the |
5250 | :term:`IMAGE_INSTALL` variable to specify | 5147 | :term:`IMAGE_INSTALL` variable to specify |
5251 | packages for installation. The exception to this is when working with | 5148 | packages for installation. The exception to this is when working with |
5252 | the | 5149 | the :ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>` |
5253 | ```core-image-minimal-initramfs`` <#images-core-image-minimal-initramfs>`__ | ||
5254 | image. When working with an initial RAM filesystem (initramfs) image, | 5150 | image. When working with an initial RAM filesystem (initramfs) image, |
5255 | use the ``PACKAGE_INSTALL`` variable. For information on creating an | 5151 | use the ``PACKAGE_INSTALL`` variable. For information on creating an |
5256 | initramfs, see the ":ref:`building-an-initramfs-image`" section | 5152 | initramfs, see the ":ref:`building-an-initramfs-image`" section |
@@ -5365,8 +5261,11 @@ system and gives an overview of their function and contents. | |||
5365 | block through an append file except you edit your ``local.conf`` | 5261 | block through an append file except you edit your ``local.conf`` |
5366 | or ``mydistro.conf`` file. As with append files previously | 5262 | or ``mydistro.conf`` file. As with append files previously |
5367 | described, you can either completely override the variable: | 5263 | described, you can either completely override the variable: |
5368 | PACKAGECONFIG_pn-recipename = "f4 f5" Or, you can just amend the | 5264 | :: |
5369 | variable: | 5265 | |
5266 | PACKAGECONFIG_pn-recipename = "f4 f5" | ||
5267 | |||
5268 | Or, you can just amend the variable: | ||
5370 | :: | 5269 | :: |
5371 | 5270 | ||
5372 | PACKAGECONFIG_append_pn-recipename = " f4" | 5271 | PACKAGECONFIG_append_pn-recipename = " f4" |
@@ -5452,17 +5351,9 @@ system and gives an overview of their function and contents. | |||
5452 | 5351 | ||
5453 | .. note:: | 5352 | .. note:: |
5454 | 5353 | ||
5455 | In order for | 5354 | In order for ``PARALLEL_MAKE`` to be effective, ``make`` must be |
5456 | PARALLEL_MAKE | 5355 | called with ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy way to ensure |
5457 | to be effective, | 5356 | this is to use the ``oe_runmake`` function. |
5458 | make | ||
5459 | must be called with | ||
5460 | ${ | ||
5461 | EXTRA_OEMAKE | ||
5462 | } | ||
5463 | . An easy way to ensure this is to use the | ||
5464 | oe_runmake | ||
5465 | function. | ||
5466 | 5357 | ||
5467 | By default, the OpenEmbedded build system automatically sets this | 5358 | By default, the OpenEmbedded build system automatically sets this |
5468 | variable to be equal to the number of cores the build system uses. | 5359 | variable to be equal to the number of cores the build system uses. |
@@ -5470,14 +5361,11 @@ system and gives an overview of their function and contents. | |||
5470 | .. note:: | 5361 | .. note:: |
5471 | 5362 | ||
5472 | If the software being built experiences dependency issues during | 5363 | If the software being built experiences dependency issues during |
5473 | the | 5364 | the ``do_compile`` task that result in race conditions, you can clear |
5474 | do_compile | 5365 | the ``PARALLEL_MAKE`` variable within the recipe as a workaround. For |
5475 | task that result in race conditions, you can clear the | 5366 | information on addressing race conditions, see the |
5476 | PARALLEL_MAKE | 5367 | ":ref:`dev-manual/dev-manual-common-tasks:debugging parallel make races`" |
5477 | variable within the recipe as a workaround. For information on | 5368 | section in the Yocto Project Development Tasks Manual. |
5478 | addressing race conditions, see the " | ||
5479 | Debugging Parallel Make Races | ||
5480 | " section in the Yocto Project Development Tasks Manual. | ||
5481 | 5369 | ||
5482 | For single socket systems (i.e. one CPU), you should not have to | 5370 | For single socket systems (i.e. one CPU), you should not have to |
5483 | override this variable to gain optimal parallelism during builds. | 5371 | override this variable to gain optimal parallelism during builds. |
@@ -5564,9 +5452,7 @@ system and gives an overview of their function and contents. | |||
5564 | 5452 | ||
5565 | .. note:: | 5453 | .. note:: |
5566 | 5454 | ||
5567 | When using the | 5455 | When using the ``PKG`` variable, you must use a package name override. |
5568 | PKG | ||
5569 | variable, you must use a package name override. | ||
5570 | 5456 | ||
5571 | For example, when the :ref:`debian <ref-classes-debian>` class | 5457 | For example, when the :ref:`debian <ref-classes-debian>` class |
5572 | renames the output package, it does so by setting | 5458 | renames the output package, it does so by setting |
@@ -5709,14 +5595,11 @@ system and gives an overview of their function and contents. | |||
5709 | 5595 | ||
5710 | .. note:: | 5596 | .. note:: |
5711 | 5597 | ||
5712 | The OpenEmbedded build system does not need the aid of | 5598 | The OpenEmbedded build system does not need the aid of ``PR`` |
5713 | PR | ||
5714 | to know when to rebuild a recipe. The build system uses the task | 5599 | to know when to rebuild a recipe. The build system uses the task |
5715 | input checksums | 5600 | :ref:`input checksums <overview-checksums>` along with the |
5716 | along with the | 5601 | :ref:`stamp <structure-build-tmp-stamps>` and |
5717 | stamp | 5602 | :ref:`overview-manual/overview-manual-concepts:shared state cache` |
5718 | and | ||
5719 | shared state cache | ||
5720 | mechanisms. | 5603 | mechanisms. |
5721 | 5604 | ||
5722 | The ``PR`` variable primarily becomes significant when a package | 5605 | The ``PR`` variable primarily becomes significant when a package |
@@ -5731,8 +5614,7 @@ system and gives an overview of their function and contents. | |||
5731 | 5614 | ||
5732 | .. note:: | 5615 | .. note:: |
5733 | 5616 | ||
5734 | PR | 5617 | ``PR`` does not need to be increased for changes that do not change the |
5735 | does not need to be increased for changes that do not change the | ||
5736 | package contents or metadata. | 5618 | package contents or metadata. |
5737 | 5619 | ||
5738 | Because manually managing ``PR`` can be cumbersome and error-prone, | 5620 | Because manually managing ``PR`` can be cumbersome and error-prone, |
@@ -5767,17 +5649,11 @@ system and gives an overview of their function and contents. | |||
5767 | 5649 | ||
5768 | .. note:: | 5650 | .. note:: |
5769 | 5651 | ||
5770 | If you use a | 5652 | If you use a ``virtual/\*`` item with ``PREFERRED_PROVIDER``, then any |
5771 | virtual/\* | 5653 | recipe that :term:`PROVIDES` that item but is not selected (defined) |
5772 | item with | 5654 | by ``PREFERRED_PROVIDER`` is prevented from building, which is usually |
5773 | PREFERRED_PROVIDER | 5655 | desirable since this mechanism is designed to select between mutually |
5774 | , then any recipe that | 5656 | exclusive alternative providers. |
5775 | PROVIDES | ||
5776 | that item but is not selected (defined) by | ||
5777 | PREFERRED_PROVIDER | ||
5778 | is prevented from building, which is usually desirable since this | ||
5779 | mechanism is designed to select between mutually exclusive | ||
5780 | alternative providers. | ||
5781 | 5657 | ||
5782 | :term:`PREFERRED_VERSION` | 5658 | :term:`PREFERRED_VERSION` |
5783 | If multiple versions of recipes exist, this variable determines which | 5659 | If multiple versions of recipes exist, this variable determines which |
@@ -5838,8 +5714,8 @@ system and gives an overview of their function and contents. | |||
5838 | 5714 | ||
5839 | .. note:: | 5715 | .. note:: |
5840 | 5716 | ||
5841 | The \_forcevariable override is not handled specially. This override | 5717 | The ``\_forcevariable`` override is not handled specially. This override |
5842 | only works because the default value of OVERRIDES includes "forcevariable". | 5718 | only works because the default value of ``OVERRIDES`` includes "forcevariable". |
5843 | 5719 | ||
5844 | :term:`PREMIRRORS` | 5720 | :term:`PREMIRRORS` |
5845 | Specifies additional paths from which the OpenEmbedded build system | 5721 | Specifies additional paths from which the OpenEmbedded build system |
@@ -5929,9 +5805,7 @@ system and gives an overview of their function and contents. | |||
5929 | .. note:: | 5805 | .. note:: |
5930 | 5806 | ||
5931 | Given that a recipe's own recipe name is already implicitly in its | 5807 | Given that a recipe's own recipe name is already implicitly in its |
5932 | own | 5808 | own PROVIDES list, it is unnecessary to add aliases with the "+=" operator; |
5933 | PROVIDES | ||
5934 | list, it is unnecessary to add aliases with the "+=" operator; | ||
5935 | using a simple assignment will be sufficient. In other words, | 5809 | using a simple assignment will be sufficient. In other words, |
5936 | while you could write: | 5810 | while you could write: |
5937 | :: | 5811 | :: |
@@ -6063,8 +5937,15 @@ system and gives an overview of their function and contents. | |||
6063 | 5937 | ||
6064 | RCONFLICTS_${PN} = "package (operator version)" | 5938 | RCONFLICTS_${PN} = "package (operator version)" |
6065 | 5939 | ||
6066 | For ``operator``, you can specify the following: = < > <= | 5940 | For ``operator``, you can specify the following: |
6067 | >= For example, the following sets up a dependency on version 1.2 or | 5941 | |
5942 | - = | ||
5943 | - < | ||
5944 | - > | ||
5945 | - <= | ||
5946 | - >= | ||
5947 | |||
5948 | For example, the following sets up a dependency on version 1.2 or | ||
6068 | greater of the package ``foo``: | 5949 | greater of the package ``foo``: |
6069 | :: | 5950 | :: |
6070 | 5951 | ||
@@ -6090,7 +5971,7 @@ system and gives an overview of their function and contents. | |||
6090 | The practical effect of the above ``RDEPENDS`` assignment is that | 5971 | The practical effect of the above ``RDEPENDS`` assignment is that |
6091 | ``bar`` and ``baz`` will be declared as dependencies inside the | 5972 | ``bar`` and ``baz`` will be declared as dependencies inside the |
6092 | package ``foo`` when it is written out by one of the | 5973 | package ``foo`` when it is written out by one of the |
6093 | ```do_package_write_*`` <#ref-tasks-package_write_deb>`__ tasks. | 5974 | :ref:`do_package_write_\* <ref-tasks-package_write_deb>` tasks. |
6094 | Exactly how this is done depends on which package format is used, | 5975 | Exactly how this is done depends on which package format is used, |
6095 | which is determined by | 5976 | which is determined by |
6096 | :term:`PACKAGE_CLASSES`. When the | 5977 | :term:`PACKAGE_CLASSES`. When the |
@@ -6129,19 +6010,11 @@ system and gives an overview of their function and contents. | |||
6129 | 6010 | ||
6130 | .. note:: | 6011 | .. note:: |
6131 | 6012 | ||
6132 | RDEPENDS_${PN}-dev | 6013 | ``RDEPENDS_${PN}-dev`` includes ``${``\ :term:`PN`\ ``}`` |
6133 | includes | ||
6134 | ${ | ||
6135 | PN | ||
6136 | } | ||
6137 | by default. This default is set in the BitBake configuration file | 6014 | by default. This default is set in the BitBake configuration file |
6138 | ( | 6015 | (``meta/conf/bitbake.conf``). Be careful not to accidentally remove |
6139 | meta/conf/bitbake.conf | 6016 | ``${PN}`` when modifying ``RDEPENDS_${PN}-dev``. Use the "+=" operator |
6140 | ). Be careful not to accidentally remove | 6017 | rather than the "=" operator. |
6141 | ${PN} | ||
6142 | when modifying | ||
6143 | RDEPENDS_${PN}-dev | ||
6144 | . Use the "+=" operator rather than the "=" operator. | ||
6145 | 6018 | ||
6146 | The package names you use with ``RDEPENDS`` must appear as they would | 6019 | The package names you use with ``RDEPENDS`` must appear as they would |
6147 | in the ``PACKAGES`` variable. The :term:`PKG` variable | 6020 | in the ``PACKAGES`` variable. The :term:`PKG` variable |
@@ -6160,14 +6033,20 @@ system and gives an overview of their function and contents. | |||
6160 | 6033 | ||
6161 | RDEPENDS_${PN} = "package (operator version)" | 6034 | RDEPENDS_${PN} = "package (operator version)" |
6162 | 6035 | ||
6163 | For operator, you can specify the following: = < > <= >= For version, | 6036 | For ``operator``, you can specify the following: |
6164 | provide the version number. | 6037 | |
6038 | - = | ||
6039 | - < | ||
6040 | - > | ||
6041 | - <= | ||
6042 | - >= | ||
6043 | |||
6044 | For version, provide the version number. | ||
6165 | 6045 | ||
6166 | .. note:: | 6046 | .. note:: |
6167 | 6047 | ||
6168 | You can use | 6048 | You can use ``EXTENDPKGV`` to provide a full package version |
6169 | EXTENDPKGV | 6049 | specification. |
6170 | to provide a full package version specification. | ||
6171 | 6050 | ||
6172 | For example, the following sets up a dependency on version 1.2 or | 6051 | For example, the following sets up a dependency on version 1.2 or |
6173 | greater of the package ``foo``: | 6052 | greater of the package ``foo``: |
@@ -6296,9 +6175,7 @@ system and gives an overview of their function and contents. | |||
6296 | 6175 | ||
6297 | .. note:: | 6176 | .. note:: |
6298 | 6177 | ||
6299 | A package's own name is implicitly already in its | 6178 | A package's own name is implicitly already in its ``RPROVIDES`` list. |
6300 | RPROVIDES | ||
6301 | list. | ||
6302 | 6179 | ||
6303 | As with all package-controlling variables, you must always use the | 6180 | As with all package-controlling variables, you must always use the |
6304 | variable in conjunction with a package name override. Here is an | 6181 | variable in conjunction with a package name override. Here is an |
@@ -6487,13 +6364,8 @@ system and gives an overview of their function and contents. | |||
6487 | 6364 | ||
6488 | .. note:: | 6365 | .. note:: |
6489 | 6366 | ||
6490 | The | 6367 | The ``SDK_DIR`` directory is a temporary directory as it is part of |
6491 | SDK_DIR | 6368 | ``WORKDIR``. The final output directory is :term:`SDK_DEPLOY`. |
6492 | directory is a temporary directory as it is part of | ||
6493 | WORKDIR | ||
6494 | . The final output directory is | ||
6495 | SDK_DEPLOY | ||
6496 | . | ||
6497 | 6369 | ||
6498 | :term:`SDK_EXT_TYPE` | 6370 | :term:`SDK_EXT_TYPE` |
6499 | Controls whether or not shared state artifacts are copied into the | 6371 | Controls whether or not shared state artifacts are copied into the |
@@ -6504,9 +6376,8 @@ system and gives an overview of their function and contents. | |||
6504 | .. note:: | 6376 | .. note:: |
6505 | 6377 | ||
6506 | If you set the variable to "minimal", you need to ensure | 6378 | If you set the variable to "minimal", you need to ensure |
6507 | SSTATE_MIRRORS | 6379 | :term:`SSTATE_MIRRORS` is set in the SDK's configuration to enable the |
6508 | is set in the SDK's configuration to enable the artifacts to be | 6380 | artifacts to be fetched as needed. |
6509 | fetched as needed. | ||
6510 | 6381 | ||
6511 | :term:`SDK_HOST_MANIFEST` | 6382 | :term:`SDK_HOST_MANIFEST` |
6512 | The manifest file for the host part of the SDK. This file lists all | 6383 | The manifest file for the host part of the SDK. This file lists all |
@@ -6535,8 +6406,7 @@ system and gives an overview of their function and contents. | |||
6535 | 6406 | ||
6536 | .. note:: | 6407 | .. note:: |
6537 | 6408 | ||
6538 | Enabling the | 6409 | Enabling the ``SDK_INCLUDE_PKGDATA`` |
6539 | SDK_INCLUDE_PKGDATA | ||
6540 | variable significantly increases build time because all of world | 6410 | variable significantly increases build time because all of world |
6541 | needs to be built. Enabling the variable also slightly increases | 6411 | needs to be built. Enabling the variable also slightly increases |
6542 | the size of the extensible SDK. | 6412 | the size of the extensible SDK. |
@@ -6643,9 +6513,9 @@ system and gives an overview of their function and contents. | |||
6643 | 6513 | ||
6644 | .. note:: | 6514 | .. note:: |
6645 | 6515 | ||
6646 | The SDK_OUTPUT directory is a temporary directory as it is part of | 6516 | The ``SDK_OUTPUT`` directory is a temporary directory as it is part of |
6647 | WORKDIR by way of SDK_DIR. The final output directory is | 6517 | :term:`WORKDIR` by way of :term:`SDK_DIR`. The final output directory is |
6648 | SDK_DEPLOY. | 6518 | :term:`SDK_DEPLOY`. |
6649 | 6519 | ||
6650 | :term:`SDK_PACKAGE_ARCHS` | 6520 | :term:`SDK_PACKAGE_ARCHS` |
6651 | Specifies a list of architectures compatible with the SDK machine. | 6521 | Specifies a list of architectures compatible with the SDK machine. |
@@ -6800,8 +6670,7 @@ system and gives an overview of their function and contents. | |||
6800 | 6670 | ||
6801 | .. note:: | 6671 | .. note:: |
6802 | 6672 | ||
6803 | You cannot set the | 6673 | You cannot set the ``SDKMACHINE`` |
6804 | SDKMACHINE | ||
6805 | variable in your distribution configuration file. If you do, the | 6674 | variable in your distribution configuration file. If you do, the |
6806 | configuration will not take affect. | 6675 | configuration will not take affect. |
6807 | 6676 | ||
@@ -6841,11 +6710,8 @@ system and gives an overview of their function and contents. | |||
6841 | 6710 | ||
6842 | .. note:: | 6711 | .. note:: |
6843 | 6712 | ||
6844 | The | 6713 | The ``SERIAL_CONSOLE`` variable is deprecated. Please use the |
6845 | SERIAL_CONSOLE | 6714 | :term:`SERIAL_CONSOLES` variable. |
6846 | variable is deprecated. Please use the | ||
6847 | SERIAL_CONSOLES | ||
6848 | variable. | ||
6849 | 6715 | ||
6850 | :term:`SERIAL_CONSOLES` | 6716 | :term:`SERIAL_CONSOLES` |
6851 | Defines a serial console (TTY) to enable using | 6717 | Defines a serial console (TTY) to enable using |
@@ -6937,11 +6803,8 @@ system and gives an overview of their function and contents. | |||
6937 | 6803 | ||
6938 | .. note:: | 6804 | .. note:: |
6939 | 6805 | ||
6940 | You must include | 6806 | You must include ``conf/machine/include/soc-family.inc`` for this |
6941 | conf/machine/include/soc-family.inc | 6807 | variable to appear in :term:`MACHINEOVERRIDES`. |
6942 | for this variable to appear in | ||
6943 | MACHINEOVERRIDES | ||
6944 | . | ||
6945 | 6808 | ||
6946 | :term:`SOLIBS` | 6809 | :term:`SOLIBS` |
6947 | Defines the suffix for shared libraries used on the target platform. | 6810 | Defines the suffix for shared libraries used on the target platform. |
@@ -6974,8 +6837,7 @@ system and gives an overview of their function and contents. | |||
6974 | 6837 | ||
6975 | .. note:: | 6838 | .. note:: |
6976 | 6839 | ||
6977 | Do not set the | 6840 | Do not set the ``SOURCE_MIRROR_FETCH`` |
6978 | SOURCE_MIRROR_FETCH | ||
6979 | variable unless you are creating a source mirror. In other words, | 6841 | variable unless you are creating a source mirror. In other words, |
6980 | do not set the variable during a normal build. | 6842 | do not set the variable during a normal build. |
6981 | 6843 | ||
@@ -6994,9 +6856,7 @@ system and gives an overview of their function and contents. | |||
6994 | 6856 | ||
6995 | .. note:: | 6857 | .. note:: |
6996 | 6858 | ||
6997 | You can specify only a single URL in | 6859 | You can specify only a single URL in ``SOURCE_MIRROR_URL``. |
6998 | SOURCE_MIRROR_URL | ||
6999 | . | ||
7000 | 6860 | ||
7001 | :term:`SPDXLICENSEMAP` | 6861 | :term:`SPDXLICENSEMAP` |
7002 | Maps commonly used license names to their SPDX counterparts found in | 6862 | Maps commonly used license names to their SPDX counterparts found in |
@@ -7224,13 +7084,10 @@ system and gives an overview of their function and contents. | |||
7224 | .. note:: | 7084 | .. note:: |
7225 | 7085 | ||
7226 | For information on limitations when inheriting the latest revision | 7086 | For information on limitations when inheriting the latest revision |
7227 | of software using | 7087 | of software using ``SRCREV``, see the :term:`AUTOREV` variable |
7228 | SRCREV | 7088 | description and the |
7229 | , see the | 7089 | ":ref:`automatically-incrementing-a-binary-package-revision-number`" |
7230 | AUTOREV | 7090 | section, which is in the Yocto Project Development Tasks Manual. |
7231 | variable description and the " | ||
7232 | Automatically Incrementing a Binary Package Revision Number | ||
7233 | " section, which is in the Yocto Project Development Tasks Manual. | ||
7234 | 7091 | ||
7235 | :term:`SSTATE_DIR` | 7092 | :term:`SSTATE_DIR` |
7236 | The directory for the shared state cache. | 7093 | The directory for the shared state cache. |
@@ -7320,13 +7177,9 @@ system and gives an overview of their function and contents. | |||
7320 | .. note:: | 7177 | .. note:: |
7321 | 7178 | ||
7322 | This style of build configuration has been largely replaced by | 7179 | This style of build configuration has been largely replaced by |
7323 | pkg-config | 7180 | ``pkg-config``. Consequently, if ``pkg-config`` is supported by the |
7324 | . Consequently, if | 7181 | library to which you are linking, it is recommended you use |
7325 | pkg-config | 7182 | ``pkg-config`` instead of a provided configuration script. |
7326 | is supported by the library to which you are linking, it is | ||
7327 | recommended you use | ||
7328 | pkg-config | ||
7329 | instead of a provided configuration script. | ||
7330 | 7183 | ||
7331 | :term:`STAGING_BINDIR_NATIVE` | 7184 | :term:`STAGING_BINDIR_NATIVE` |
7332 | Specifies the path to the ``/usr/bin`` subdirectory of the sysroot | 7185 | Specifies the path to the ``/usr/bin`` subdirectory of the sysroot |
@@ -7355,15 +7208,10 @@ system and gives an overview of their function and contents. | |||
7355 | 7208 | ||
7356 | .. note:: | 7209 | .. note:: |
7357 | 7210 | ||
7358 | Recipes should never write files directly under the | 7211 | Recipes should never write files directly under the ``STAGING_DIR`` |
7359 | STAGING_DIR | ||
7360 | directory because the OpenEmbedded build system manages the | 7212 | directory because the OpenEmbedded build system manages the |
7361 | directory automatically. Instead, files should be installed to | 7213 | directory automatically. Instead, files should be installed to |
7362 | ${ | 7214 | ``${``\ :term:`D`\ ``}`` within your recipe's :ref:`ref-tasks-install` |
7363 | D | ||
7364 | } | ||
7365 | within your recipe's | ||
7366 | do_install | ||
7367 | task and then the OpenEmbedded build system will stage a subset of | 7215 | task and then the OpenEmbedded build system will stage a subset of |
7368 | those files into the sysroot. | 7216 | those files into the sysroot. |
7369 | 7217 | ||
@@ -7609,12 +7457,9 @@ system and gives an overview of their function and contents. | |||
7609 | 7457 | ||
7610 | .. note:: | 7458 | .. note:: |
7611 | 7459 | ||
7612 | Programs built by | 7460 | Programs built by ``-native`` recipes run directly from the sysroot |
7613 | -native | 7461 | (:term:`STAGING_DIR_NATIVE`), which is why additional directories |
7614 | recipes run directly from the sysroot ( | 7462 | containing program executables and supporting files need to be staged. |
7615 | STAGING_DIR_NATIVE | ||
7616 | ), which is why additional directories containing program | ||
7617 | executables and supporting files need to be staged. | ||
7618 | 7463 | ||
7619 | :term:`SYSROOT_PREPROCESS_FUNCS` | 7464 | :term:`SYSROOT_PREPROCESS_FUNCS` |
7620 | A list of functions to execute after files are staged into the | 7465 | A list of functions to execute after files are staged into the |
@@ -7760,14 +7605,9 @@ system and gives an overview of their function and contents. | |||
7760 | 7605 | ||
7761 | .. note:: | 7606 | .. note:: |
7762 | 7607 | ||
7763 | It is a common workaround to append | 7608 | It is a common workaround to append :term:`LDFLAGS` to |
7764 | LDFLAGS | 7609 | ``TARGET_CC_ARCH`` in recipes that build software for the target that |
7765 | to | 7610 | would not otherwise respect the exported ``LDFLAGS`` variable. |
7766 | TARGET_CC_ARCH | ||
7767 | in recipes that build software for the target that would not | ||
7768 | otherwise respect the exported | ||
7769 | LDFLAGS | ||
7770 | variable. | ||
7771 | 7611 | ||
7772 | :term:`TARGET_CC_KERNEL_ARCH` | 7612 | :term:`TARGET_CC_KERNEL_ARCH` |
7773 | This is a specific kernel compiler flag for a CPU or Application | 7613 | This is a specific kernel compiler flag for a CPU or Application |
@@ -7870,7 +7710,7 @@ system and gives an overview of their function and contents. | |||
7870 | 7710 | ||
7871 | .. note:: | 7711 | .. note:: |
7872 | 7712 | ||
7873 | You do not need to set the TARGET_SYS variable yourself. | 7713 | You do not need to set the ``TARGET_SYS`` variable yourself. |
7874 | 7714 | ||
7875 | Consider these two examples: | 7715 | Consider these two examples: |
7876 | 7716 | ||
@@ -7914,16 +7754,13 @@ system and gives an overview of their function and contents. | |||
7914 | 7754 | ||
7915 | .. note:: | 7755 | .. note:: |
7916 | 7756 | ||
7917 | If | 7757 | If ``TCMODE`` is set to a value other than "default", then it is your |
7918 | TCMODE | ||
7919 | is set to a value other than "default", then it is your | ||
7920 | responsibility to ensure that the toolchain is compatible with the | 7758 | responsibility to ensure that the toolchain is compatible with the |
7921 | default toolchain. Using older or newer versions of these | 7759 | default toolchain. Using older or newer versions of these |
7922 | components might cause build problems. See the Release Notes for | 7760 | components might cause build problems. See the Release Notes for |
7923 | the Yocto Project release for the specific components with which | 7761 | the Yocto Project release for the specific components with which |
7924 | the toolchain must be compatible. To access the Release Notes, go | 7762 | the toolchain must be compatible. To access the Release Notes, go |
7925 | to the | 7763 | to the :yocto_home:`Downloads </software-overview/downloads>` |
7926 | Downloads | ||
7927 | page on the Yocto Project website and click on the "RELEASE | 7764 | page on the Yocto Project website and click on the "RELEASE |
7928 | INFORMATION" link for the appropriate release. | 7765 | INFORMATION" link for the appropriate release. |
7929 | 7766 | ||
@@ -7967,11 +7804,8 @@ system and gives an overview of their function and contents. | |||
7967 | 7804 | ||
7968 | .. note:: | 7805 | .. note:: |
7969 | 7806 | ||
7970 | Actual test results reside in the task log ( | 7807 | Actual test results reside in the task log (``log.do_testimage``), |
7971 | log.do_testimage | 7808 | which is in the ``${WORKDIR}/temp/`` directory. |
7972 | ), which is in the | ||
7973 | ${WORKDIR}/temp/ | ||
7974 | directory. | ||
7975 | 7809 | ||
7976 | :term:`TEST_POWERCONTROL_CMD` | 7810 | :term:`TEST_POWERCONTROL_CMD` |
7977 | For automated hardware testing, specifies the command to use to | 7811 | For automated hardware testing, specifies the command to use to |
@@ -8030,12 +7864,9 @@ system and gives an overview of their function and contents. | |||
8030 | 7864 | ||
8031 | .. note:: | 7865 | .. note:: |
8032 | 7866 | ||
8033 | The | 7867 | The ``TEST_SERVER_IP`` variable is only used for a small number of |
8034 | TEST_SERVER_IP | 7868 | tests such as the "dnf" test suite, which needs to download packages |
8035 | variable is only used for a small number of tests such as the | 7869 | from ``WORKDIR/oe-rootfs-repo``. |
8036 | "dnf" test suite, which needs to download packages from | ||
8037 | WORKDIR/oe-rootfs-repo | ||
8038 | . | ||
8039 | 7870 | ||
8040 | :term:`TEST_SUITES` | 7871 | :term:`TEST_SUITES` |
8041 | An ordered list of tests (modules) to run against an image when | 7872 | An ordered list of tests (modules) to run against an image when |
@@ -8110,8 +7941,7 @@ system and gives an overview of their function and contents. | |||
8110 | .. note:: | 7941 | .. note:: |
8111 | 7942 | ||
8112 | This argument is defined in | 7943 | This argument is defined in |
8113 | meta/lib/oeqa/controllers/simpleremote.py | 7944 | ``meta/lib/oeqa/controllers/simpleremote.py``. |
8114 | . | ||
8115 | 7945 | ||
8116 | For information on running tests on hardware, see the | 7946 | For information on running tests on hardware, see the |
8117 | ":ref:`hardware-image-enabling-tests`" | 7947 | ":ref:`hardware-image-enabling-tests`" |
@@ -8245,7 +8075,7 @@ system and gives an overview of their function and contents. | |||
8245 | :term:`TOPDIR` | 8075 | :term:`TOPDIR` |
8246 | The top-level :term:`Build Directory`. BitBake | 8076 | The top-level :term:`Build Directory`. BitBake |
8247 | automatically sets this variable when you initialize your build | 8077 | automatically sets this variable when you initialize your build |
8248 | environment using ````` <#structure-core-script>`__. | 8078 | environment using :ref:`structure-core-script`. |
8249 | 8079 | ||
8250 | :term:`TRANSLATED_TARGET_ARCH` | 8080 | :term:`TRANSLATED_TARGET_ARCH` |
8251 | A sanitized version of :term:`TARGET_ARCH`. This | 8081 | A sanitized version of :term:`TARGET_ARCH`. This |
@@ -8669,20 +8499,11 @@ system and gives an overview of their function and contents. | |||
8669 | .. note:: | 8499 | .. note:: |
8670 | 8500 | ||
8671 | There is a difference in behavior between setting | 8501 | There is a difference in behavior between setting |
8672 | USERADD_ERROR_DYNAMIC | 8502 | ``USERADD_ERROR_DYNAMIC`` to ``error`` and setting it to ``warn``. |
8673 | to | 8503 | When it is set to ``warn``, the build system will report a warning for |
8674 | error | 8504 | every undefined ``uid`` and ``gid`` in any recipe. But when it is set |
8675 | and setting it to | 8505 | to ``error``, it will only report errors for recipes that are actually |
8676 | warn | 8506 | built. |
8677 | . When it is set to | ||
8678 | warn | ||
8679 | , the build system will report a warning for every undefined | ||
8680 | uid | ||
8681 | and | ||
8682 | gid | ||
8683 | in any recipe. But when it is set to | ||
8684 | error | ||
8685 | , it will only report errors for recipes that are actually built. | ||
8686 | This saves you from having to add static IDs for recipes that you | 8507 | This saves you from having to add static IDs for recipes that you |
8687 | know will never be built. | 8508 | know will never be built. |
8688 | 8509 | ||
@@ -8702,12 +8523,8 @@ system and gives an overview of their function and contents. | |||
8702 | 8523 | ||
8703 | .. note:: | 8524 | .. note:: |
8704 | 8525 | ||
8705 | Setting the | 8526 | Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids" |
8706 | USERADDEXTENSION | 8527 | causes the build system to use static ``gid`` values. |
8707 | variable to "useradd-staticids" causes the build system to use | ||
8708 | static | ||
8709 | gid | ||
8710 | values. | ||
8711 | 8528 | ||
8712 | :term:`USERADD_PACKAGES` | 8529 | :term:`USERADD_PACKAGES` |
8713 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, | 8530 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, |
@@ -8723,15 +8540,9 @@ system and gives an overview of their function and contents. | |||
8723 | 8540 | ||
8724 | .. note:: | 8541 | .. note:: |
8725 | 8542 | ||
8726 | It follows that if you are going to use the | 8543 | It follows that if you are going to use the ``USERADD_PACKAGES`` |
8727 | USERADD_PACKAGES | 8544 | variable, you need to set one or more of the :term:`USERADD_PARAM`, |
8728 | variable, you need to set one or more of the | 8545 | :term:`GROUPADD_PARAM`, or :term:`GROUPMEMS_PARAM` variables. |
8729 | USERADD_PARAM | ||
8730 | , | ||
8731 | GROUPADD_PARAM | ||
8732 | , or | ||
8733 | GROUPMEMS_PARAM | ||
8734 | variables. | ||
8735 | 8546 | ||
8736 | :term:`USERADD_PARAM` | 8547 | :term:`USERADD_PARAM` |
8737 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, | 8548 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, |
@@ -8765,12 +8576,8 @@ system and gives an overview of their function and contents. | |||
8765 | 8576 | ||
8766 | .. note:: | 8577 | .. note:: |
8767 | 8578 | ||
8768 | Setting the | 8579 | Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids" |
8769 | USERADDEXTENSION | 8580 | causes the build system to use static ``uid`` values. |
8770 | variable to "useradd-staticids" causes the build system to use | ||
8771 | static | ||
8772 | uid | ||
8773 | values. | ||
8774 | 8581 | ||
8775 | :term:`USERADDEXTENSION` | 8582 | :term:`USERADDEXTENSION` |
8776 | When set to "useradd-staticids", causes the OpenEmbedded build system | 8583 | When set to "useradd-staticids", causes the OpenEmbedded build system |
@@ -8783,13 +8590,9 @@ system and gives an overview of their function and contents. | |||
8783 | 8590 | ||
8784 | .. note:: | 8591 | .. note:: |
8785 | 8592 | ||
8786 | Setting this variable to use static | 8593 | Setting this variable to use static ``uid`` and ``gid`` |
8787 | uid | ||
8788 | and | ||
8789 | gid | ||
8790 | values causes the OpenEmbedded build system to employ the | 8594 | values causes the OpenEmbedded build system to employ the |
8791 | useradd-staticids | 8595 | :ref:`ref-classes-useradd` class. |
8792 | class. | ||
8793 | 8596 | ||
8794 | If you use static ``uid`` and ``gid`` information, you must also | 8597 | If you use static ``uid`` and ``gid`` information, you must also |
8795 | specify the ``files/passwd`` and ``files/group`` files by setting the | 8598 | specify the ``files/passwd`` and ``files/group`` files by setting the |
@@ -8860,22 +8663,13 @@ system and gives an overview of their function and contents. | |||
8860 | 8663 | ||
8861 | The actual directory depends on several things: | 8664 | The actual directory depends on several things: |
8862 | 8665 | ||
8863 | - TMPDIR | 8666 | - :term:`TMPDIR`: The top-level build output directory |
8864 | : The top-level build output directory | 8667 | - :term:`MULTIMACH_TARGET_SYS`: The target system identifier |
8865 | - MULTIMACH_TARGET_SYS | 8668 | - :term:`PN`: The recipe name |
8866 | : The target system identifier | 8669 | - :term:`EXTENDPE`: The epoch - (if :term:`PE` is not specified, which |
8867 | - PN | 8670 | is usually the case for most recipes, then `EXTENDPE` is blank) |
8868 | : The recipe name | 8671 | - :term:`PV`: The recipe version |
8869 | - EXTENDPE | 8672 | - :term:`PR`: The recipe revision |
8870 | : The epoch - (if | ||
8871 | PE | ||
8872 | is not specified, which is usually the case for most recipes, then | ||
8873 | EXTENDPE | ||
8874 | is blank) | ||
8875 | - PV | ||
8876 | : The recipe version | ||
8877 | - PR | ||
8878 | : The recipe revision | ||
8879 | 8673 | ||
8880 | As an example, assume a Source Directory top-level folder name | 8674 | As an example, assume a Source Directory top-level folder name |
8881 | ``poky``, a default Build Directory at ``poky/build``, and a | 8675 | ``poky``, a default Build Directory at ``poky/build``, and a |