From c473fa229239752367c5d573160fc8738cf1907e Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Fri, 24 Jul 2020 16:27:54 +0200 Subject: sphinx: fix internal links Many of the internal links were not converted probably from DocBook using pandoc. After looking at the various patterns, the follow series of 'naive' Python regexp were used to perform some additional automatic conversion. Also, since we rely on built-in glossary, all links to terms need to use the sphinx :term: syntax. This commit is generated using the following Python series of regexp: line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_REF_URL;)?#var-\\1>`__", ":term:`\\1`", line) line = re.sub("`+do_([a-z_]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-tasks-\\1>`__", ":ref:`ref-tasks-\\1`", line) line = re.sub("`+([a-z_\-\*\.]+).bbclass`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__", ":ref:`\\1.bbclass `", line) line = re.sub("`+([a-z_\-\*\.]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__", ":ref:`\\1 `", line) line = re.sub("`Source Directory <(\&YOCTO_DOCS_REF_URL;)?#source-directory>`__", ":term:`Source Directory`", line) line = re.sub("`Build Directory <(\&YOCTO_DOCS_REF_URL;)?#build-directory>`__", ":term:`Build Directory`", line) line = re.sub("`Metadata <(\&YOCTO_DOCS_REF_URL;)?#metadata>`__", ":term:`Metadata`", line) line = re.sub("`BitBake <(\&YOCTO_DOCS_REF_URL;)?#bitbake-term>`__", ":term:`BitBake`", line) line = re.sub("`Images <(\&YOCTO_DOCS_REF_URL;)?#ref-images>`__", ":ref:`ref-manual/ref-images:Images`", line) line = re.sub("`Classes <(\&YOCTO_DOCS_REF_URL;)?#ref-classes>`__", ":ref:`ref-manual/ref-classes:Classes`", line) line = re.sub("`workspace <(\&YOCTO_DOCS_REF_URL;)?#devtool-the-workspace-layer-structure>`__", ":ref:`devtool-the-workspace-layer-structure`", line) line = re.sub("`Open-?Embedded b?B?uild s?S?ystem <(\&YOCTO_DOCS_REF_URL;)?#build-system-term>`__", ":term:`OpenEmbedded Build System`", line) line = re.sub("`(OpenEmbedded-Core )?(\(?OE-Core\)? )?<(\&YOCTO_DOCS_REF_URL;)?#oe-core>`__", ":term:`OpenEmbedded-Core (OE-Core)`", line) It won't catch multiline strings, but it catches a very large number of occurences! (From yocto-docs rev: 3f537d17de5b1fb76ba3bee196481984a4826378) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/ref-manual/faq.rst | 16 +- documentation/ref-manual/migration.rst | 508 ++++---- documentation/ref-manual/ref-classes.rst | 516 ++++---- documentation/ref-manual/ref-devtool-reference.rst | 10 +- documentation/ref-manual/ref-features.rst | 30 +- documentation/ref-manual/ref-images.rst | 2 +- documentation/ref-manual/ref-kickstart.rst | 2 +- documentation/ref-manual/ref-qa-checks.rst | 132 +- documentation/ref-manual/ref-release-process.rst | 10 +- documentation/ref-manual/ref-structure.rst | 58 +- documentation/ref-manual/ref-tasks.rst | 126 +- documentation/ref-manual/ref-terms.rst | 16 +- documentation/ref-manual/ref-variables.rst | 1336 ++++++++++---------- documentation/ref-manual/resources.rst | 4 +- 14 files changed, 1383 insertions(+), 1383 deletions(-) (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index d3dac28b0f..07244a0311 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst @@ -8,7 +8,7 @@ FAQ **A:** The term "`Poky <#>`__" refers to the specific reference build system that the Yocto Project provides. Poky is based on -`OE-Core <#oe-core>`__ and `BitBake <#bitbake-term>`__. Thus, the +:term:`OpenEmbedded-Core (OE-Core)` and :term:`BitBake`. Thus, the generic term used here for the build system is the "OpenEmbedded build system." Development in the Yocto Project using Poky is closely tied to OpenEmbedded, with changes always being merged to OE-Core or BitBake @@ -29,7 +29,7 @@ steps on how to update your build tools. **A:** There are three areas that help with stability; -- The Yocto Project team keeps `OE-Core <#oe-core>`__ small and +- The Yocto Project team keeps :term:`OpenEmbedded-Core (OE-Core)` small and focused, containing around 830 recipes as opposed to the thousands available in other OpenEmbedded community layers. Keeping it small makes it easy to test and maintain. @@ -227,19 +227,19 @@ meta-MACHINE/recipes-bsp/netbase/netbase_5.0.bbappend size, you need to set various configurations: - *Image Size:* The OpenEmbedded build system uses the - ```IMAGE_ROOTFS_SIZE`` <#var-IMAGE_ROOTFS_SIZE>`__ variable to define + :term:`IMAGE_ROOTFS_SIZE` variable to define the size of the image in Kbytes. The build system determines the size by taking into account the initial root filesystem size before any modifications such as requested size for the image and any requested additional free disk space to be added to the image. - *Overhead:* Use the - ```IMAGE_OVERHEAD_FACTOR`` <#var-IMAGE_OVERHEAD_FACTOR>`__ variable + :term:`IMAGE_OVERHEAD_FACTOR` variable to define the multiplier that the build system applies to the initial image size, which is 1.3 by default. - *Additional Free Space:* Use the - ```IMAGE_ROOTFS_EXTRA_SPACE`` <#var-IMAGE_ROOTFS_EXTRA_SPACE>`__ + :term:`IMAGE_ROOTFS_EXTRA_SPACE` variable to add additional free space to the image. The build system adds this space to the image after it determines its ``IMAGE_ROOTFS_SIZE``. @@ -281,8 +281,8 @@ environments if HTTP transport is available. When the build system searches for source code, it first tries the local download directory. If that location fails, Poky tries -```PREMIRRORS`` <#var-PREMIRRORS>`__, the upstream source, and then -```MIRRORS`` <#var-MIRRORS>`__ in that order. +:term:`PREMIRRORS`, the upstream source, and then +:term:`MIRRORS` in that order. Assuming your distribution is "poky", the OpenEmbedded build system uses the Yocto Project source ``PREMIRRORS`` by default for SCM-based @@ -409,7 +409,7 @@ my recipe is installing to the wrong place, or I am getting permissions errors during the do_install task in my recipe! What is wrong? **A:** This situation results when a build system does not recognize the -environment variables supplied to it by `BitBake <#bitbake-term>`__. The +environment variables supplied to it by :term:`BitBake`. The incident that prompted this FAQ entry involved a Makefile that used an environment variable named ``BINDIR`` instead of the more standard variable ``bindir``. The makefile's hardcoded default value of diff --git a/documentation/ref-manual/migration.rst b/documentation/ref-manual/migration.rst index 8a309d003b..b8d27f3325 100644 --- a/documentation/ref-manual/migration.rst +++ b/documentation/ref-manual/migration.rst @@ -68,7 +68,7 @@ Local Configuration ------------------- Differences include changes for -```SSTATE_MIRRORS`` <#var-SSTATE_MIRRORS>`__ and ``bblayers.conf``. +:term:`SSTATE_MIRRORS` and ``bblayers.conf``. .. _migration-1.3-sstate-mirrors: @@ -76,13 +76,13 @@ SSTATE_MIRRORS ~~~~~~~~~~~~~~ The shared state cache (sstate-cache), as pointed to by -```SSTATE_DIR`` <#var-SSTATE_DIR>`__, by default now has two-character +:term:`SSTATE_DIR`, by default now has two-character subdirectories to prevent issues arising from too many files in the same directory. Also, native sstate-cache packages, which are built to run on the host system, will go into a subdirectory named using the distro ID string. If you copy the newly structured sstate-cache to a mirror location (either local or remote) and then point to it in -```SSTATE_MIRRORS`` <#var-SSTATE_MIRRORS>`__, you need to append "PATH" +:term:`SSTATE_MIRRORS`, you need to append "PATH" to the end of the mirror URL so that the path used by BitBake before the mirror substitution is appended to the path used to access the mirror. Here is an example: SSTATE_MIRRORS = "file://.\* @@ -138,7 +138,7 @@ four-space indentation. proto= in SRC_URI ~~~~~~~~~~~~~~~~~ -Any use of ``proto=`` in ```SRC_URI`` <#var-SRC_URI>`__ needs to be +Any use of ``proto=`` in :term:`SRC_URI` needs to be changed to ``protocol=``. In particular, this applies to the following URIs: @@ -161,7 +161,7 @@ nativesdk The suffix ``nativesdk`` is now implemented as a prefix, which simplifies a lot of the packaging code for ``nativesdk`` recipes. All custom ``nativesdk`` recipes, which are relocatable packages that are -native to ```SDK_ARCH`` <#var-SDK_ARCH>`__, and any references need to +native to :term:`SDK_ARCH`, and any references need to be updated to use ``nativesdk-*`` instead of ``*-nativesdk``. .. _migration-1.3-task-recipes: @@ -179,8 +179,8 @@ recipes to ``packagegroup-*``, and change them to inherit ``packagegroup`` instead of ``task``, as well as taking the opportunity to remove anything now handled by ``packagegroup.bbclass``, such as providing ``-dev`` and ``-dbg`` packages, setting -```LIC_FILES_CHKSUM`` <#var-LIC_FILES_CHKSUM>`__, and so forth. See the -"```packagegroup.bbclass`` <#ref-classes-packagegroup>`__" section for +:term:`LIC_FILES_CHKSUM`, and so forth. See the +":ref:`packagegroup.bbclass `" section for further details. .. _migration-1.3-image-features: @@ -189,7 +189,7 @@ IMAGE_FEATURES ~~~~~~~~~~~~~~ Image recipes that previously included "apps-console-core" in -```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ should now include "splash" +:term:`IMAGE_FEATURES` should now include "splash" instead to enable the boot-up splash screen. Retaining "apps-console-core" will still include the splash screen but generates a warning. The "apps-x11-core" and "apps-x11-games" ``IMAGE_FEATURES`` @@ -202,7 +202,7 @@ Removed Recipes The following recipes have been removed. For most of them, it is unlikely that you would have any references to them in your own -`Metadata <#metadata>`__. However, you should check your metadata +:term:`Metadata`. However, you should check your metadata against this list to be sure: - *``libx11-trim``*: Replaced by ``libx11``, which has a negligible @@ -247,7 +247,7 @@ Linux Kernel Naming ------------------- The naming scheme for kernel output binaries has been changed to now -include ```PE`` <#var-PE>`__ as part of the filename: +include :term:`PE` as part of the filename: KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PE}-${PV}-${PR}-${MACHINE}-${DATETIME}" @@ -276,13 +276,13 @@ Differences include the following: a comment. - *Package Name Overrides:* The runtime package specific variables - ```RDEPENDS`` <#var-RDEPENDS>`__, - ```RRECOMMENDS`` <#var-RRECOMMENDS>`__, - ```RSUGGESTS`` <#var-RSUGGESTS>`__, - ```RPROVIDES`` <#var-RPROVIDES>`__, - ```RCONFLICTS`` <#var-RCONFLICTS>`__, - ```RREPLACES`` <#var-RREPLACES>`__, ```FILES`` <#var-FILES>`__, - ```ALLOW_EMPTY`` <#var-ALLOW_EMPTY>`__, and the pre, post, install, + :term:`RDEPENDS`, + :term:`RRECOMMENDS`, + :term:`RSUGGESTS`, + :term:`RPROVIDES`, + :term:`RCONFLICTS`, + :term:`RREPLACES`, :term:`FILES`, + :term:`ALLOW_EMPTY`, and the pre, post, install, and uninstall script functions ``pkg_preinst``, ``pkg_postinst``, ``pkg_prerm``, and ``pkg_postrm`` should always have a package name override. For example, use ``RDEPENDS_${PN}`` for the main package @@ -305,15 +305,15 @@ Differences include the following: you have missing declared dependencies. - *Scanning Directory Names:* When scanning for files in - ```SRC_URI`` <#var-SRC_URI>`__, the build system now uses - ```FILESOVERRIDES`` <#var-FILESOVERRIDES>`__ instead of - ```OVERRIDES`` <#var-OVERRIDES>`__ for the directory names. In + :term:`SRC_URI`, the build system now uses + :term:`FILESOVERRIDES` instead of + :term:`OVERRIDES` for the directory names. In general, the values previously in ``OVERRIDES`` are now in ``FILESOVERRIDES`` as well. However, if you relied upon an additional value you previously added to ``OVERRIDES``, you might now need to add it to ``FILESOVERRIDES`` unless you are already adding it through - the ```MACHINEOVERRIDES`` <#var-MACHINEOVERRIDES>`__ or - ```DISTROOVERRIDES`` <#var-DISTROOVERRIDES>`__ variables, as + the :term:`MACHINEOVERRIDES` or + :term:`DISTROOVERRIDES` variables, as appropriate. For more related changes, see the "`Variables <#migration-1.4-variables>`__" section. @@ -335,7 +335,7 @@ Custom Interfaces File (netbase change) If you have created your own custom ``etc/network/interfaces`` file by creating an append file for the ``netbase`` recipe, you now need to create an append file for the ``init-ifupdown`` recipe instead, which -you can find in the `Source Directory <#source-directory>`__ at +you can find in the :term:`Source Directory` at ``meta/recipes-core/init-ifupdown``. For information on how to use append files, see the "`Using .bbappend Files <&YOCTO_DOCS_DEV_URL;#using-bbappend-files>`__" section in the @@ -363,24 +363,24 @@ The following variables have changed: - *``SANITY_TESTED_DISTROS``:* This variable now uses a distribution ID, which is composed of the host distributor ID followed by the release. Previously, - ```SANITY_TESTED_DISTROS`` <#var-SANITY_TESTED_DISTROS>`__ was + :term:`SANITY_TESTED_DISTROS` was composed of the description field. For example, "Ubuntu 12.10" becomes "Ubuntu-12.10". You do not need to worry about this change if you are not specifically setting this variable, or if you are specifically setting it to "". -- *``SRC_URI``:* The ``${``\ ```PN`` <#var-PN>`__\ ``}``, - ``${``\ ```PF`` <#var-PF>`__\ ``}``, - ``${``\ ```P`` <#var-P>`__\ ``}``, and ``FILE_DIRNAME`` directories +- *``SRC_URI``:* The ``${``\ :term:`PN`\ ``}``, + ``${``\ :term:`PF`\ ``}``, + ``${``\ :term:`P`\ ``}``, and ``FILE_DIRNAME`` directories have been dropped from the default value of the - ```FILESPATH`` <#var-FILESPATH>`__ variable, which is used as the + :term:`FILESPATH` variable, which is used as the search path for finding files referred to in - ```SRC_URI`` <#var-SRC_URI>`__. If you have a recipe that relied upon + :term:`SRC_URI`. If you have a recipe that relied upon these directories, which would be unusual, then you will need to add the appropriate paths within the recipe or, alternatively, rearrange the files. The most common locations are still covered by ``${BP}``, ``${BPN}``, and "files", which all remain in the default value of - ```FILESPATH`` <#var-FILESPATH>`__. + :term:`FILESPATH`. .. _migration-target-package-management-with-rpm: @@ -554,9 +554,9 @@ The following changes have been made that relate to BitBake: - The ``bitbake-runtask`` script has been removed. -- ``${``\ ```P`` <#var-P>`__\ ``}`` and - ``${``\ ```PF`` <#var-PF>`__\ ``}`` are no longer added to - ```PROVIDES`` <#var-PROVIDES>`__ by default in ``bitbake.conf``. +- ``${``\ :term:`P`\ ``}`` and + ``${``\ :term:`PF`\ ``}`` are no longer added to + :term:`PROVIDES` by default in ``bitbake.conf``. These version-specific ``PROVIDES`` items were seldom used. Attempting to use them could result in two versions being built simultaneously rather than just one version due to the way BitBake @@ -569,19 +569,19 @@ QA Warnings The following changes have been made to the package QA checks: -- If you have customized ```ERROR_QA`` <#var-ERROR_QA>`__ or - ```WARN_QA`` <#var-WARN_QA>`__ values in your configuration, check +- If you have customized :term:`ERROR_QA` or + :term:`WARN_QA` values in your configuration, check that they contain all of the issues that you wish to be reported. Previous Yocto Project versions contained a bug that meant that any item not mentioned in ``ERROR_QA`` or ``WARN_QA`` would be treated as a warning. Consequently, several important items were not already in the default value of ``WARN_QA``. All of the possible QA checks are - now documented in the "```insane.bbclass`` <#ref-classes-insane>`__" + now documented in the ":ref:`insane.bbclass `" section. - An additional QA check has been added to check if ``/usr/share/info/dir`` is being installed. Your recipe should delete - this file within ```do_install`` <#ref-tasks-install>`__ if "make + this file within :ref:`ref-tasks-install` if "make install" is installing it. - If you are using the buildhistory class, the check for the package @@ -591,7 +591,7 @@ The following changes have been made to the package QA checks: "version-going-backwards" to your value for one or the other variables depending on how you wish it to be handled. See the documented QA checks in the - "```insane.bbclass`` <#ref-classes-insane>`__" section. + ":ref:`insane.bbclass `" section. .. _migration-1.5-directory-layout-changes: @@ -601,25 +601,25 @@ Directory Layout Changes The following directory changes exist: - Output SDK installer files are now named to include the image name - and tuning architecture through the ```SDK_NAME`` <#var-SDK_NAME>`__ + and tuning architecture through the :term:`SDK_NAME` variable. - Images and related files are now installed into a directory that is specific to the machine, instead of a parent directory containing output files for multiple machines. The - ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__ variable continues + :term:`DEPLOY_DIR_IMAGE` variable continues to point to the directory containing images for the current - ```MACHINE`` <#var-MACHINE>`__ and should be used anywhere there is a + :term:`MACHINE` and should be used anywhere there is a need to refer to this directory. The ``runqemu`` script now uses this variable to find images and kernel binaries and will use BitBake to determine the directory. Alternatively, you can set the ``DEPLOY_DIR_IMAGE`` variable in the external environment. - When buildhistory is enabled, its output is now written under the - `Build Directory <#build-directory>`__ rather than - ```TMPDIR`` <#var-TMPDIR>`__. Doing so makes it easier to delete + :term:`Build Directory` rather than + :term:`TMPDIR`. Doing so makes it easier to delete ``TMPDIR`` and preserve the build history. Additionally, data for - produced SDKs is now split by ```IMAGE_NAME`` <#var-IMAGE_NAME>`__. + produced SDKs is now split by :term:`IMAGE_NAME`. - The ``pkgdata`` directory produced as part of the packaging process has been collapsed into a single machine-specific directory. This @@ -632,7 +632,7 @@ Shortened Git ``SRCREV`` Values ------------------------------- BitBake will now shorten revisions from Git repositories from the normal -40 characters down to 10 characters within ```SRCPV`` <#var-SRCPV>`__ +40 characters down to 10 characters within :term:`SRCPV` for improved usability in path and file names. This change should be safe within contexts where these revisions are used because the chances of spatially close collisions is very low. Distant collisions are not a @@ -644,16 +644,16 @@ major issue in the way the values are used. ------------------ The following changes have been made that relate to -```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__: +:term:`IMAGE_FEATURES`: - The value of ``IMAGE_FEATURES`` is now validated to ensure invalid feature items are not added. Some users mistakenly add package names to this variable instead of using - ```IMAGE_INSTALL`` <#var-IMAGE_INSTALL>`__ in order to have the + :term:`IMAGE_INSTALL` in order to have the package added to the image, which does not work. This change is intended to catch those kinds of situations. Valid ``IMAGE_FEATURES`` are drawn from ``PACKAGE_GROUP`` definitions, - ```COMPLEMENTARY_GLOB`` <#var-COMPLEMENTARY_GLOB>`__ and a new + :term:`COMPLEMENTARY_GLOB` and a new "validitems" varflag on ``IMAGE_FEATURES``. The "validitems" varflag change allows additional features to be added if they are not provided using the previous two mechanisms. @@ -682,9 +682,9 @@ Removal of Package Manager Database Within Image Recipes The image ``core-image-minimal`` no longer adds ``remove_packaging_data_files`` to -```ROOTFS_POSTPROCESS_COMMAND`` <#var-ROOTFS_POSTPROCESS_COMMAND>`__. +:term:`ROOTFS_POSTPROCESS_COMMAND`. This addition is now handled automatically when "package-management" is -not in ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__. If you have custom +not in :term:`IMAGE_FEATURES`. If you have custom image recipes that make this addition, you should remove the lines, as they are not needed and might interfere with correct operation of postinstall scripts. @@ -694,7 +694,7 @@ postinstall scripts. Images Now Rebuild Only on Changes Instead of Every Time -------------------------------------------------------- -The ```do_rootfs`` <#ref-tasks-rootfs>`__ and other related image +The :ref:`ref-tasks-rootfs` and other related image construction tasks are no longer marked as "nostamp". Consequently, they will only be re-executed when their inputs have changed. Previous versions of the OpenEmbedded build system always rebuilt the image when @@ -711,7 +711,7 @@ them from ``task-*`` to ``packagegroup-*`` and inherit packagegroup instead. For more information, see the -"```packagegroup.bbclass`` <#ref-classes-packagegroup>`__" section. +":ref:`packagegroup.bbclass `" section. .. _migration-1.5-busybox: @@ -723,7 +723,7 @@ root for those components that need it, and another for the rest of the components. Splitting BusyBox allows for optimization that eliminates the ``tinylogin`` recipe as recommended by upstream. You can disable this split by setting -```BUSYBOX_SPLIT_SUID`` <#var-BUSYBOX_SPLIT_SUID>`__ to "0". +:term:`BUSYBOX_SPLIT_SUID` to "0". .. _migration-1.5-automated-image-testing: @@ -771,7 +771,7 @@ section in the Yocto Project Development Tasks Manual. Following are changes to ``udev``: - ``udev`` no longer brings in ``udev-extraconf`` automatically through - ```RRECOMMENDS`` <#var-RRECOMMENDS>`__, since this was originally + :term:`RRECOMMENDS`, since this was originally intended to be optional. If you need the extra rules, then add ``udev-extraconf`` to your image. @@ -821,13 +821,13 @@ Following is a list of short entries describing other changes: - ``alsa-state``: Provide an empty ``asound.conf`` by default. - ``classes/image``: Ensure - ```BAD_RECOMMENDATIONS`` <#var-BAD_RECOMMENDATIONS>`__ supports + :term:`BAD_RECOMMENDATIONS` supports pre-renamed package names. - ``classes/rootfs_rpm``: Implement ``BAD_RECOMMENDATIONS`` for RPM. - ``systemd``: Remove ``systemd_unitdir`` if ``systemd`` is not in - ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__. + :term:`DISTRO_FEATURES`. - ``systemd``: Remove ``init.d`` dir if ``systemd`` unit file is present and ``sysvinit`` is not a distro feature. @@ -854,7 +854,7 @@ Project 1.6 Release from the prior release. ``archiver`` Class ------------------ -The ```archiver`` <#ref-classes-archiver>`__ class has been rewritten +The :ref:`archiver ` class has been rewritten and its configuration has been simplified. For more details on the source archiver, see the "`Maintaining Open Source License Compliance During Your Product's @@ -889,7 +889,7 @@ The following packaging changes have been made: BitBake ------- -The following changes have been made to `BitBake <#bitbake-term>`__. +The following changes have been made to :term:`BitBake`. .. _migration-1.6-matching-branch-requirement-for-git-fetching: @@ -897,8 +897,8 @@ Matching Branch Requirement for Git Fetching ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ When fetching source from a Git repository using -```SRC_URI`` <#var-SRC_URI>`__, BitBake will now validate the -```SRCREV`` <#var-SRCREV>`__ value against the branch. You can specify +:term:`SRC_URI`, BitBake will now validate the +:term:`SRCREV` value against the branch. You can specify the branch using the following form: SRC_URI = "git://server.name/repository;branch=branchname" If you do not specify a branch, BitBake looks in the default "master" branch. @@ -960,7 +960,7 @@ will need to add ``2>&1`` (or something similar) to the end of your ``task-``\ taskname overrides have been adjusted so that tasks whose names contain underscores have the underscores replaced by hyphens for the override so that they now function properly. For example, the task -override for ```do_populate_sdk`` <#ref-tasks-populate_sdk>`__ is +override for :ref:`ref-tasks-populate_sdk` is ``task-populate-sdk``. .. _migration-1.6-variable-changes: @@ -977,7 +977,7 @@ Glossary <#ref-variables-glos>`__" Chapter. ``TMPDIR`` ~~~~~~~~~~ -```TMPDIR`` <#var-TMPDIR>`__ can no longer be on an NFS mount. NFS does +:term:`TMPDIR` can no longer be on an NFS mount. NFS does not offer full POSIX locking and inode consistency and can cause unexpected issues if used to store ``TMPDIR``. @@ -990,7 +990,7 @@ NFS mount, an error occurs. ~~~~~~~~~ The ``PRINC`` variable has been deprecated and triggers a warning if -detected during a build. For ```PR`` <#var-PR>`__ increments on changes, +detected during a build. For :term:`PR` increments on changes, use the PR service instead. You can find out more about this service in the "`Working With a PR Service <&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service>`__" section in @@ -1001,7 +1001,7 @@ the Yocto Project Development Tasks Manual. ``IMAGE_TYPES`` ~~~~~~~~~~~~~~~ -The "sum.jffs2" option for ```IMAGE_TYPES`` <#var-IMAGE_TYPES>`__ has +The "sum.jffs2" option for :term:`IMAGE_TYPES` has been replaced by the "jffs2.sum" option, which fits the processing order. @@ -1010,7 +1010,7 @@ order. ``COPY_LIC_MANIFEST`` ~~~~~~~~~~~~~~~~~~~~~ -The ```COPY_LIC_MANIFEST`` <#var-COPY_LIC_MANIFEST>`__ variable must now +The :term:`COPY_LIC_MANIFEST` variable must now be set to "1" rather than any value in order to enable it. .. _migration-1.6-variable-changes-COPY_LIC_DIRS: @@ -1018,7 +1018,7 @@ be set to "1" rather than any value in order to enable it. ``COPY_LIC_DIRS`` ~~~~~~~~~~~~~~~~~ -The ```COPY_LIC_DIRS`` <#var-COPY_LIC_DIRS>`__ variable must now be set +The :term:`COPY_LIC_DIRS` variable must now be set to "1" rather than any value in order to enable it. .. _migration-1.6-variable-changes-PACKAGE_GROUP: @@ -1027,7 +1027,7 @@ to "1" rather than any value in order to enable it. ~~~~~~~~~~~~~~~~~ The ``PACKAGE_GROUP`` variable has been renamed to -```FEATURE_PACKAGES`` <#var-FEATURE_PACKAGES>`__ to more accurately +:term:`FEATURE_PACKAGES` to more accurately reflect its purpose. You can still use ``PACKAGE_GROUP`` but the OpenEmbedded build system produces a warning message when it encounters the variable. @@ -1039,15 +1039,15 @@ Preprocess and Post Process Command Variable Behavior The following variables now expect a semicolon separated list of functions to call and not arbitrary shell commands: -`ROOTFS_PREPROCESS_COMMAND <#var-ROOTFS_PREPROCESS_COMMAND>`__ -`ROOTFS_POSTPROCESS_COMMAND <#var-ROOTFS_POSTPROCESS_COMMAND>`__ -`SDK_POSTPROCESS_COMMAND <#var-SDK_POSTPROCESS_COMMAND>`__ -`POPULATE_SDK_POST_TARGET_COMMAND <#var-POPULATE_SDK_POST_TARGET_COMMAND>`__ -`POPULATE_SDK_POST_HOST_COMMAND <#var-POPULATE_SDK_POST_HOST_COMMAND>`__ -`IMAGE_POSTPROCESS_COMMAND <#var-IMAGE_POSTPROCESS_COMMAND>`__ -`IMAGE_PREPROCESS_COMMAND <#var-IMAGE_PREPROCESS_COMMAND>`__ -`ROOTFS_POSTUNINSTALL_COMMAND <#var-ROOTFS_POSTUNINSTALL_COMMAND>`__ -`ROOTFS_POSTINSTALL_COMMAND <#var-ROOTFS_POSTINSTALL_COMMAND>`__ For +:term:`ROOTFS_PREPROCESS_COMMAND` +:term:`ROOTFS_POSTPROCESS_COMMAND` +:term:`SDK_POSTPROCESS_COMMAND` +:term:`POPULATE_SDK_POST_TARGET_COMMAND` +:term:`POPULATE_SDK_POST_HOST_COMMAND` +:term:`IMAGE_POSTPROCESS_COMMAND` +:term:`IMAGE_PREPROCESS_COMMAND` +:term:`ROOTFS_POSTUNINSTALL_COMMAND` +:term:`ROOTFS_POSTINSTALL_COMMAND` For migration purposes, you can simply wrap shell commands in a shell function and then call the function. Here is an example: my_postprocess_function() { echo "hello" > ${IMAGE_ROOTFS}/hello.txt } @@ -1062,7 +1062,7 @@ Package Tests (ptest) are built but not installed by default. For information on using Package Tests, see the "`Testing Packages with ptest <&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest>`__" section in the Yocto Project Development Tasks Manual. For information on the -``ptest`` class, see the "```ptest.bbclass`` <#ref-classes-ptest>`__" +``ptest`` class, see the ":ref:`ptest.bbclass `" section. .. _migration-1.6-build-changes: @@ -1072,8 +1072,8 @@ Build Changes Separate build and source directories have been enabled by default for selected recipes where it is known to work (a whitelist) and for all -recipes that inherit the ```cmake`` <#ref-classes-cmake>`__ class. In -future releases the ```autotools`` <#ref-classes-autotools>`__ class +recipes that inherit the :ref:`cmake ` class. In +future releases the :ref:`autotools ` class will enable a separate build directory by default as well. Recipes building Autotools-based software that fails to build with a separate build directory should be changed to inherit from the @@ -1116,12 +1116,12 @@ Licensing --------- The top-level ``LICENSE`` file has been changed to better describe the -license of the various components of `OE-Core <#oe-core>`__. However, +license of the various components of :term:`OpenEmbedded-Core (OE-Core)`. However, the licensing itself remains unchanged. Normally, this change would not cause any side-effects. However, some recipes point to this file within -```LIC_FILES_CHKSUM`` <#var-LIC_FILES_CHKSUM>`__ (as +:term:`LIC_FILES_CHKSUM` (as ``${COREBASE}/LICENSE``) and thus the accompanying checksum must be changed from 3f40d7994397109285ec7b81fdeb3b58 to 4d92cd373abda3937c2bc47fbc49d690. A better alternative is to have @@ -1135,7 +1135,7 @@ rather than pointing to ``${COREBASE}/LICENSE``. ------------------ The "-fpermissive" option has been removed from the default -```CFLAGS`` <#var-CFLAGS>`__ value. You need to take action on +:term:`CFLAGS` value. You need to take action on individual recipes that fail when building with this option. You need to either patch the recipes to fix the issues reported by the compiler, or you need to add "-fpermissive" to ``CFLAGS`` in the recipes. @@ -1146,9 +1146,9 @@ Custom Image Output Types ------------------------- Custom image output types, as selected using -```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__, must declare their +:term:`IMAGE_FSTYPES`, must declare their dependencies on other image types (if any) using a new -```IMAGE_TYPEDEP`` <#var-IMAGE_TYPEDEP>`__ variable. +:term:`IMAGE_TYPEDEP` variable. .. _migration-1.6-do-package-write-task: @@ -1264,7 +1264,7 @@ Changes to Setting QEMU ``PACKAGECONFIG`` Options in ``local.conf`` ------------------------------------------------------------------- The QEMU recipe now uses a number of -```PACKAGECONFIG`` <#var-PACKAGECONFIG>`__ options to enable various +:term:`PACKAGECONFIG` options to enable various optional features. The method used to set defaults for these options means that existing ``local.conf`` files will need to be be modified to append to ``PACKAGECONFIG`` for ``qemu-native`` and ``nativesdk-qemu`` @@ -1291,13 +1291,13 @@ for more information. Autotools Class Changes ----------------------- -The following ```autotools`` <#ref-classes-autotools>`__ class changes +The following :ref:`autotools ` class changes occurred: - *A separate build directory is now used by default:* The ``autotools`` class has been changed to use a directory for building - (```B`` <#var-B>`__), which is separate from the source directory - (```S`` <#var-S>`__). This is commonly referred to as ``B != S``, or + (:term:`B`), which is separate from the source directory + (:term:`S`). This is commonly referred to as ``B != S``, or an out-of-tree build. If the software being built is already capable of building in a @@ -1368,10 +1368,10 @@ Kernel Module Autoloading The ```module_autoload_*`` <#var-module_autoload>`__ variable is now deprecated and a new -```KERNEL_MODULE_AUTOLOAD`` <#var-KERNEL_MODULE_AUTOLOAD>`__ variable +:term:`KERNEL_MODULE_AUTOLOAD` variable should be used instead. Also, ```module_conf_*`` <#var-module_conf>`__ must now be used in conjunction with a new -```KERNEL_MODULE_PROBECONF`` <#var-KERNEL_MODULE_PROBECONF>`__ variable. +:term:`KERNEL_MODULE_PROBECONF` variable. The new variables no longer require you to specify the module name as part of the variable name. This change not only simplifies usage but also allows the values of these variables to be appropriately @@ -1395,15 +1395,15 @@ The following changes have occurred to the QA check process: see the "`QA Error and Warning Messages <#ref-qa-checks>`__" chapter. - Package QA checks are now performed during a new - ```do_package_qa`` <#ref-tasks-package_qa>`__ task rather than being - part of the ```do_package`` <#ref-tasks-package>`__ task. This allows + :ref:`ref-tasks-package_qa` task rather than being + part of the :ref:`ref-tasks-package` task. This allows more parallel execution. This change is unlikely to be an issue except for highly customized recipes that disable packaging tasks themselves by marking them as ``noexec``. For those packages, you will need to disable the ``do_package_qa`` task as well. - Files being overwritten during the - ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task now + :ref:`ref-tasks-populate_sysroot` task now trigger an error instead of a warning. Recipes should not be overwriting files written to the sysroot by other recipes. If you have these types of recipes, you need to alter them so that they do @@ -1412,7 +1412,7 @@ The following changes have occurred to the QA check process: You might now receive this error after changes in configuration or metadata resulting in orphaned files being left in the sysroot. If you do receive this error, the way to resolve the issue is to delete - your ```TMPDIR`` <#var-TMPDIR>`__ or to move it out of the way and + your :term:`TMPDIR` or to move it out of the way and then re-start the build. Anything that has been fully built up to that point and does not need rebuilding will be restored from the shared state cache and the rest of the build will be able to proceed @@ -1508,7 +1508,7 @@ BlueZ 4.x / 5.x Selection Proper built-in support for selecting BlueZ 5.x in preference to the default of 4.x now exists. To use BlueZ 5.x, simply add "bluez5" to your -```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ value. If you had +:term:`DISTRO_FEATURES` value. If you had previously added append files (``*.bbappend``) to make this selection, you can now remove them. @@ -1532,8 +1532,8 @@ code tree. In theory, migration paths have been provided for most common usages in kernel recipes but this might not work in all cases. In particular, users need to ensure that ``${S}`` (source files) and ``${B}`` (build artifacts) are used correctly in functions such as -```do_configure`` <#ref-tasks-configure>`__ and -```do_install`` <#ref-tasks-install>`__. For kernel recipes that do not +:ref:`ref-tasks-configure` and +:ref:`ref-tasks-install`. For kernel recipes that do not inherit from ``kernel-yocto`` or include ``linux-yocto.inc``, you might wish to refer to the ``linux.inc`` file in the ``meta-oe`` layer for the kinds of changes you need to make. For reference, here is the @@ -1554,7 +1554,7 @@ SSL 3.0 is now disabled when building OpenSSL. Disabling SSL 3.0 avoids any lingering instances of the POODLE vulnerability. If you feel you must re-enable SSL 3.0, then you can add an append file (``*.bbappend``) for the ``openssl`` recipe to remove "-no-ssl3" from -```EXTRA_OECONF`` <#var-EXTRA_OECONF>`__. +:term:`EXTRA_OECONF`. .. _migration-1.8-default-sysroot-poisoning: @@ -1578,17 +1578,17 @@ need to take corrective steps. Rebuild Improvements -------------------- -Changes have been made to the ```base`` <#ref-classes-base>`__, -```autotools`` <#ref-classes-autotools>`__, and -```cmake`` <#ref-classes-cmake>`__ classes to clean out generated files -when the ```do_configure`` <#ref-tasks-configure>`__ task needs to be +Changes have been made to the :ref:`base `, +:ref:`autotools `, and +:ref:`cmake ` classes to clean out generated files +when the :ref:`ref-tasks-configure` task needs to be re-executed. One of the improvements is to attempt to run "make clean" during the ``do_configure`` task if a ``Makefile`` exists. Some software packages do not provide a working clean target within their make files. If you have such recipes, you need to set -```CLEANBROKEN`` <#var-CLEANBROKEN>`__ to "1" within the recipe, for +:term:`CLEANBROKEN` to "1" within the recipe, for example: CLEANBROKEN = "1" .. _migration-1.8-qa-check-and-validation-changes: @@ -1603,18 +1603,18 @@ The following QA Check and Validation Changes have occurred: recipe or append file. - An additional QA check has been added to detect usage of ``${D}`` in - ```FILES`` <#var-FILES>`__ values where ```D`` <#var-D>`__ values + :term:`FILES` values where :term:`D` values should not be used at all. The same check ensures that ``$D`` is used in ``pkg_preinst/pkg_postinst/pkg_prerm/pkg_postrm`` functions instead of ``${D}``. -- ```S`` <#var-S>`__ now needs to be set to a valid value within a +- :term:`S` now needs to be set to a valid value within a recipe. If ``S`` is not set in the recipe, the directory is not automatically created. If ``S`` does not point to a directory that - exists at the time the ```do_unpack`` <#ref-tasks-unpack>`__ task + exists at the time the :ref:`ref-tasks-unpack` task finishes, a warning will be shown. -- ```LICENSE`` <#var-LICENSE>`__ is now validated for correct +- :term:`LICENSE` is now validated for correct formatting of multiple licenses. If the format is invalid (e.g. multiple licenses are specified with no operators to specify how the multiple licenses interact), then a warning will be shown. @@ -1633,7 +1633,7 @@ The following miscellaneous changes have occurred: - The ``oe-pkgdata-util`` script now expects a "-p" option to be specified before the ``pkgdata`` directory, which is now optional. If the ``pkgdata`` directory is not specified, the script will run - BitBake to query ```PKGDATA_DIR`` <#var-PKGDATA_DIR>`__ from the + BitBake to query :term:`PKGDATA_DIR` from the build environment. Moving to the Yocto Project 2.0 Release @@ -1811,7 +1811,7 @@ Recipe Maintenance Tracking Data Moved to OE-Core ------------------------------------------------- Maintenance tracking data for recipes that was previously part of -``meta-yocto`` has been moved to `OE-Core <#oe-core>`__. The change +``meta-yocto`` has been moved to :term:`OpenEmbedded-Core (OE-Core)`. The change includes ``package_regex.inc`` and ``distro_alias.inc``, which are typically enabled when using the ``distrodata`` class. Additionally, the contents of ``upstream_tracking.inc`` has now been split out to the @@ -1827,7 +1827,7 @@ configuration are now automatically removed from sysroot as well as removed from any other place managed by shared state. This automatic cleanup means that the build system now properly handles situations such as renaming the build system side of recipes, removal of layers from -``bblayers.conf``, and ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ +``bblayers.conf``, and :term:`DISTRO_FEATURES` changes. Additionally, work directories for old versions of recipes are now @@ -1847,7 +1847,7 @@ modifications synchronized, it is not always obvious to developers how to manipulate the Metadata as compared to the source. Metadata processing has now been removed from the -```kernel-yocto`` <#ref-classes-kernel-yocto>`__ class and the external +:ref:`kernel-yocto ` class and the external Metadata repository ``yocto-kernel-cache``, which has always been used to seed the ``linux-yocto`` "meta" branch. This separate ``linux-yocto`` cache repository is now the primary location for this data. Due to this @@ -1870,13 +1870,13 @@ The following QA checks have been added: - Added an "invalid-chars" check for invalid (non-UTF8) characters in recipe metadata variable values (i.e. - ```DESCRIPTION`` <#var-DESCRIPTION>`__, - ```SUMMARY`` <#var-SUMMARY>`__, ```LICENSE`` <#var-LICENSE>`__, and - ```SECTION`` <#var-SECTION>`__). Some package managers do not support + :term:`DESCRIPTION`, + :term:`SUMMARY`, :term:`LICENSE`, and + :term:`SECTION`). Some package managers do not support these characters. - Added an "invalid-packageconfig" check for any options specified in - ```PACKAGECONFIG`` <#var-PACKAGECONFIG>`__ that do not match any + :term:`PACKAGECONFIG` that do not match any ``PACKAGECONFIG`` option defined for the recipe. .. _migration-2.0-miscellaneous: @@ -1888,7 +1888,7 @@ These additional changes exist: - ``gtk-update-icon-cache`` has been renamed to ``gtk-icon-utils``. -- The ``tools-profile`` ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ +- The ``tools-profile`` :term:`IMAGE_FEATURES` item as well as its corresponding packagegroup and ``packagegroup-core-tools-profile`` no longer bring in ``oprofile``. Bringing in ``oprofile`` was originally added to aid compilation on @@ -1897,7 +1897,7 @@ These additional changes exist: powerful target platforms and the existence of better cross-compilation tools. -- The ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable's default +- The :term:`IMAGE_FSTYPES` variable's default value now specifies ``ext4`` instead of ``ext3``. - All support for the ``PRINC`` variable has been removed. @@ -1937,7 +1937,7 @@ The convention for overrides has always been for them to be lower-case characters. This practice is now a requirement as BitBake's datastore now assumes lower-case characters in order to give a slight performance boost during parsing. In practical terms, this requirement means that -anything that ends up in ```OVERRIDES`` <#var-OVERRIDES>`__ must now +anything that ends up in :term:`OVERRIDES` must now appear in lower-case characters (e.g. values for ``MACHINE``, ``TARGET_ARCH``, ``DISTRO``, and also recipe names if ``_pn-``\ recipename overrides are to be effective). @@ -1970,7 +1970,7 @@ layer to make this change: sed -e 's:\(\.getVar([^,()]*\)):\1, False):g' Makefile Environment Changes ---------------------------- -```EXTRA_OEMAKE`` <#var-EXTRA_OEMAKE>`__ now defaults to "" instead of +:term:`EXTRA_OEMAKE` now defaults to "" instead of "-e MAKEFLAGS=". Setting ``EXTRA_OEMAKE`` to "-e MAKEFLAGS=" by default was a historical accident that has required many classes (e.g. ``autotools``, ``module``) and recipes to override this default in order @@ -2007,14 +2007,14 @@ breaking FHS. ``ac_cv_sizeof_off_t`` is No Longer Cached in Site Files -------------------------------------------------------- -For recipes inheriting the ```autotools`` <#ref-classes-autotools>`__ +For recipes inheriting the :ref:`autotools ` class, ``ac_cv_sizeof_off_t`` is no longer cached in the site files for ``autoconf``. The reason for this change is because the ``ac_cv_sizeof_off_t`` value is not necessarily static per architecture as was previously assumed. Rather, the value changes based on whether large file support is enabled. For most software that uses ``autoconf``, this change should not be a problem. However, if you have a recipe that -bypasses the standard ```do_configure`` <#ref-tasks-configure>`__ task +bypasses the standard :ref:`ref-tasks-configure` task from the ``autotools`` class and the software the recipe is building uses a very old version of ``autoconf``, the recipe might be incapable of determining the correct size of ``off_t`` during ``do_configure``. @@ -2030,7 +2030,7 @@ implementation does get used. Image Generation is Now Split Out from Filesystem Generation ------------------------------------------------------------ -Previously, for image recipes the ```do_rootfs`` <#ref-tasks-rootfs>`__ +Previously, for image recipes the :ref:`ref-tasks-rootfs` task assembled the filesystem and then from that filesystem generated images. With this Yocto Project release, image generation is split into separate ```do_image_*`` <#ref-tasks-image>`__ tasks for clarity both in @@ -2047,7 +2047,7 @@ time. A minor part of this restructuring is that the post-processing definitions and functions have been moved from the -```image`` <#ref-classes-image>`__ class to the +:ref:`image ` class to the ```rootfs-postcommands`` <#ref-classes-rootfs*>`__ class. Functionally, however, they remain unchanged. @@ -2099,7 +2099,7 @@ Class Changes The following classes have changed: - ``autotools_stage``: Removed because the - ```autotools`` <#ref-classes-autotools>`__ class now provides its + :ref:`autotools ` class now provides its functionality. Recipes that inherited from ``autotools_stage`` should now inherit from ``autotools`` instead. @@ -2108,7 +2108,7 @@ The following classes have changed: this change should not cause any issues. - ``bootimg``: Merged into the - ```image-live`` <#ref-classes-image-live>`__ class. The ``bootimg`` + :ref:`image-live ` class. The ``bootimg`` class was rarely directly used. Consequently, this change should not cause any issues. @@ -2166,7 +2166,7 @@ The following changes have been made for the Poky distribution: not need to change anything unless you are relying on this naming elsewhere. -- The ```uninative`` <#ref-classes-uninative>`__ class is now enabled +- The :ref:`uninative ` class is now enabled by default in Poky. This class attempts to isolate the build system from the host distribution's C library and makes re-use of native shared state artifacts across different host distributions practical. @@ -2278,7 +2278,7 @@ These additional changes exist: - Previously, the following list of packages were removed if package-management was not in - ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__, regardless of any + :term:`IMAGE_FEATURES`, regardless of any dependencies: update-rc.d base-passwd shadow update-alternatives run-postinsts With the Yocto Project 2.1 release, these packages are only removed if "read-only-rootfs" is in ``IMAGE_FEATURES``, since @@ -2362,9 +2362,9 @@ Staging Directories in Sysroot Has Been Simplified -------------------------------------------------- The way directories are staged in sysroot has been simplified and -introduces the new ```SYSROOT_DIRS`` <#var-SYSROOT_DIRS>`__, -```SYSROOT_DIRS_NATIVE`` <#var-SYSROOT_DIRS_NATIVE>`__, and -```SYSROOT_DIRS_BLACKLIST`` <#var-SYSROOT_DIRS_BLACKLIST>`__. See the +introduces the new :term:`SYSROOT_DIRS`, +:term:`SYSROOT_DIRS_NATIVE`, and +:term:`SYSROOT_DIRS_BLACKLIST`. See the `v2 patch series on the OE-Core Mailing List `__ for additional information. @@ -2408,7 +2408,7 @@ Metadata Must Now Use Python 3 Syntax The metadata is now required to use Python 3 syntax. For help preparing metadata, see any of the many Python 3 porting guides available. Alternatively, you can reference the conversion commits for Bitbake and -you can use `OE-Core <#oe-core>`__ as a guide for changes. Following are +you can use :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes. Following are particular areas of interest: \* subprocess command-line pipes needing locale decoding \* the syntax for octal values changed \* the ``iter*()`` functions changed name \* iterators now return views, not @@ -2449,7 +2449,7 @@ compared to uClibc. ``${B}`` No Longer Default Working Directory for Tasks ------------------------------------------------------ -``${``\ ```B`` <#var-B>`__\ ``}`` is no longer the default working +``${``\ :term:`B`\ ``}`` is no longer the default working directory for tasks. Consequently, any custom tasks you define now need to either have the ``[``\ ```dirs`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` flag @@ -2479,7 +2479,7 @@ enables fine-grained tuning of options passed to QEMU without the ``runqemu`` script hard-coding any knowledge about different machines. Using a configuration file is particularly convenient when trying to use QEMU with machines other than the ``qemu*`` machines in -`OE-Core <#oe-core>`__. The ``qemuboot.conf`` file is generated by the +:term:`OpenEmbedded-Core (OE-Core)`. The ``qemuboot.conf`` file is generated by the ``qemuboot`` class when the root filesystem is being build (i.e. build rootfs). QEMU boot arguments can be set in BSP's configuration file and the ``qemuboot`` class will save them to ``qemuboot.conf``. @@ -2527,7 +2527,7 @@ socket,id=virtcon,port=@PORT@,host=127.0.0.1 -device virtconsole,chardev=virtcon" runqemu will replace "@PORT@" with the port number which is used. -To use ``runqemu``, set ```IMAGE_CLASSES`` <#var-IMAGE_CLASSES>`__ as +To use ``runqemu``, set :term:`IMAGE_CLASSES` as follows and run ``runqemu``: .. note:: @@ -2545,7 +2545,7 @@ Default Linker Hash Style Changed The default linker hash style for ``gcc-cross`` is now "sysv" in order to catch recipes that are building software without using the -OpenEmbedded ```LDFLAGS`` <#var-LDFLAGS>`__. This change could result in +OpenEmbedded :term:`LDFLAGS`. This change could result in seeing some "No GNU_HASH in the elf binary" QA issues when building such recipes. You need to fix these recipes so that they use the expected ``LDFLAGS``. Depending on how the software is built, the build system @@ -2559,7 +2559,7 @@ to the recipe: TARGET_CC_ARCH += "${LDFLAGS}" -------------------------------------------------------------- The ``KERNEL_IMAGE_BASE_NAME`` variable no longer uses the -```KERNEL_IMAGETYPE`` <#var-KERNEL_IMAGETYPE>`__ variable to create the +:term:`KERNEL_IMAGETYPE` variable to create the image's base name. Because the OpenEmbedded build system can now build multiple kernel image types, this part of the kernel image base name as been removed leaving only the following: KERNEL_IMAGE_BASE_NAME ?= @@ -2577,11 +2577,11 @@ The following changes took place for BitBake: - The "goggle" UI and standalone image-writer tool have been removed as they both require GTK+ 2.0 and were not being maintained. -- The Perforce fetcher now supports ```SRCREV`` <#var-SRCREV>`__ for +- The Perforce fetcher now supports :term:`SRCREV` for specifying the source revision to use, be it - ``${``\ ```AUTOREV`` <#var-AUTOREV>`__\ ``}``, changelist number, + ``${``\ :term:`AUTOREV`\ ``}``, changelist number, p4date, or label, in preference to separate - ```SRC_URI`` <#var-SRC_URI>`__ parameters to specify these. This + :term:`SRC_URI` parameters to specify these. This change is more in-line with how the other fetchers work for source control systems. Recipes that fetch from Perforce will need to be updated to use ``SRCREV`` in place of specifying the source revision @@ -2687,8 +2687,8 @@ The following classes have been removed: - ``distutils3-native-base``: No longer needed. -- ``sdl``: Only set ```DEPENDS`` <#var-DEPENDS>`__ and - ```SECTION`` <#var-SECTION>`__, which are better set within the +- ``sdl``: Only set :term:`DEPENDS` and + :term:`SECTION`, which are better set within the recipe instead. - ``sip``: Mostly unused. @@ -2723,9 +2723,9 @@ The following miscellaneous changes have occurred: respective recipes. - Both ``devtool add`` and ``recipetool create`` now use a fixed - ```SRCREV`` <#var-SRCREV>`__ by default when fetching from a Git + :term:`SRCREV` by default when fetching from a Git repository. You can override this in either case to use - ``${``\ ```AUTOREV`` <#var-AUTOREV>`__\ ``}`` instead by using the + ``${``\ :term:`AUTOREV`\ ``}`` instead by using the ``-a`` or ``DASHDASHautorev`` command-line option - ``distcc``: GTK+ UI is now disabled by default. @@ -2776,14 +2776,14 @@ Consider the following: - *Specify Pre-Installation and Post-Installation Native Tool Dependencies:* You must specifically specify any special native tool dependencies of ``pkg_preinst`` and ``pkg_postinst`` scripts by using - the ```PACKAGE_WRITE_DEPS`` <#var-PACKAGE_WRITE_DEPS>`__ variable. + the :term:`PACKAGE_WRITE_DEPS` variable. Specifying these dependencies ensures that these tools are available if these scripts need to be run on the build host during the - ```do_rootfs`` <#ref-tasks-rootfs>`__ task. + :ref:`ref-tasks-rootfs` task. As an example, see the ``dbus`` recipe. You will see that this recipe has a ``pkg_postinst`` that calls ``systemctl`` if "systemd" is in - ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__. In the example, + :term:`DISTRO_FEATURES`. In the example, ``systemd-systemctl-native`` is added to ``PACKAGE_WRITE_DEPS``, which is also conditional on "systemd" being in ``DISTRO_FEATURES``. @@ -2797,7 +2797,7 @@ Consider the following: functions being called through ``SSTATEPOSTINSTFUNCS`` are doing relocation, then you will need to change these to use a post-installation script that is installed by a function added to - ```SYSROOT_PREPROCESS_FUNCS`` <#var-SYSROOT_PREPROCESS_FUNCS>`__. + :term:`SYSROOT_PREPROCESS_FUNCS`. For an example, see the ``pixbufcache`` class in ``meta/classes/`` in the Yocto Project `Source @@ -2821,7 +2821,7 @@ Consider the following: the shared sysroot is now gone, the scripts ``oe-find-native-sysroot`` and ``oe-run-native`` have been changed such that you need to specify which recipe's - ```STAGING_DIR_NATIVE`` <#var-STAGING_DIR_NATIVE>`__ is used. + :term:`STAGING_DIR_NATIVE` is used. .. note:: @@ -2839,8 +2839,8 @@ Within the environment used to run build tasks, the environment variable ``PATH`` is now sanitized such that the normal native binary paths (``/bin``, ``/sbin``, ``/usr/bin`` and so forth) are removed and a directory containing symbolic links linking only to the binaries from -the host mentioned in the ```HOSTTOOLS`` <#var-HOSTTOOLS>`__ and -```HOSTTOOLS_NONFATAL`` <#var-HOSTTOOLS_NONFATAL>`__ variables is added +the host mentioned in the :term:`HOSTTOOLS` and +:term:`HOSTTOOLS_NONFATAL` variables is added to ``PATH``. Consequently, any native binaries provided by the host that you need to @@ -2848,7 +2848,7 @@ call needs to be in one of these two variables at the configuration level. Alternatively, you can add a native recipe (i.e. ``-native``) that -provides the binary to the recipe's ```DEPENDS`` <#var-DEPENDS>`__ +provides the binary to the recipe's :term:`DEPENDS` value. .. note:: @@ -2881,7 +2881,7 @@ The following changes to scripts took place: - *``cleanup-workdir``:* The ``cleanup-workdir`` script has been removed because the script was found to be deleting files it should not have, which lead to broken build trees. Rather than trying to - delete portions of ```TMPDIR`` <#var-TMPDIR>`__ and getting it wrong, + delete portions of :term:`TMPDIR` and getting it wrong, it is recommended that you delete ``TMPDIR`` and have it restored from shared state (sstate) on subsequent builds. @@ -2927,8 +2927,8 @@ The following changes took place for BitBake: between recipes, which could be misleading. - *Mirror Variable Splitting Changes:* Mirror variables including - ```MIRRORS`` <#var-MIRRORS>`__, ```PREMIRRORS`` <#var-PREMIRRORS>`__, - and ```SSTATE_MIRRORS`` <#var-SSTATE_MIRRORS>`__ can now separate + :term:`MIRRORS`, :term:`PREMIRRORS`, + and :term:`SSTATE_MIRRORS` can now separate values entirely with spaces. Consequently, you no longer need "\\n". BitBake looks for pairs of values, which simplifies usage. There should be no change required to existing mirror variable values @@ -2940,7 +2940,7 @@ The following changes took place for BitBake: when the "protocol" parameter is set to "svn+ssh". You can only use the new parameter to specify the ``ssh`` program used by SVN. The SVN fetcher passes the new parameter through the ``SVN_SSH`` environment - variable during the ```do_fetch`` <#ref-tasks-fetch>`__ task. + variable during the :ref:`ref-tasks-fetch` task. See the "`Subversion (SVN) Fetcher (svn://) <&YOCTO_DOCS_BB_URL;#svn-fetcher>`__" section in the BitBake @@ -2974,8 +2974,8 @@ GPLv2 Versions of GPLv3 Recipes Moved Older GPLv2 versions of GPLv3 recipes have moved to a separate ``meta-gplv2`` layer. -If you use ```INCOMPATIBLE_LICENSE`` <#var-INCOMPATIBLE_LICENSE>`__ to -exclude GPLv3 or set ```PREFERRED_VERSION`` <#var-PREFERRED_VERSION>`__ +If you use :term:`INCOMPATIBLE_LICENSE` to +exclude GPLv3 or set :term:`PREFERRED_VERSION` to substitute a GPLv2 version of a GPLv3 recipe, then you must add the ``meta-gplv2`` layer to your configuration. @@ -3052,7 +3052,7 @@ The following package management changes took place: This change was made because too many places in DNF/RPM4 stack already make that assumption. Only the filenames and the architecture tag has changed. Nothing else has changed in OE-core system, - particularly in the ```allarch.bbclass`` <#ref-classes-allarch>`__ + particularly in the :ref:`allarch.bbclass ` class. - Signing of remote package feeds using ``PACKAGE_FEED_SIGN`` is not @@ -3100,7 +3100,7 @@ The following recipes have been removed: - *``tremor:``* Moved to ``meta-multimedia``. Fixed-integer Vorbis decoding is not needed by current hardware. Thus, GStreamer's ivorbis plugin has been disabled by default eliminating the need for the - ``tremor`` recipe in `OE-Core <#oe-core>`__. + ``tremor`` recipe in :term:`OpenEmbedded-Core (OE-Core)`. - *``gummiboot:``* Replaced by ``systemd-boot``. @@ -3151,7 +3151,7 @@ The following QA checks have changed: warning, you need to address missing runtime dependencies. For additional information, see the - ```insane`` <#ref-classes-insane>`__ class and the "`Errors and + :ref:`insane ` class and the "`Errors and Warnings <#qa-errors-and-warnings>`__" section. .. _migration-2.3-miscellaneous-changes: @@ -3162,7 +3162,7 @@ Miscellaneous Changes The following miscellaneous changes have occurred: - In this release, a number of recipes have been changed to ignore the - ``largefile`` ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ item, + ``largefile`` :term:`DISTRO_FEATURES` item, enabling large file support unconditionally. This feature has always been enabled by default. Disabling the feature has not been widely tested. @@ -3174,8 +3174,8 @@ The following miscellaneous changes have occurred: largefile feature, which would make it unconditionally enabled everywhere. -- If the ```DISTRO_VERSION`` <#var-DISTRO_VERSION>`__ value contains - the value of the ```DATE`` <#var-DATE>`__ variable, which is the +- If the :term:`DISTRO_VERSION` value contains + the value of the :term:`DATE` variable, which is the default between Poky releases, the ``DATE`` value is explicitly excluded from ``/etc/issue`` and ``/etc/issue.net``, which is displayed at the login prompt, in order to avoid conflicts with @@ -3186,7 +3186,7 @@ The following miscellaneous changes have occurred: If you need the build date recorded in ``/etc/issue*`` or anywhere else in your image, a better method is to define a post-processing function to do it and have the function called from - ```ROOTFS_POSTPROCESS_COMMAND`` <#var-ROOTFS_POSTPROCESS_COMMAND>`__. + :term:`ROOTFS_POSTPROCESS_COMMAND`. Doing so ensures the value is always up-to-date with the created image. @@ -3195,7 +3195,7 @@ The following miscellaneous changes have occurred: RSA keys only, and with recent versions of OpenSSH, which deprecates DSA host keys. -- The ```buildhistory`` <#ref-classes-buildhistory>`__ class now +- The :ref:`buildhistory ` class now correctly uses tabs as separators between all columns in ``installed-package-sizes.txt`` in order to aid import into other tools. @@ -3206,7 +3206,7 @@ The following miscellaneous changes have occurred: DISTRO_FEATURES_BACKFILL_CONSIDERED_append = " ldconfig" - The default value of - ```COPYLEFT_LICENSE_INCLUDE`` <#var-COPYLEFT_LICENSE_INCLUDE>`__ now + :term:`COPYLEFT_LICENSE_INCLUDE` now includes all versions of AGPL licenses in addition to GPL and LGPL. .. note:: @@ -3227,14 +3227,14 @@ The following miscellaneous changes have occurred: If you need to preserve these ``.la`` files (e.g. in a custom distribution), you must change - ```INHERIT_DISTRO`` <#var-INHERIT_DISTRO>`__ such that + :term:`INHERIT_DISTRO` such that "remove-libtool" is not included in the value. - Extensible SDKs built for GCC 5+ now refuse to install on a distribution where the host GCC version is 4.8 or 4.9. This change resulted from the fact that the installation is known to fail due to the way the ``uninative`` shared state (sstate) package is built. See - the ```uninative`` <#ref-classes-uninative>`__ class for additional + the :ref:`uninative ` class for additional information. - All native and nativesdk recipes now use a separate @@ -3242,18 +3242,18 @@ The following miscellaneous changes have occurred: recipes for the target, in order to avoid unnecessary rebuilds. The ``DISTRO_FEATURES`` for ``native`` recipes is - ```DISTRO_FEATURES_NATIVE`` <#var-DISTRO_FEATURES_NATIVE>`__ added to + :term:`DISTRO_FEATURES_NATIVE` added to an intersection of ``DISTRO_FEATURES`` and - ```DISTRO_FEATURES_FILTER_NATIVE`` <#var-DISTRO_FEATURES_FILTER_NATIVE>`__. + :term:`DISTRO_FEATURES_FILTER_NATIVE`. For nativesdk recipes, the corresponding variables are - ```DISTRO_FEATURES_NATIVESDK`` <#var-DISTRO_FEATURES_NATIVESDK>`__ + :term:`DISTRO_FEATURES_NATIVESDK` and - ```DISTRO_FEATURES_FILTER_NATIVESDK`` <#var-DISTRO_FEATURES_FILTER_NATIVESDK>`__. + :term:`DISTRO_FEATURES_FILTER_NATIVESDK`. - The ``FILESDIR`` variable, which was previously deprecated and rarely used, has now been removed. You should change any recipes that set - ``FILESDIR`` to set ```FILESPATH`` <#var-FILESPATH>`__ instead. + ``FILESDIR`` to set :term:`FILESPATH` instead. - The ``MULTIMACH_HOST_SYS`` variable has been removed as it is no longer needed with recipe-specific sysroots. @@ -3272,7 +3272,7 @@ Memory Resident Mode A persistent mode is now available in BitBake's default operation, replacing its previous "memory resident mode" (i.e. ``oe-init-build-env-memres``). Now you only need to set -```BB_SERVER_TIMEOUT`` <#var-BB_SERVER_TIMEOUT>`__ to a timeout (in +:term:`BB_SERVER_TIMEOUT` to a timeout (in seconds) and BitBake's server stays resident for that amount of time between invocations. The ``oe-init-build-env-memres`` script has been removed since a separate environment setup script is no longer needed. @@ -3306,11 +3306,11 @@ occurred: - The ``su`` program is now packaged in a separate "util-linux-su" package, which is only built when "pam" is listed in the - ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ variable. + :term:`DISTRO_FEATURES` variable. ``util-linux`` should not be installed unless it is needed because ``su`` is normally provided through the shadow file format. The main ``util-linux`` package has runtime dependencies (i.e. - ```RDEPENDS`` <#var-RDEPENDS>`__) on the ``util-linux-su`` package + :term:`RDEPENDS`) on the ``util-linux-su`` package when "pam" is in ``DISTRO_FEATURES``. - The ``switch_root`` program is now packaged in a separate @@ -3318,7 +3318,7 @@ occurred: do not need the whole ``util-linux`` package or the busybox binary, which are both much larger than ``switch_root``. The main ``util-linux`` package has a recommended runtime dependency (i.e. - ```RRECOMMENDS`` <#var-RRECOMMENDS>`__) on the + :term:`RRECOMMENDS`) on the ``util-linux-switch-root`` package. - The ``ionice`` program is now packaged in a separate @@ -3338,7 +3338,7 @@ occurred: runtime dependency (i.e. ``RRECOMMENDS``) on the ``shared-mime-info`` package, since large portions of GIO are not useful without the MIME database. You can remove the dependency by using the - ```BAD_RECOMMENDATIONS`` <#var-BAD_RECOMMENDATIONS>`__ variable if + :term:`BAD_RECOMMENDATIONS` variable if ``shared-mime-info`` is too large and is not required. - *Go Standard Runtime:* The Go standard runtime has been split out @@ -3456,10 +3456,10 @@ Kernel Device Tree Move Kernel Device Tree support is now easier to enable in a kernel recipe. The Device Tree code has moved to a -```kernel-devicetree`` <#ref-classes-kernel-devicetree>`__ class. +:ref:`kernel-devicetree ` class. Functionality is automatically enabled for any recipe that inherits the -```kernel`` <#ref-classes-kernel>`__ class and sets the -```KERNEL_DEVICETREE`` <#var-KERNEL_DEVICETREE>`__ variable. The +:ref:`kernel ` class and sets the +:term:`KERNEL_DEVICETREE` variable. The previous mechanism for doing this, ``meta/recipes-kernel/linux/linux-dtb.inc``, is still available to avoid breakage, but triggers a deprecation warning. Future releases of the @@ -3478,7 +3478,7 @@ The following package QA changes took place: - The "unsafe-references-in-scripts" QA check has been removed. - If you refer to ``${COREBASE}/LICENSE`` within - ```LIC_FILES_CHKSUM`` <#var-LIC_FILES_CHKSUM>`__ you receive a + :term:`LIC_FILES_CHKSUM` you receive a warning because this file is a description of the license for OE-Core. Use ``${COMMON_LICENSE_DIR}/MIT`` if your recipe is MIT-licensed and you cannot use the preferred method of referring to @@ -3529,10 +3529,10 @@ The following are additional changes: from ``meta-poky`` to OE-Core (i.e. from ``meta-poky/conf/distro/include`` to ``meta/conf/distro/include``). -- The ```buildhistory`` <#ref-classes-buildhistory>`__ class now makes +- The :ref:`buildhistory ` class now makes a single commit per build rather than one commit per subdirectory in the repository. This behavior assumes the commits are enabled with - ```BUILDHISTORY_COMMIT`` <#var-BUILDHISTORY_COMMIT>`__ = "1", which + :term:`BUILDHISTORY_COMMIT` = "1", which is typical. Previously, the ``buildhistory`` class made one commit per subdirectory in the repository in order to make it easier to see the changes for a particular subdirectory. To view a particular @@ -3540,7 +3540,7 @@ The following are additional changes: ``git show`` or ``git diff`` commands. - The ``x86-base.inc`` file, which is included by all x86-based machine - configurations, now sets ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ + configurations, now sets :term:`IMAGE_FSTYPES` using ``?=`` to "live" rather than appending with ``+=``. This change makes the default easier to override. @@ -3550,7 +3550,7 @@ The following are additional changes: Manual. - By default, the ``security_flags.inc`` file sets a - ```GCCPIE`` <#var-GCCPIE>`__ variable with an option to enable + :term:`GCCPIE` variable with an option to enable Position Independent Executables (PIE) within ``gcc``. Enabling PIE in the GNU C Compiler (GCC), makes Return Oriented Programming (ROP) attacks much more difficult to execute. @@ -3570,12 +3570,12 @@ The following are additional changes: you need to update them. - OpenSSL 1.1 has been introduced. However, the default is still 1.0.x - through the ```PREFERRED_VERSION`` <#var-PREFERRED_VERSION>`__ + through the :term:`PREFERRED_VERSION` variable. This preference is set is due to the remaining compatibility issues with other software. The - ```PROVIDES`` <#var-PROVIDES>`__ variable in the openssl 1.0 recipe + :term:`PROVIDES` variable in the openssl 1.0 recipe now includes "openssl10" as a marker that can be used in - ```DEPENDS`` <#var-DEPENDS>`__ within recipes that build software + :term:`DEPENDS` within recipes that build software that still depend on OpenSSL 1.0. - To ensure consistent behavior, BitBake's "-r" and "-R" options (i.e. @@ -3747,7 +3747,7 @@ One particular change to note is that the Python recipes no longer have build-time provides for their packages. This assumes ``python-foo`` is one of the packages provided by the Python recipe. You can no longer run ``bitbake python-foo`` or have a -```DEPENDS`` <&YOCTO_DOCS_REF_URL;#var-DEPENDS>`__ on ``python-foo``, +:term:`DEPENDS` on ``python-foo``, but doing either of the following causes the package to work as expected: IMAGE_INSTALL_append = " python-foo" or RDEPENDS_${PN} = "python-foo" The earlier build-time provides behavior was a quirk of the @@ -3787,7 +3787,7 @@ The following are additional changes: ``sysklogd`` recipe no longer uses ``update-alternatives`` because it is incompatible with other implementations. -- By default, the ```cmake`` <#ref-classes-cmake>`__ class uses +- By default, the :ref:`cmake ` class uses ``ninja`` instead of ``make`` for building. This improves build performance. If a recipe is broken with ``ninja``, then the recipe can set ``OECMAKE_GENERATOR = "Unix Makefiles"`` to change back to @@ -3878,7 +3878,7 @@ release, see ` `__. If you still need to compile with version 7.x, GCC 7.3 is also provided. You can select this version by setting the and can be selected by -setting the ```GCCVERSION`` <#var-GCCVERSION>`__ variable to "7.%" in +setting the :term:`GCCVERSION` variable to "7.%" in your configuration. .. _migration-2.6-removed-recipes: @@ -3972,12 +3972,12 @@ For names of recipes removed because of this repository change, see the --------------------------------------------------------------------------------------------------- Previously, it was possible for Python recipes that inherited the -```distutils`` <#ref-classes-distutils>`__ and +:ref:`distutils ` and ```distutils3`` <#ref-classes-distutils3>`__ classes to fetch code -during the ```do_configure`` <#ref-tasks-configure>`__ task to satisfy +during the :ref:`ref-tasks-configure` task to satisfy dependencies mentioned in ``setup.py`` if those dependencies were not provided in the sysroot (i.e. recipes providing the dependencies were -missing from ```DEPENDS`` <#var-DEPENDS>`__). +missing from :term:`DEPENDS`). .. note:: @@ -4018,9 +4018,9 @@ Image/Kernel Artifact Naming Changes The following changes have been made: -- Name variables (e.g. ```IMAGE_NAME`` <#var-IMAGE_NAME>`__) use a new +- Name variables (e.g. :term:`IMAGE_NAME`) use a new ``IMAGE_VERSION_SUFFIX`` variable instead of - ```DATETIME`` <#var-DATETIME>`__. Using ``IMAGE_VERSION_SUFFIX`` + :term:`DATETIME`. Using ``IMAGE_VERSION_SUFFIX`` allows easier and more direct changes. The ``IMAGE_VERSION_SUFFIX`` variable is set in the ``bitbake.conf`` @@ -4029,40 +4029,40 @@ The following changes have been made: - Several variables have changed names for consistency: Old Variable Name New Variable Name ======================================================== - KERNEL_IMAGE_BASE_NAME `KERNEL_IMAGE_NAME <#var-KERNEL_IMAGE_NAME>`__ + KERNEL_IMAGE_BASE_NAME :term:`KERNEL_IMAGE_NAME` KERNEL_IMAGE_SYMLINK_NAME - `KERNEL_IMAGE_LINK_NAME <#var-KERNEL_IMAGE_LINK_NAME>`__ + :term:`KERNEL_IMAGE_LINK_NAME` MODULE_TARBALL_BASE_NAME - `MODULE_TARBALL_NAME <#var-MODULE_TARBALL_NAME>`__ + :term:`MODULE_TARBALL_NAME` MODULE_TARBALL_SYMLINK_NAME - `MODULE_TARBALL_LINK_NAME <#var-MODULE_TARBALL_LINK_NAME>`__ - INITRAMFS_BASE_NAME `INITRAMFS_NAME <#var-INITRAMFS_NAME>`__ + :term:`MODULE_TARBALL_LINK_NAME` + INITRAMFS_BASE_NAME :term:`INITRAMFS_NAME` - The ``MODULE_IMAGE_BASE_NAME`` variable has been removed. The module tarball name is now controlled directly with the - ```MODULE_TARBALL_NAME`` <#var-MODULE_TARBALL_NAME>`__ variable. + :term:`MODULE_TARBALL_NAME` variable. -- The ```KERNEL_DTB_NAME`` <#var-KERNEL_DTB_NAME>`__ and - ```KERNEL_DTB_LINK_NAME`` <#var-KERNEL_DTB_LINK_NAME>`__ variables +- The :term:`KERNEL_DTB_NAME` and + :term:`KERNEL_DTB_LINK_NAME` variables have been introduced to control kernel Device Tree Binary (DTB) artifact names instead of mangling ``KERNEL_IMAGE_*`` variables. -- The ```KERNEL_FIT_NAME`` <#var-KERNEL_FIT_NAME>`__ and - ```KERNEL_FIT_LINK_NAME`` <#var-KERNEL_FIT_LINK_NAME>`__ variables +- The :term:`KERNEL_FIT_NAME` and + :term:`KERNEL_FIT_LINK_NAME` variables have been introduced to specify the name of flattened image tree (FIT) kernel images similar to other deployed artifacts. -- The ```MODULE_TARBALL_NAME`` <#var-MODULE_TARBALL_NAME>`__ and - ```MODULE_TARBALL_LINK_NAME`` <#var-MODULE_TARBALL_LINK_NAME>`__ +- The :term:`MODULE_TARBALL_NAME` and + :term:`MODULE_TARBALL_LINK_NAME` variable values no longer include the "module-" prefix or ".tgz" suffix. These parts are now hardcoded so that the values are consistent with other artifact naming variables. -- Added the ```INITRAMFS_LINK_NAME`` <#var-INITRAMFS_LINK_NAME>`__ +- Added the :term:`INITRAMFS_LINK_NAME` variable so that the symlink can be controlled similarly to other artifact types. -- ```INITRAMFS_NAME`` <#var-INITRAMFS_NAME>`__ now uses +- :term:`INITRAMFS_NAME` now uses "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" instead of "${PV}-${PR}-${MACHINE}-${DATETIME}", which makes it consistent with other variables. @@ -4072,9 +4072,9 @@ The following changes have been made: ``SERIAL_CONSOLE`` Deprecated ----------------------------- -The ```SERIAL_CONSOLE`` <#var-SERIAL_CONSOLE>`__ variable has been +The :term:`SERIAL_CONSOLE` variable has been functionally replaced by the -```SERIAL_CONSOLES`` <#var-SERIAL_CONSOLES>`__ variable for some time. +:term:`SERIAL_CONSOLES` variable for some time. With the Yocto Project 2.6 release, ``SERIAL_CONSOLE`` has been officially deprecated. @@ -4122,7 +4122,7 @@ The following changes have occurred: - *The ``forcevariable`` Override Now Has a Higher Priority Than ``libc`` Overrides:* The ``forcevariable`` override is documented to be the highest priority override. However, due to a long-standing - quirk of how ```OVERRIDES`` <#var-OVERRIDES>`__ is set, the ``libc`` + quirk of how :term:`OVERRIDES` is set, the ``libc`` overrides (e.g. ``libc-glibc``, ``libc-musl``, and so forth) erroneously had a higher priority. This issue is now corrected. @@ -4177,14 +4177,14 @@ This section provides information about automatic testing changes: ``TEST_IMAGE`` variable to "1" to enable automatic testing for successfully built images. The ``TEST_IMAGE`` variable no longer exists and has been replaced by the - ```TESTIMAGE_AUTO`` <#var-TESTIMAGE_AUTO>`__ variable. + :term:`TESTIMAGE_AUTO` variable. - *Inheriting the ``testimage`` and ``testsdk`` Classes:* Best practices now dictate that you use the - ```IMAGE_CLASSES`` <#var-IMAGE_CLASSES>`__ variable rather than the - ```INHERIT`` <#var-INHERIT>`__ variable when you inherit the + :term:`IMAGE_CLASSES` variable rather than the + :term:`INHERIT` variable when you inherit the ```testimage`` <#ref-classes-testimage*>`__ and - ```testsdk`` <#ref-classes-testsdk>`__ classes used for automatic + :ref:`testsdk ` classes used for automatic testing. .. _migration-2.6-openssl-changes: @@ -4207,7 +4207,7 @@ BitBake Changes --------------- The server logfile ``bitbake-cookerdaemon.log`` is now always placed in -the `Build Directory <#build-directory>`__ instead of the current +the :term:`Build Directory` instead of the current directory. .. _migration-2.6-security-changes: @@ -4229,7 +4229,7 @@ want to explicitly defer a postinstall to first boot on the target rather than at rootfs creation time, use ``pkg_postinst_ontarget()`` or call ``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``. Any failure of a ``pkg_postinst()`` script (including exit 1) triggers -an error during the ```do_rootfs`` <#ref-tasks-rootfs>`__ task. +an error during the :ref:`ref-tasks-rootfs` task. For more information on post-installation behavior, see the "`Post-Installation @@ -4245,14 +4245,14 @@ The ``python3`` recipe now enables profile-guided optimization. Using this optimization requires a little extra build time in exchange for improved performance on the target at runtime. Additionally, the optimization is only enabled if the current -```MACHINE`` <#var-MACHINE>`__ has support for user-mode emulation in +:term:`MACHINE` has support for user-mode emulation in QEMU (i.e. "qemu-usermode" is in -```MACHINE_FEATURES`` <#var-MACHINE_FEATURES>`__, which it is by +:term:`MACHINE_FEATURES`, which it is by default). If you wish to disable Python profile-guided optimization regardless of the value of ``MACHINE_FEATURES``, then ensure that -```PACKAGECONFIG`` <#var-PACKAGECONFIG>`__ for the ``python3`` recipe +:term:`PACKAGECONFIG` for the ``python3`` recipe does not contain "pgo". You could accomplish the latter using the following at the configuration level: PACKAGECONFIG_remove_pn-python3 = "pgo" Alternatively, you can set ``PACKAGECONFIG`` using an append file @@ -4276,13 +4276,13 @@ The following miscellaneous changes occurred: - The ``NOISO`` and ``NOHDD`` variables are no longer used. You now control building ``*.iso`` and ``*.hddimg`` image types directly by - using the ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable. + using the :term:`IMAGE_FSTYPES` variable. - The ``scripts/contrib/mkefidisk.sh`` has been removed in favor of Wic. - ``kernel-modules`` has been removed from - ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ for ``qemumips`` and + :term:`RRECOMMENDS` for ``qemumips`` and ``qemumips64`` machines. Removal also impacts the ``x86-base.inc`` file. @@ -4302,7 +4302,7 @@ The following miscellaneous changes occurred: the ``WHITELIST_GPL-3.0`` variable instead. - ``${ASNEEDED}`` is now included in the - ```TARGET_LDFLAGS`` <#var-TARGET_LDFLAGS>`__ variable directly. The + :term:`TARGET_LDFLAGS` variable directly. The remaining definitions from ``meta/conf/distro/include/as-needed.inc`` have been moved to corresponding recipes. @@ -4332,7 +4332,7 @@ The following changes have been made to BitBake: indentation. If found, BitBake produces a warning. - Bitbake now checks - ```BBFILE_COLLECTIONS`` <#var-BBFILE_COLLECTIONS>`__ for duplicate + :term:`BBFILE_COLLECTIONS` for duplicate entries and triggers an error if any are found. .. _migration-2.7-eclipse-support-dropped: @@ -4386,7 +4386,7 @@ License Value Corrections ------------------------- The following corrections have been made to the -```LICENSE`` <#var-LICENSE>`__ values set by recipes: *socat*: Corrected +:term:`LICENSE` values set by recipes: *socat*: Corrected ``LICENSE`` to be "GPLv2" rather than "GPLv2+". *libgfortran*: Set license to "GPL-3.0-with-GCC-exception". *elfutils*: Removed "Elfutils-Exception" and set to "GPLv2" for shared libraries @@ -4404,11 +4404,11 @@ This section provides information about packaging changes. - Debug split: The default debug split has been changed to create separate source packages (i.e. package_name\ ``-dbg`` and package_name\ ``-src``). If you are currently using ``dbg-pkgs`` in - ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ to bring in debug + :term:`IMAGE_FEATURES` to bring in debug symbols and you still need the sources, you must now also add ``src-pkgs`` to ``IMAGE_FEATURES``. Source packages remain in the target portion of the SDK by default, unless you have set your own - value for ```SDKIMAGE_FEATURES`` <#var-SDKIMAGE_FEATURES>`__ that + value for :term:`SDKIMAGE_FEATURES` that does not include ``src-pkgs``. - Mount all using ``util-linux``: ``/etc/default/mountall`` has moved @@ -4417,10 +4417,10 @@ This section provides information about packaging changes. - Splitting binaries using ``util-linux``: ``util-linux`` now splits each binary into its own package for fine-grained control. The main ``util-linux`` package pulls in the individual binary packages using - the ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ and - ```RDEPENDS`` <#var-RDEPENDS>`__ variables. As a result, existing + the :term:`RRECOMMENDS` and + :term:`RDEPENDS` variables. As a result, existing images should not see any changes assuming - ```NO_RECOMMENDATIONS`` <#var-NO_RECOMMENDATIONS>`__ is not set. + :term:`NO_RECOMMENDATIONS` is not set. - ``netbase/base-files``: ``/etc/hosts`` has moved from ``netbase`` to ``base-files``. @@ -4480,13 +4480,13 @@ The following miscellaneous changes occurred: - ``arm-tunes``: Removed the "-march" option if mcpu is already added. - ``update-alternatives``: Convert file renames to - ```PACKAGE_PREPROCESS_FUNCS`` <#var-PACKAGE_PREPROCESS_FUNCS>`__ + :term:`PACKAGE_PREPROCESS_FUNCS` - ``base/pixbufcache``: Obsolete ``sstatecompletions`` code has been removed. -- ```native`` <#ref-classes-native>`__ class: - ```RDEPENDS`` <#var-RDEPENDS>`__ handling has been enabled. +- :ref:`native ` class: + :term:`RDEPENDS` handling has been enabled. - ``inetutils``: This recipe has rsh disabled. @@ -4707,7 +4707,7 @@ Sanity Checks The following sanity check changes occurred. -- ```SRC_URI`` <#var-SRC_URI>`__ is now checked for usage of two +- :term:`SRC_URI` is now checked for usage of two problematic items: - "${PN}" prefix/suffix use - Warnings always appear if ${PN} is @@ -4722,10 +4722,10 @@ The following sanity check changes occurred. Either one of these items now trigger a warning by default. If you wish to disable this check, remove ``src-uri-bad`` from - ```WARN_QA`` <#var-WARN_QA>`__. + :term:`WARN_QA`. - The ``file-rdeps`` runtime dependency check no longer expands - ```RDEPENDS`` <#var-RDEPENDS>`__ recursively as there is no mechanism + :term:`RDEPENDS` recursively as there is no mechanism to ensure they can be fully computed, and thus races sometimes result in errors either showing up or not. Thus, you might now see errors for missing runtime dependencies that were previously satisfied @@ -4736,7 +4736,7 @@ The following sanity check changes occurred. - Setting ``DEPENDS_${PN}`` anywhere (i.e. typically in a recipe) now triggers an error. The error is triggered because - ```DEPENDS`` <#var-DEPENDS>`__ is not a package-specific variable + :term:`DEPENDS` is not a package-specific variable unlike RDEPENDS. You should set ``DEPENDS`` instead. - systemd currently does not work well with the musl C library because @@ -4757,14 +4757,14 @@ The following miscellaneous changes have occurred. - The ``meta/recipes-kernel/linux/linux-dtb.inc`` file has been removed. This file was previously deprecated in favor of setting - ```KERNEL_DEVICETREE`` <#var-KERNEL_DEVICETREE>`__ in any kernel + :term:`KERNEL_DEVICETREE` in any kernel recipe and only produced a warning. Remove any ``include`` or ``require`` statements pointing to this file. -- ```TARGET_CFLAGS`` <#var-TARGET_CFLAGS>`__, - ```TARGET_CPPFLAGS`` <#var-TARGET_CPPFLAGS>`__, - ```TARGET_CXXFLAGS`` <#var-TARGET_CXXFLAGS>`__, and - ```TARGET_LDFLAGS`` <#var-TARGET_LDFLAGS>`__ are no longer exported +- :term:`TARGET_CFLAGS`, + :term:`TARGET_CPPFLAGS`, + :term:`TARGET_CXXFLAGS`, and + :term:`TARGET_LDFLAGS` are no longer exported to the external environment. This change did not require any changes to core recipes, which is a good indicator that no changes will be required. However, if for some reason the software being built by one @@ -4774,14 +4774,14 @@ The following miscellaneous changes have occurred. exporting is not necessary. - You must change the host distro identifier used in - ```NATIVELSBSTRING`` <#var-NATIVELSBSTRING>`__ to use all lowercase + :term:`NATIVELSBSTRING` to use all lowercase characters even if it does not contain a version number. This change is necessary only if you are not using ``uninative`` and - ```SANITY_TESTED_DISTROS`` <#var-SANITY_TESTED_DISTROS>`__. + :term:`SANITY_TESTED_DISTROS`. - In the ``base-files`` recipe, writing the hostname into ``/etc/hosts`` and ``/etc/hostname`` is now done within the main - ```do_install`` <#ref-tasks-install>`__ function rather than in the + :ref:`ref-tasks-install` function rather than in the ``do_install_basefilesissue`` function. The reason for the change is because ``do_install_basefilesissue`` is more easily overridden without having to duplicate the hostname functionality. If you have @@ -4882,7 +4882,7 @@ significant increase in the number of components that will be built just when building a simple image such as core-image-minimal. If you do not need runtime tests enabled for core components, then it is recommended that you remove "ptest" from -```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ to save a significant +:term:`DISTRO_FEATURES` to save a significant amount of build time e.g. by adding the following in your configuration: DISTRO_FEATURES_remove = "ptest" @@ -4966,7 +4966,7 @@ SRC_URI checksum behaviour -------------------------- Previously, recipes by tradition included both SHA256 and MD5 checksums -for remotely fetched files in ```SRC_URI`` <#var-SRC_URI>`__, even +for remotely fetched files in :term:`SRC_URI`, even though only one is actually mandated. However, the MD5 checksum does not add much given its inherent weakness; thus when a checksum fails only the SHA256 sum will now be printed. The md5sum will still be verified if @@ -4984,7 +4984,7 @@ fetches the shrinkwrap file and the dependencies. This removes the slightly awkward ``NPM_LOCKDOWN`` and ``NPM_SHRINKWRAP`` variables which pointed to local files; the lockdown file is no longer needed at all. Additionally, the package name in ``npm://`` entries in -```SRC_URI`` <#var-SRC_URI>`__ is now specified using a ``package`` +:term:`SRC_URI` is now specified using a ``package`` parameter instead of the earlier ``name`` which overlapped with the generic ``name`` parameter. All recipes using the npm fetcher will need to be changed as a result. @@ -5019,9 +5019,9 @@ Packaging changes - The ``ldconfig`` binary built as part of glibc has now been moved to its own ``ldconfig`` package (note no ``glibc-`` prefix). This - package is in the ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ of the main + package is in the :term:`RRECOMMENDS` of the main ``glibc`` package if ``ldconfig`` is present in - ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__. + :term:`DISTRO_FEATURES`. - ``libevent`` now splits each shared library into its own package (as Debian does). Since these are shared libraries and will be pulled in @@ -5058,7 +5058,7 @@ circumstances: ``conf/machine/include/x86-base.inc`` (inherited by most x86 machine configurations) now specifies ``wic`` instead of ``live`` by default in -```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__. The ``live`` image type will +:term:`IMAGE_FSTYPES`. The ``live`` image type will likely be removed in a future release so it is recommended that you use ``wic`` instead. diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst index fdfd110ae7..1685483363 100644 --- a/documentation/ref-manual/ref-classes.rst +++ b/documentation/ref-manual/ref-classes.rst @@ -11,14 +11,14 @@ inherits a class it is enough to enable its features. There are cases, however, where in the recipe you might need to set variables or override some default behavior. -Any `Metadata <#metadata>`__ usually found in a recipe can also be +Any :term:`Metadata` usually found in a recipe can also be placed in a class file. Class files are identified by the extension ``.bbclass`` and are usually placed in a ``classes/`` directory beneath the ``meta*/`` directory found in the `Source Directory <#source-directory>`__. Class files can also be pointed to by -```BUILDDIR`` <#var-BUILDDIR>`__ (e.g. ``build/``) in the same way as +:term:`BUILDDIR` (e.g. ``build/``) in the same way as ``.conf`` files in the ``conf`` directory. Class files are searched for -in ```BBPATH`` <#var-BBPATH>`__ using the same method by which ``.conf`` +in :term:`BBPATH` using the same method by which ``.conf`` files are searched. This chapter discusses only the most useful and important classes. Other @@ -41,8 +41,8 @@ splitting out of debug symbols during packaging). Unlike some distro recipes (e.g. Debian), OpenEmbedded recipes that produce packages that depend on tunings through use of the - ```RDEPENDS`` <#var-RDEPENDS>`__ and - ```TUNE_PKGARCH`` <#var-TUNE_PKGARCH>`__ variables, should never be + :term:`RDEPENDS` and + :term:`TUNE_PKGARCH` variables, should never be configured for all architectures using ``allarch``. This is the case even if the recipes do not produce architecture-specific output. @@ -52,8 +52,8 @@ splitting out of debug symbols during packaging). Additionally, unnecessary rebuilds occur every time an image for a different ``MACHINE`` is built even when the recipe never changes. -By default, all recipes inherit the ```base`` <#ref-classes-base>`__ and -```package`` <#ref-classes-package>`__ classes, which enable +By default, all recipes inherit the :ref:`base ` and +:ref:`package ` classes, which enable functionality needed for recipes that produce executable output. If your recipe, for example, only produces packages that contain configuration files, media files, or scripts (e.g. Python and Perl), then it should @@ -71,7 +71,7 @@ For more details on the source archiver, see the "`Maintaining Open Source License Compliance During Your Product's Lifecycle <&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle>`__" section in the Yocto Project Development Tasks Manual. You can also see -the ```ARCHIVER_MODE`` <#var-ARCHIVER_MODE>`__ variable for information +the :term:`ARCHIVER_MODE` variable for information about the variable flags (varflags) that help control archive creation. .. _ref-classes-autotools: @@ -96,8 +96,8 @@ By default, the ``autotools*`` classes use out-of-tree builds (i.e. If the software being built by a recipe does not support using out-of-tree builds, you should have the recipe inherit the ``autotools-brokensep`` class. The ``autotools-brokensep`` class behaves -the same as the ``autotools`` class but builds with ```B`` <#var-B>`__ -== ```S`` <#var-S>`__. This method is useful when out-of-tree build +the same as the ``autotools`` class but builds with :term:`B` +== :term:`S`. This method is useful when out-of-tree build support is either not present or is broken. .. note:: @@ -108,19 +108,19 @@ support is either not present or is broken. It's useful to have some idea of how the tasks defined by the ``autotools*`` classes work and what they do behind the scenes. -- ```do_configure`` <#ref-tasks-configure>`__ - Regenerates the +- :ref:`ref-tasks-configure` - Regenerates the configure script (using ``autoreconf``) and then launches it with a standard set of arguments used during cross-compilation. You can pass additional parameters to ``configure`` through the ``EXTRA_OECONF`` - or ```PACKAGECONFIG_CONFARGS`` <#var-PACKAGECONFIG_CONFARGS>`__ + or :term:`PACKAGECONFIG_CONFARGS` variables. -- ```do_compile`` <#ref-tasks-compile>`__ - Runs ``make`` with +- :ref:`ref-tasks-compile` - Runs ``make`` with arguments that specify the compiler and linker. You can pass additional arguments through the ``EXTRA_OEMAKE`` variable. -- ```do_install`` <#ref-tasks-install>`__ - Runs ``make install`` and - passes in ``${``\ ```D`` <#var-D>`__\ ``}`` as ``DESTDIR``. +- :ref:`ref-tasks-install` - Runs ``make install`` and + passes in ``${``\ :term:`D`\ ``}`` as ``DESTDIR``. .. _ref-classes-base: @@ -133,12 +133,12 @@ tasks such as fetching, unpacking, configuring (empty by default), compiling (runs any ``Makefile`` present), installing (empty by default) and packaging (empty by default). These classes are often overridden or extended by other classes such as the -```autotools`` <#ref-classes-autotools>`__ class or the -```package`` <#ref-classes-package>`__ class. +:ref:`autotools ` class or the +:ref:`package ` class. The class also contains some commonly used functions such as ``oe_runmake``, which runs ``make`` with the arguments specified in -```EXTRA_OEMAKE`` <#var-EXTRA_OEMAKE>`__ variable as well as the +:term:`EXTRA_OEMAKE` variable as well as the arguments passed directly to ``oe_runmake``. .. _ref-classes-bash-completion: @@ -201,7 +201,7 @@ the ``sysroots/`` directory. Inheriting this class results in all paths in these scripts being changed to point into the ``sysroots/`` directory so that all builds that use the script use the correct directories for the cross compiling layout. See the -```BINCONFIG_GLOB`` <#var-BINCONFIG_GLOB>`__ variable for more +:term:`BINCONFIG_GLOB` variable for more information. .. _ref-classes-binconfig-disabled: @@ -209,11 +209,11 @@ information. ``binconfig-disabled.bbclass`` ============================== -An alternative version of the ```binconfig`` <#ref-classes-binconfig>`__ +An alternative version of the :ref:`binconfig ` class, which disables binary configuration scripts by making them return an error in favor of using ``pkg-config`` to query the information. The scripts to be disabled should be specified using the -```BINCONFIG`` <#var-BINCONFIG>`__ variable within the recipe inheriting +:term:`BINCONFIG` variable within the recipe inheriting the class. .. _ref-classes-blacklist: @@ -223,8 +223,8 @@ the class. The ``blacklist`` class prevents the OpenEmbedded build system from building specific recipes (blacklists them). To use this class, inherit -the class globally and set ```PNBLACKLIST`` <#var-PNBLACKLIST>`__ for -each recipe you wish to blacklist. Specify the ```PN`` <#var-PN>`__ +the class globally and set :term:`PNBLACKLIST` for +each recipe you wish to blacklist. Specify the :term:`PN` value as a variable flag (varflag) and provide a reason, which is reported, if the package is requested to be built as the value. For example, if you want to blacklist a recipe called "exoticware", you add @@ -253,14 +253,14 @@ The ``buildstats`` class records performance statistics about each task executed during the build (e.g. elapsed time, CPU usage, and I/O usage). When you use this class, the output goes into the -```BUILDSTATS_BASE`` <#var-BUILDSTATS_BASE>`__ directory, which defaults +:term:`BUILDSTATS_BASE` directory, which defaults to ``${TMPDIR}/buildstats/``. You can analyze the elapsed time using ``scripts/pybootchartgui/pybootchartgui.py``, which produces a cascading chart of the entire build process and can be useful for highlighting bottlenecks. Collecting build statistics is enabled by default through the -```USER_CLASSES`` <#var-USER_CLASSES>`__ variable from your +:term:`USER_CLASSES` variable from your ``local.conf`` file. Consequently, you do not have to do anything to enable the class. However, if you want to disable the class, simply remove "buildstats" from the ``USER_CLASSES`` list. @@ -272,7 +272,7 @@ remove "buildstats" from the ``USER_CLASSES`` list. When inherited globally, prints statistics at the end of the build on sstate re-use. In order to function, this class requires the -```buildstats`` <#ref-classes-buildstats>`__ class be enabled. +:ref:`buildstats ` class be enabled. .. _ref-classes-ccache: @@ -318,7 +318,7 @@ and other common items used by Clutter and related recipes. The ``cmake`` class allows for recipes that need to build software using the `CMake `__ build system. You can use -the ```EXTRA_OECMAKE`` <#var-EXTRA_OECMAKE>`__ variable to specify +the :term:`EXTRA_OECMAKE` variable to specify additional configuration options to be passed using the ``cmake`` command line. @@ -326,7 +326,7 @@ On the occasion that you would be installing custom CMake toolchain files supplied by the application being built, you should install them to the preferred CMake Module directory: ``${D}${datadir}/cmake/`` Modules during -```do_install`` <&YOCTO_DOCS_REF_URL;#ref-tasks-install>`__. +:ref:`ref-tasks-install`. .. _ref-classes-cml1: @@ -344,7 +344,7 @@ build configuration system. Enables compression for man pages and info pages. This class is intended to be inherited globally. The default compression mechanism is gz (gzip) but you can select an alternative mechanism by setting the -```DOC_COMPRESS`` <#var-DOC_COMPRESS>`__ variable. +:term:`DOC_COMPRESS` variable. .. _ref-classes-copyleft_compliance: @@ -354,15 +354,15 @@ but you can select an alternative mechanism by setting the The ``copyleft_compliance`` class preserves source code for the purposes of license compliance. This class is an alternative to the ``archiver`` class and is still used by some users even though it has been deprecated -in favor of the ```archiver`` <#ref-classes-archiver>`__ class. +in favor of the :ref:`archiver ` class. .. _ref-classes-copyleft_filter: ``copyleft_filter.bbclass`` =========================== -A class used by the ```archiver`` <#ref-classes-archiver>`__ and -```copyleft_compliance`` <#ref-classes-copyleft_compliance>`__ classes +A class used by the :ref:`archiver ` and +:ref:`copyleft_compliance ` classes for filtering licenses. The ``copyleft_filter`` class is an internal class and is not intended to be used directly. @@ -373,7 +373,7 @@ class and is not intended to be used directly. The ``core-image`` class provides common definitions for the ``core-image-*`` image recipes, such as support for additional -```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__. +:term:`IMAGE_FEATURES`. .. _ref-classes-cpan: @@ -439,7 +439,7 @@ Debian naming policy (i.e. ``glibc`` becomes ``libc6`` and name and version as part of the package name. If a recipe creates packages for multiple libraries (shared object files -of ``.so`` type), use the ```LEAD_SONAME`` <#var-LEAD_SONAME>`__ +of ``.so`` type), use the :term:`LEAD_SONAME` variable in the recipe to specify the library on which to apply the naming scheme. @@ -449,14 +449,14 @@ naming scheme. ================== The ``deploy`` class handles deploying files to the -```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__ directory. The main +:term:`DEPLOY_DIR_IMAGE` directory. The main function of this class is to allow the deploy step to be accelerated by shared state. Recipes that inherit this class should define their own -```do_deploy`` <#ref-tasks-deploy>`__ function to copy the files to be -deployed to ```DEPLOYDIR`` <#var-DEPLOYDIR>`__, and use ``addtask`` to +:ref:`ref-tasks-deploy` function to copy the files to be +deployed to :term:`DEPLOYDIR`, and use ``addtask`` to add the task at the appropriate place, which is usually after -```do_compile`` <#ref-tasks-compile>`__ or -```do_install`` <#ref-tasks-install>`__. The class then takes care of +:ref:`ref-tasks-compile` or +:ref:`ref-tasks-install`. The class then takes care of staging the files from ``DEPLOYDIR`` to ``DEPLOY_DIR_IMAGE``. .. _ref-classes-devshell: @@ -476,13 +476,13 @@ information about using ``devshell``. ======================= The ``devupstream`` class uses -```BBCLASSEXTEND`` <#var-BBCLASSEXTEND>`__ to add a variant of the +:term:`BBCLASSEXTEND` to add a variant of the recipe that fetches from an alternative URI (e.g. Git) instead of a tarball. Following is an example: BBCLASSEXTEND = "devupstream:target" SRC_URI_class-devupstream = "git://git.example.com/example" SRCREV_class-devupstream = "abcd1234" Adding the above statements to your recipe creates a variant that has -```DEFAULT_PREFERENCE`` <#var-DEFAULT_PREFERENCE>`__ set to "-1". +:term:`DEFAULT_PREFERENCE` set to "-1". Consequently, you need to select the variant of the recipe to use it. Any development-specific adjustments can be done by using the ``class-devupstream`` override. Here is an example: @@ -506,11 +506,11 @@ due to BitBake's automatic fetch dependencies (e.g. The ``distro_features_check`` class allows individual recipes to check for required and conflicting -```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__. +:term:`DISTRO_FEATURES`. This class provides support for the -```REQUIRED_DISTRO_FEATURES`` <#var-REQUIRED_DISTRO_FEATURES>`__ and -```CONFLICT_DISTRO_FEATURES`` <#var-CONFLICT_DISTRO_FEATURES>`__ +:term:`REQUIRED_DISTRO_FEATURES` and +:term:`CONFLICT_DISTRO_FEATURES` variables. If any conditions specified in the recipe using the above variables are not met, the recipe will be skipped. @@ -532,7 +532,7 @@ used. ``distutils`` class in their recipes. - Extensions that use build systems based on ``setuptools`` require the - ```setuptools`` <#ref-classes-setuptools>`__ class in their recipes. + :ref:`setuptools ` class in their recipes. The ``distutils-common-base`` class is required by some of the ``distutils*`` classes to provide common Python2 support. @@ -574,22 +574,22 @@ that is external to the OpenEmbedded build system. Building software from an external source tree means that the build system's normal fetch, unpack, and patch process is not used. -By default, the OpenEmbedded build system uses the ```S`` <#var-S>`__ -and ```B`` <#var-B>`__ variables to locate unpacked recipe source code +By default, the OpenEmbedded build system uses the :term:`S` +and :term:`B` variables to locate unpacked recipe source code and to build it, respectively. When your recipe inherits the ``externalsrc`` class, you use the -```EXTERNALSRC`` <#var-EXTERNALSRC>`__ and -```EXTERNALSRC_BUILD`` <#var-EXTERNALSRC_BUILD>`__ variables to +:term:`EXTERNALSRC` and +:term:`EXTERNALSRC_BUILD` variables to ultimately define ``S`` and ``B``. By default, this class expects the source code to support recipe builds -that use the ```B`` <#var-B>`__ variable to point to the directory in +that use the :term:`B` variable to point to the directory in which the OpenEmbedded build system places the generated objects built from the recipes. By default, the ``B`` directory is set to the following, which is separate from the source directory (``S``): ${WORKDIR}/${BPN}/{PV}/ See these variables for more information: -```WORKDIR`` <#var-WORKDIR>`__, ```BPN`` <#var-BPN>`__, and -```PV`` <#var-PV>`__, +:term:`WORKDIR`, :term:`BPN`, and +:term:`PV`, For more information on the ``externalsrc`` class, see the comments in ``meta/classes/externalsrc.bbclass`` in the `Source @@ -607,7 +607,7 @@ The ``extrausers`` class allows additional user and group configuration to be applied at the image level. Inheriting this class either globally or from an image recipe allows additional user and group operations to be performed using the -```EXTRA_USERS_PARAMS`` <#var-EXTRA_USERS_PARAMS>`__ variable. +:term:`EXTRA_USERS_PARAMS` variable. .. note:: @@ -642,7 +642,7 @@ architecture-specific, ``fc-cache`` runs using QEMU if the postinst scriptlets need to be run on the build host during image creation. If the fonts being installed are in packages other than the main -package, set ```FONT_PACKAGES`` <#var-FONT_PACKAGES>`__ to specify the +package, set :term:`FONT_PACKAGES` to specify the packages containing the fonts. .. _ref-classes-fs-uuid: @@ -651,7 +651,7 @@ packages containing the fonts. =================== The ``fs-uuid`` class extracts UUID from -``${``\ ```ROOTFS`` <#var-ROOTFS>`__\ ``}``, which must have been built +``${``\ :term:`ROOTFS`\ ``}``, which must have been built by the time that this function gets called. The ``fs-uuid`` class only works on ``ext`` file systems and depends on ``tune2fs``. @@ -662,7 +662,7 @@ works on ``ext`` file systems and depends on ``tune2fs``. The ``gconf`` class provides common functionality for recipes that need to install GConf schemas. The schemas will be put into a separate -package (``${``\ ```PN`` <#var-PN>`__\ ``}-gconf``) that is created +package (``${``\ :term:`PN`\ ``}-gconf``) that is created automatically when this class is inherited. This package uses the appropriate post-install and post-remove (postinst/postrm) scriptlets to register and unregister the schemas in the target image. @@ -684,8 +684,8 @@ class. The ``gnomebase`` class is the base class for recipes that build software from the GNOME stack. This class sets -```SRC_URI`` <#var-SRC_URI>`__ to download the source from the GNOME -mirrors as well as extending ```FILES`` <#var-FILES>`__ with the typical +:term:`SRC_URI` to download the source from the GNOME +mirrors as well as extending :term:`FILES` with the typical GNOME installation paths. .. _ref-classes-gobject-introspection: @@ -696,9 +696,9 @@ GNOME installation paths. Provides support for recipes building software that supports GObject introspection. This functionality is only enabled if the "gobject-introspection-data" feature is in -```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ as well as +:term:`DISTRO_FEATURES` as well as "qemu-usermode" being in -```MACHINE_FEATURES`` <#var-MACHINE_FEATURES>`__. +:term:`MACHINE_FEATURES`. .. note:: @@ -719,26 +719,26 @@ building bootable images. This class supports several variables: -- ```INITRD`` <#var-INITRD>`__: Indicates list of filesystem images to +- :term:`INITRD`: Indicates list of filesystem images to concatenate and use as an initial RAM disk (initrd) (optional). -- ```ROOTFS`` <#var-ROOTFS>`__: Indicates a filesystem image to include +- :term:`ROOTFS`: Indicates a filesystem image to include as the root filesystem (optional). -- ```GRUB_GFXSERIAL`` <#var-GRUB_GFXSERIAL>`__: Set this to "1" to have +- :term:`GRUB_GFXSERIAL`: Set this to "1" to have graphics and serial in the boot menu. -- ```LABELS`` <#var-LABELS>`__: A list of targets for the automatic +- :term:`LABELS`: A list of targets for the automatic configuration. -- ```APPEND`` <#var-APPEND>`__: An override list of append strings for +- :term:`APPEND`: An override list of append strings for each ``LABEL``. -- ```GRUB_OPTS`` <#var-GRUB_OPTS>`__: Additional options to add to the +- :term:`GRUB_OPTS`: Additional options to add to the configuration (optional). Options are delimited using semi-colon characters (``;``). -- ```GRUB_TIMEOUT`` <#var-GRUB_TIMEOUT>`__: Timeout before executing +- :term:`GRUB_TIMEOUT`: Timeout before executing the default ``LABEL`` (optional). .. _ref-classes-gsettings: @@ -788,7 +788,7 @@ need to be run on the build host during image creation. If the input method modules being installed are in packages other than the main package, set -```GTKIMMODULES_PACKAGES`` <#var-GTKIMMODULES_PACKAGES>`__ to specify +:term:`GTKIMMODULES_PACKAGES` to specify the packages containing the modules. .. _ref-classes-gzipnative: @@ -826,9 +826,9 @@ The class handles all three different compile stages (i.e native ``tar.gz`` file to be used by the remote machines. The class also supports SDK generation. -If ```ICECC_PATH`` <#var-ICECC_PATH>`__ is not set in your +If :term:`ICECC_PATH` is not set in your ``local.conf`` file, then the class tries to locate the ``icecc`` binary -using ``which``. If ```ICECC_ENV_EXEC`` <#var-ICECC_ENV_EXEC>`__ is set +using ``which``. If :term:`ICECC_ENV_EXEC` is set in your ``local.conf`` file, the variable should point to the ``icecc-create-env`` script provided by the user. If you do not point to a user-provided script, the build system uses the default script @@ -843,15 +843,15 @@ provided by the recipe ``icecc-create-env-native.bb``. If you do not want the Icecream distributed compile support to apply to specific recipes or classes, you can effectively "blacklist" them by listing the recipes and classes using the -```ICECC_USER_PACKAGE_BL`` <#var-ICECC_USER_PACKAGE_BL>`__ and -```ICECC_USER_CLASS_BL`` <#var-ICECC_USER_CLASS_BL>`__, variables, +:term:`ICECC_USER_PACKAGE_BL` and +:term:`ICECC_USER_CLASS_BL`, variables, respectively, in your ``local.conf`` file. Doing so causes the OpenEmbedded build system to handle these compilations locally. Additionally, you can list recipes using the -```ICECC_USER_PACKAGE_WL`` <#var-ICECC_USER_PACKAGE_WL>`__ variable in +:term:`ICECC_USER_PACKAGE_WL` variable in your ``local.conf`` file to force ``icecc`` to be enabled for recipes -using an empty ```PARALLEL_MAKE`` <#var-PARALLEL_MAKE>`__ variable. +using an empty :term:`PARALLEL_MAKE` variable. Inheriting the ``icecc`` class changes all sstate signatures. Consequently, if a development team has a dedicated build system that @@ -862,7 +862,7 @@ system need to either inherit the ``icecc`` class or nobody should. At the distribution level, you can inherit the ``icecc`` class to be sure that all builders start with the same sstate signatures. After inheriting the class, you can then disable the feature by setting the -```ICECC_DISABLED`` <#var-ICECC_DISABLED>`__ variable to "1" as follows: +:term:`ICECC_DISABLED` variable to "1" as follows: INHERIT_DISTRO_append = " icecc" ICECC_DISABLED ??= "1" This practice makes sure everyone is using the same signatures but also requires individuals that do want to use Icecream to enable the feature @@ -906,11 +906,11 @@ filesystem on ``/etc/build``. The ``image_types`` class defines all of the standard image output types that you can enable through the -```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable. You can use this +:term:`IMAGE_FSTYPES` variable. You can use this class as a reference on how to add support for custom image output types. -By default, the ```image`` <#ref-classes-image>`__ class automatically +By default, the :ref:`image ` class automatically enables the ``image_types`` class. The ``image`` class uses the ``IMGCLASSES`` variable as follows: IMGCLASSES = "rootfs_${IMAGE_PKGTYPE} image_types ${IMAGE_CLASSES}" IMGCLASSES += @@ -940,11 +940,11 @@ images. This class controls building "live" (i.e. HDDIMG and ISO) images. Live images contain syslinux for legacy booting, as well as the bootloader -specified by ```EFI_PROVIDER`` <#var-EFI_PROVIDER>`__ if -```MACHINE_FEATURES`` <#var-MACHINE_FEATURES>`__ contains "efi". +specified by :term:`EFI_PROVIDER` if +:term:`MACHINE_FEATURES` contains "efi". Normally, you do not use this class directly. Instead, you add "live" to -```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__. +:term:`IMAGE_FSTYPES`. .. _ref-classes-image-mklibs: @@ -952,11 +952,11 @@ Normally, you do not use this class directly. Instead, you add "live" to ======================== The ``image-mklibs`` class enables the use of the ``mklibs`` utility -during the ```do_rootfs`` <#ref-tasks-rootfs>`__ task, which optimizes +during the :ref:`ref-tasks-rootfs` task, which optimizes the size of libraries contained in the image. By default, the class is enabled in the ``local.conf.template`` using -the ```USER_CLASSES`` <#var-USER_CLASSES>`__ variable as follows: +the :term:`USER_CLASSES` variable as follows: USER_CLASSES ?= "buildstats image-mklibs image-prelink" .. _ref-classes-image-prelink: @@ -965,12 +965,12 @@ USER_CLASSES ?= "buildstats image-mklibs image-prelink" ========================= The ``image-prelink`` class enables the use of the ``prelink`` utility -during the ```do_rootfs`` <#ref-tasks-rootfs>`__ task, which optimizes +during the :ref:`ref-tasks-rootfs` task, which optimizes the dynamic linking of shared libraries to reduce executable startup time. By default, the class is enabled in the ``local.conf.template`` using -the ```USER_CLASSES`` <#var-USER_CLASSES>`__ variable as follows: +the :term:`USER_CLASSES` variable as follows: USER_CLASSES ?= "buildstats image-mklibs image-prelink" .. _ref-classes-insane: @@ -992,11 +992,11 @@ condition. See the "`QA Error and Warning Messages <#ref-qa-checks>`__" Chapter for a list of all the warning and error messages you might encounter using a default configuration. -Use the ```WARN_QA`` <#var-WARN_QA>`__ and -```ERROR_QA`` <#var-ERROR_QA>`__ variables to control the behavior of +Use the :term:`WARN_QA` and +:term:`ERROR_QA` variables to control the behavior of these checks at the global level (i.e. in your custom distro configuration). However, to skip one or more checks in recipes, you -should use ```INSANE_SKIP`` <#var-INSANE_SKIP>`__. For example, to skip +should use :term:`INSANE_SKIP`. For example, to skip the check for symbolic link ``.so`` files in the main package of a recipe, add the following to the recipe. You need to realize that the package name override, in this example ``${PN}``, must be used: @@ -1026,17 +1026,17 @@ The following list shows the tests you can list with the ``WARN_QA`` and positives and thus is not normally enabled. - *``build-deps:``* Determines if a build-time dependency that is - specified through ```DEPENDS`` <#var-DEPENDS>`__, explicit - ```RDEPENDS`` <#var-RDEPENDS>`__, or task-level dependencies exists + specified through :term:`DEPENDS`, explicit + :term:`RDEPENDS`, or task-level dependencies exists to match any runtime dependency. This determination is particularly useful to discover where runtime dependencies are detected and added during packaging. If no explicit dependency has been specified within the metadata, at the packaging stage it is too late to ensure that the dependency is built, and thus you can end up with an error when the package is installed into the image during the - ```do_rootfs`` <#ref-tasks-rootfs>`__ task because the auto-detected + :ref:`ref-tasks-rootfs` task because the auto-detected dependency was not satisfied. An example of this would be where the - ```update-rc.d`` <#ref-classes-update-rc.d>`__ class automatically + :ref:`update-rc.d ` class automatically adds a dependency on the ``initscripts-functions`` package to packages that install an initscript that refers to ``/etc/init.d/functions``. The recipe should really have an explicit @@ -1046,7 +1046,7 @@ The following list shows the tests you can list with the ``WARN_QA`` and ``initscripts-functions`` package is made available. - *``compile-host-path:``* Checks the - ```do_compile`` <#ref-tasks-compile>`__ log for indications that + :ref:`ref-tasks-compile` log for indications that paths to locations on the build host were used. Using such paths might result in host contamination of the build output. @@ -1060,12 +1060,12 @@ The following list shows the tests you can list with the ``WARN_QA`` and - *``dep-cmp:``* Checks for invalid version comparison statements in runtime dependency relationships between packages (i.e. in - ```RDEPENDS`` <#var-RDEPENDS>`__, - ```RRECOMMENDS`` <#var-RRECOMMENDS>`__, - ```RSUGGESTS`` <#var-RSUGGESTS>`__, - ```RPROVIDES`` <#var-RPROVIDES>`__, - ```RREPLACES`` <#var-RREPLACES>`__, and - ```RCONFLICTS`` <#var-RCONFLICTS>`__ variable values). Any invalid + :term:`RDEPENDS`, + :term:`RRECOMMENDS`, + :term:`RSUGGESTS`, + :term:`RPROVIDES`, + :term:`RREPLACES`, and + :term:`RCONFLICTS` variable values). Any invalid comparisons might trigger failures or undesirable behavior when passed to the package manager. @@ -1094,10 +1094,10 @@ The following list shows the tests you can list with the ``WARN_QA`` and However, the lack of that functionality in the other two package managers does not mean the dependencies do not still need resolving. This QA check attempts to ensure that explicitly declared - ```RDEPENDS`` <#var-RDEPENDS>`__ exist to handle any file-level + :term:`RDEPENDS` exist to handle any file-level dependency detected in packaged files. -- *``files-invalid:``* Checks for ```FILES`` <#var-FILES>`__ variable +- *``files-invalid:``* Checks for :term:`FILES` variable values that contain "//", which is invalid. - *``host-user-contaminated:``* Checks that no package produced by the @@ -1106,33 +1106,33 @@ The following list shows the tests you can list with the ``WARN_QA`` and that the files are being installed with an incorrect UID/GID, since target IDs are independent from host IDs. For additional information, see the section describing the - ```do_install`` <#ref-tasks-install>`__ task. + :ref:`ref-tasks-install` task. - *``incompatible-license:``* Report when packages are excluded from being created due to being marked with a license that is in - ```INCOMPATIBLE_LICENSE`` <#var-INCOMPATIBLE_LICENSE>`__. + :term:`INCOMPATIBLE_LICENSE`. - *``install-host-path:``* Checks the - ```do_install`` <#ref-tasks-install>`__ log for indications that + :ref:`ref-tasks-install` log for indications that paths to locations on the build host were used. Using such paths might result in host contamination of the build output. - *``installed-vs-shipped:``* Reports when files have been installed within ``do_install`` but have not been included in any package by - way of the ```FILES`` <#var-FILES>`__ variable. Files that do not + way of the :term:`FILES` variable. Files that do not appear in any package cannot be present in an image later on in the build process. Ideally, all installed files should be packaged or not installed at all. These files can be deleted at the end of ``do_install`` if the files are not needed in any package. - *``invalid-chars:``* Checks that the recipe metadata variables - ```DESCRIPTION`` <#var-DESCRIPTION>`__, - ```SUMMARY`` <#var-SUMMARY>`__, ```LICENSE`` <#var-LICENSE>`__, and - ```SECTION`` <#var-SECTION>`__ do not contain non-UTF-8 characters. + :term:`DESCRIPTION`, + :term:`SUMMARY`, :term:`LICENSE`, and + :term:`SECTION` do not contain non-UTF-8 characters. Some package managers do not support such characters. - *``invalid-packageconfig:``* Checks that no undefined features are - being added to ```PACKAGECONFIG`` <#var-PACKAGECONFIG>`__. For + being added to :term:`PACKAGECONFIG`. For example, any name "foo" for which the following form does not exist: PACKAGECONFIG[foo] = "..." @@ -1141,7 +1141,7 @@ The following list shows the tests you can list with the ``WARN_QA`` and correct sysroot prefix when using the files automatically itself. - *``ldflags:``* Ensures that the binaries were linked with the - ```LDFLAGS`` <#var-LDFLAGS>`__ options provided by the build system. + :term:`LDFLAGS` options provided by the build system. If this test fails, check that the ``LDFLAGS`` variable is being passed to the linker command. @@ -1156,7 +1156,7 @@ The following list shows the tests you can list with the ``WARN_QA`` and variable has been set explicitly to ``/usr/libexec``. - *``packages-list:``* Checks for the same package being listed - multiple times through the ```PACKAGES`` <#var-PACKAGES>`__ variable + multiple times through the :term:`PACKAGES` variable value. Installing the package in this manner can cause errors during packaging. @@ -1172,27 +1172,27 @@ The following list shows the tests you can list with the ``WARN_QA`` and - *``perms:``* Currently, this check is unused but reserved. - *``pkgconfig:``* Checks ``.pc`` files for any - ```TMPDIR`` <#var-TMPDIR>`__/```WORKDIR`` <#var-WORKDIR>`__ paths. + :term:`TMPDIR`/:term:`WORKDIR` paths. Any ``.pc`` file containing these paths is incorrect since ``pkg-config`` itself adds the correct sysroot prefix when the files are accessed. - *``pkgname:``* Checks that all packages in - ```PACKAGES`` <#var-PACKAGES>`__ have names that do not contain + :term:`PACKAGES` have names that do not contain invalid characters (i.e. characters other than 0-9, a-z, ., +, and -). - *``pkgv-undefined:``* Checks to see if the ``PKGV`` variable is - undefined during ```do_package`` <#ref-tasks-package>`__. + undefined during :ref:`ref-tasks-package`. - *``pkgvarcheck:``* Checks through the variables - ```RDEPENDS`` <#var-RDEPENDS>`__, - ```RRECOMMENDS`` <#var-RRECOMMENDS>`__, - ```RSUGGESTS`` <#var-RSUGGESTS>`__, - ```RCONFLICTS`` <#var-RCONFLICTS>`__, - ```RPROVIDES`` <#var-RPROVIDES>`__, - ```RREPLACES`` <#var-RREPLACES>`__, ```FILES`` <#var-FILES>`__, - ```ALLOW_EMPTY`` <#var-ALLOW_EMPTY>`__, ``pkg_preinst``, + :term:`RDEPENDS`, + :term:`RRECOMMENDS`, + :term:`RSUGGESTS`, + :term:`RCONFLICTS`, + :term:`RPROVIDES`, + :term:`RREPLACES`, :term:`FILES`, + :term:`ALLOW_EMPTY`, ``pkg_preinst``, ``pkg_postinst``, ``pkg_prerm`` and ``pkg_postrm``, and reports if there are variable sets that are not package-specific. Using these variables without a package suffix is bad practice, and might @@ -1200,11 +1200,11 @@ The following list shows the tests you can list with the ``WARN_QA`` and same recipe or have other unintended consequences. - *``pn-overrides:``* Checks that a recipe does not have a name - (```PN`` <#var-PN>`__) value that appears in - ```OVERRIDES`` <#var-OVERRIDES>`__. If a recipe is named such that + (:term:`PN`) value that appears in + :term:`OVERRIDES`. If a recipe is named such that its ``PN`` value matches something already in ``OVERRIDES`` (e.g. - ``PN`` happens to be the same as ```MACHINE`` <#var-MACHINE>`__ or - ```DISTRO`` <#var-DISTRO>`__), it can have unexpected consequences. + ``PN`` happens to be the same as :term:`MACHINE` or + :term:`DISTRO`), it can have unexpected consequences. For example, assignments such as ``FILES_${PN} = "xyz"`` effectively turn into ``FILES = "xyz"``. @@ -1220,7 +1220,7 @@ The following list shows the tests you can list with the ``WARN_QA`` and non-``staticdev`` packages. - *``symlink-to-sysroot:``* Checks for symlinks in packages that point - into ```TMPDIR`` <#var-TMPDIR>`__ on the host. Such symlinks will + into :term:`TMPDIR` on the host. Such symlinks will work on the host, but are clearly invalid when running on the target. - *``textrel:``* Checks for ELF binaries that contain relocations in @@ -1231,7 +1231,7 @@ The following list shows the tests you can list with the ``WARN_QA`` and - *``unlisted-pkg-lics:``* Checks that all declared licenses applying for a package are also declared on the recipe level (i.e. any license - in ``LICENSE_*`` should appear in ```LICENSE`` <#var-LICENSE>`__). + in ``LICENSE_*`` should appear in :term:`LICENSE`). - *``useless-rpaths:``* Checks for dynamic library load paths (rpaths) in the binaries that by default on a standard system are searched by @@ -1239,10 +1239,10 @@ The following list shows the tests you can list with the ``WARN_QA`` and not cause any breakage, they do waste space and are unnecessary. - *``var-undefined:``* Reports when variables fundamental to packaging - (i.e. ```WORKDIR`` <#var-WORKDIR>`__, - ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__, ```D`` <#var-D>`__, - ```PN`` <#var-PN>`__, and ```PKGD`` <#var-PKGD>`__) are undefined - during ```do_package`` <#ref-tasks-package>`__. + (i.e. :term:`WORKDIR`, + :term:`DEPLOY_DIR`, :term:`D`, + :term:`PN`, and :term:`PKGD`) are undefined + during :ref:`ref-tasks-package`. - *``version-going-backwards:``* If Build History is enabled, reports when a package being written out has a lower version than the @@ -1283,7 +1283,7 @@ themselves. The ``kernel`` class handles building Linux kernels. The class contains code to build all kernel trees. All needed headers are staged into the ``STAGING_KERNEL_DIR`` directory to allow out-of-tree module builds -using the ```module`` <#ref-classes-module>`__ class. +using the :ref:`module ` class. This means that each built kernel module is packaged separately and inter-module dependencies are created by parsing the ``modinfo`` output. @@ -1299,9 +1299,9 @@ Image <&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image>`__" section in the Yocto Project Development Tasks Manual. Various other classes are used by the ``kernel`` and ``module`` classes -internally including the ```kernel-arch`` <#ref-classes-kernel-arch>`__, -```module-base`` <#ref-classes-module-base>`__, and -```linux-kernel-base`` <#ref-classes-linux-kernel-base>`__ classes. +internally including the :ref:`kernel-arch `, +:ref:`module-base `, and +:ref:`linux-kernel-base ` classes. .. _ref-classes-kernel-arch: @@ -1317,7 +1317,7 @@ Linux kernel compilation (including modules). ============================= The ``kernel-devicetree`` class, which is inherited by the -```kernel`` <#ref-classes-kernel>`__ class, supports device tree +:ref:`kernel ` class, supports device tree generation. .. _ref-classes-kernel-fitimage: @@ -1422,7 +1422,7 @@ The ``kernelsrc`` class sets the Linux kernel source and version. The ``lib_package`` class supports recipes that build libraries and produce executable binaries, where those binaries should not be installed by default along with the library. Instead, the binaries are -added to a separate ``${``\ ```PN`` <#var-PN>`__\ ``}-bin`` package to +added to a separate ``${``\ :term:`PN`\ ``}-bin`` package to make their installation optional. .. _ref-classes-libc*: @@ -1445,7 +1445,7 @@ The ``libc*`` classes support recipes that build packages with ``libc``: The ``license`` class provides license manifest creation and license exclusion. This class is enabled by default using the default value for -the ```INHERIT_DISTRO`` <#var-INHERIT_DISTRO>`__ variable. +the :term:`INHERIT_DISTRO` variable. .. _ref-classes-linux-kernel-base: @@ -1495,7 +1495,7 @@ recipes. The ``metadata_scm`` class provides functionality for querying the branch and revision of a Source Code Manager (SCM) repository. -The ```base`` <#ref-classes-base>`__ class uses this class to print the +The :ref:`base ` class uses this class to print the revisions of each layer before starting every build. The ``metadata_scm`` class is enabled by default because it is inherited by the ``base`` class. @@ -1524,12 +1524,12 @@ the shared database. =================== The ``mirrors`` class sets up some standard -```MIRRORS`` <#var-MIRRORS>`__ entries for source code mirrors. These +:term:`MIRRORS` entries for source code mirrors. These mirrors provide a fall-back path in case the upstream source specified -in ```SRC_URI`` <#var-SRC_URI>`__ within recipes is unavailable. +in :term:`SRC_URI` within recipes is unavailable. This class is enabled by default since it is inherited by the -```base`` <#ref-classes-base>`__ class. +:ref:`base ` class. .. _ref-classes-module: @@ -1538,10 +1538,10 @@ This class is enabled by default since it is inherited by the The ``module`` class provides support for building out-of-tree Linux kernel modules. The class inherits the -```module-base`` <#ref-classes-module-base>`__ and -```kernel-module-split`` <#ref-classes-kernel-module-split>`__ classes, -and implements the ```do_compile`` <#ref-tasks-compile>`__ and -```do_install`` <#ref-tasks-install>`__ tasks. The class provides +:ref:`module-base ` and +:ref:`kernel-module-split ` classes, +and implements the :ref:`ref-tasks-compile` and +:ref:`ref-tasks-install` tasks. The class provides everything needed to build and package a kernel module. For general information on out-of-tree Linux kernel modules, see the @@ -1558,7 +1558,7 @@ The ``module-base`` class provides the base functionality for building Linux kernel modules. Typically, a recipe that builds software that includes one or more kernel modules and has its own means of building the module inherits this class as opposed to inheriting the -```module`` <#ref-classes-module>`__ class. +:ref:`module ` class. .. _ref-classes-multilib*: @@ -1604,7 +1604,7 @@ a couple different ways: caused by existing code that depends on that naming convention. - Create or modify a target recipe that contains the following: - ```BBCLASSEXTEND`` <#var-BBCLASSEXTEND>`__ = "native" Inside the + :term:`BBCLASSEXTEND` = "native" Inside the recipe, use ``_class-native`` and ``_class-target`` overrides to specify any functionality specific to the respective native or target case. @@ -1621,7 +1621,7 @@ target. All common parts of the recipe are automatically shared. The ``nativesdk`` class provides common functionality for recipes that wish to build tools to run as part of an SDK (i.e. tools that run on -```SDKMACHINE`` <#var-SDKMACHINE>`__). +:term:`SDKMACHINE`). You can create a recipe that builds tools that run on the SDK machine a couple different ways: @@ -1632,7 +1632,7 @@ couple different ways: that the ``nativesdk`` class is inherited last. - Create a ``nativesdk`` variant of any recipe by adding the following: - ```BBCLASSEXTEND`` <#var-BBCLASSEXTEND>`__ = "nativesdk" Inside the + :term:`BBCLASSEXTEND` = "nativesdk" Inside the recipe, use ``_class-nativesdk`` and ``_class-target`` overrides to specify any functionality specific to the respective SDK machine or target case. @@ -1686,7 +1686,7 @@ section in the Yocto Project Development Tasks Manual. ================== The ``oelint`` class is an obsolete lint checking tool that exists in -``meta/classes`` in the `Source Directory <#source-directory>`__. +``meta/classes`` in the :term:`Source Directory`. A number of classes exist that could be generally useful in OE-Core but are never actually used within OE-Core itself. The ``oelint`` class is @@ -1700,12 +1700,12 @@ layers. ======================= The ``own-mirrors`` class makes it easier to set up your own -```PREMIRRORS`` <#var-PREMIRRORS>`__ from which to first fetch source +:term:`PREMIRRORS` from which to first fetch source before attempting to fetch it from the upstream specified in -```SRC_URI`` <#var-SRC_URI>`__ within each recipe. +:term:`SRC_URI` within each recipe. To use this class, inherit it globally and specify -```SOURCE_MIRROR_URL`` <#var-SOURCE_MIRROR_URL>`__. Here is an example: +:term:`SOURCE_MIRROR_URL`. Here is an example: INHERIT += "own-mirrors" SOURCE_MIRROR_URL = "http://example.com/my-source-mirror" You can specify only a single URL in ``SOURCE_MIRROR_URL``. @@ -1719,10 +1719,10 @@ The ``package`` class supports generating packages from a build's output. The core generic functionality is in ``package.bbclass``. The code specific to particular package types resides in these package-specific classes: -```package_deb`` <#ref-classes-package_deb>`__, -```package_rpm`` <#ref-classes-package_rpm>`__, -```package_ipk`` <#ref-classes-package_ipk>`__, and -```package_tar`` <#ref-classes-package_tar>`__. +:ref:`package_deb `, +:ref:`package_rpm `, +:ref:`package_ipk `, and +:ref:`package_tar `. .. note:: @@ -1753,7 +1753,7 @@ takes about thirty percent less time as compared to using RPM to build the same or similar package. This comparison takes into account a complete build of the package with all dependencies previously built. The reason for this discrepancy is because the RPM package manager -creates and processes more `Metadata <#metadata>`__ than the IPK package +creates and processes more :term:`Metadata` than the IPK package manager. Consequently, you might consider setting ``PACKAGE_CLASSES`` to "package_ipk" if you are building smaller systems. @@ -1786,10 +1786,10 @@ at these two Yocto Project mailing list links: The ``package_deb`` class provides support for creating packages that use the Debian (i.e. ``.deb``) file format. The class ensures the packages are written out in a ``.deb`` file format to the -``${``\ ```DEPLOY_DIR_DEB`` <#var-DEPLOY_DIR_DEB>`__\ ``}`` directory. +``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory. -This class inherits the ```package`` <#ref-classes-package>`__ class and -is enabled through the ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ +This class inherits the :ref:`package ` class and +is enabled through the :term:`PACKAGE_CLASSES` variable in the ``local.conf`` file. .. _ref-classes-package_ipk: @@ -1800,10 +1800,10 @@ variable in the ``local.conf`` file. The ``package_ipk`` class provides support for creating packages that use the IPK (i.e. ``.ipk``) file format. The class ensures the packages are written out in a ``.ipk`` file format to the -``${``\ ```DEPLOY_DIR_IPK`` <#var-DEPLOY_DIR_IPK>`__\ ``}`` directory. +``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory. -This class inherits the ```package`` <#ref-classes-package>`__ class and -is enabled through the ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ +This class inherits the :ref:`package ` class and +is enabled through the :term:`PACKAGE_CLASSES` variable in the ``local.conf`` file. .. _ref-classes-package_rpm: @@ -1814,10 +1814,10 @@ variable in the ``local.conf`` file. The ``package_rpm`` class provides support for creating packages that use the RPM (i.e. ``.rpm``) file format. The class ensures the packages are written out in a ``.rpm`` file format to the -``${``\ ```DEPLOY_DIR_RPM`` <#var-DEPLOY_DIR_RPM>`__\ ``}`` directory. +``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory. -This class inherits the ```package`` <#ref-classes-package>`__ class and -is enabled through the ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ +This class inherits the :ref:`package ` class and +is enabled through the :term:`PACKAGE_CLASSES` variable in the ``local.conf`` file. .. _ref-classes-package_tar: @@ -1827,10 +1827,10 @@ variable in the ``local.conf`` file. The ``package_tar`` class provides support for creating tarballs. The class ensures the packages are written out in a tarball format to the -``${``\ ```DEPLOY_DIR_TAR`` <#var-DEPLOY_DIR_TAR>`__\ ``}`` directory. +``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory. -This class inherits the ```package`` <#ref-classes-package>`__ class and -is enabled through the ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ +This class inherits the :ref:`package ` class and +is enabled through the :term:`PACKAGE_CLASSES` variable in the ``local.conf`` file. .. note:: @@ -1853,12 +1853,12 @@ variable in the ``local.conf`` file. ======================= The ``packagedata`` class provides common functionality for reading -``pkgdata`` files found in ```PKGDATA_DIR`` <#var-PKGDATA_DIR>`__. These +``pkgdata`` files found in :term:`PKGDATA_DIR`. These files contain information about each output package produced by the OpenEmbedded build system. This class is enabled by default because it is inherited by the -```package`` <#ref-classes-package>`__ class. +:ref:`package ` class. .. _ref-classes-packagegroup: @@ -1883,10 +1883,10 @@ Previously, this class was called the ``task`` class. ================= The ``patch`` class provides all functionality for applying patches -during the ```do_patch`` <#ref-tasks-patch>`__ task. +during the :ref:`ref-tasks-patch` task. This class is enabled by default because it is inherited by the -```base`` <#ref-classes-base>`__ class. +:ref:`base ` class. .. _ref-classes-perlnative: @@ -1912,7 +1912,7 @@ host during image creation. If the pixbuf loaders being installed are in packages other than the recipe's main package, set -```PIXBUF_PACKAGES`` <#var-PIXBUF_PACKAGES>`__ to specify the packages +:term:`PIXBUF_PACKAGES` to specify the packages containing the loaders. .. _ref-classes-pkgconfig: @@ -1936,7 +1936,7 @@ files. The ``populate_sdk`` class provides support for SDK-only recipes. For information on advantages gained when building a cross-development -toolchain using the ```do_populate_sdk`` <#ref-tasks-populate_sdk>`__ +toolchain using the :ref:`ref-tasks-populate_sdk` task, see the "`Building an SDK Installer <&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer>`__" section in the Yocto Project Application Development and the Extensible @@ -1967,15 +1967,15 @@ following classes: The ``populate_sdk_base`` class inherits the appropriate ``populate_sdk_*`` (i.e. ``deb``, ``rpm``, and ``ipk``) based on -```IMAGE_PKGTYPE`` <#var-IMAGE_PKGTYPE>`__. +:term:`IMAGE_PKGTYPE`. The base class ensures all source and destination directories are established and then populates the SDK. After populating the SDK, the ``populate_sdk_base`` class constructs two sysroots: -``${``\ ```SDK_ARCH`` <#var-SDK_ARCH>`__\ ``}-nativesdk``, which +``${``\ :term:`SDK_ARCH`\ ``}-nativesdk``, which contains the cross-compiler and associated tooling, and the target, which contains a target root filesystem that is configured for the SDK -usage. These two images reside in ```SDK_OUTPUT`` <#var-SDK_OUTPUT>`__, +usage. These two images reside in :term:`SDK_OUTPUT`, which consists of the following: ${SDK_OUTPUT}/${SDK_ARCH}-nativesdk-pkgs ${SDK_OUTPUT}/${SDKTARGETSYSROOT}/target-pkgs @@ -1993,7 +1993,7 @@ the "`Cross-Development Toolchain Generation <&YOCTO_DOCS_OM_URL;#cross-development-toolchain-generation>`__" section in the Yocto Project Overview and Concepts Manual. For information on advantages gained when building a cross-development -toolchain using the ```do_populate_sdk`` <#ref-tasks-populate_sdk>`__ +toolchain using the :ref:`ref-tasks-populate_sdk` task, see the "`Building an SDK Installer <&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer>`__" section in the Yocto Project Application Development and the Extensible @@ -2005,7 +2005,7 @@ Software Development Kit (eSDK) manual. ==================== The ``prexport`` class provides functionality for exporting -```PR`` <#var-PR>`__ values. +:term:`PR` values. .. note:: @@ -2020,7 +2020,7 @@ The ``prexport`` class provides functionality for exporting ==================== The ``primport`` class provides functionality for importing -```PR`` <#var-PR>`__ values. +:term:`PR` values. .. note:: @@ -2036,13 +2036,13 @@ The ``primport`` class provides functionality for importing The ``prserv`` class provides functionality for using a `PR service <&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service>`__ in order to -automatically manage the incrementing of the ```PR`` <#var-PR>`__ +automatically manage the incrementing of the :term:`PR` variable for each recipe. This class is enabled by default because it is inherited by the -```package`` <#ref-classes-package>`__ class. However, the OpenEmbedded +:ref:`package ` class. However, the OpenEmbedded build system will not enable the functionality of this class unless -```PRSERV_HOST`` <#var-PRSERV_HOST>`__ has been set. +:term:`PRSERV_HOST` has been set. .. _ref-classes-ptest: @@ -2054,7 +2054,7 @@ runtime tests for recipes that build software that provides these tests. This class is intended to be inherited by individual recipes. However, the class' functionality is largely disabled unless "ptest" appears in -```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__. See the "`Testing +:term:`DISTRO_FEATURES`. See the "`Testing Packages With ptest <&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest>`__" section in the Yocto Project Development Tasks Manual for more information on @@ -2126,9 +2126,9 @@ are set or software that is present). The ``relocatable`` class enables relocation of binaries when they are installed into the sysroot. -This class makes use of the ```chrpath`` <#ref-classes-chrpath>`__ class -and is used by both the ```cross`` <#ref-classes-cross>`__ and -```native`` <#ref-classes-native>`__ classes. +This class makes use of the :ref:`chrpath ` class +and is used by both the :ref:`cross ` and +:ref:`native ` classes. .. _ref-classes-remove-libtool: @@ -2136,7 +2136,7 @@ and is used by both the ```cross`` <#ref-classes-cross>`__ and ========================== The ``remove-libtool`` class adds a post function to the -```do_install`` <#ref-tasks-install>`__ task to remove all ``.la`` files +:ref:`ref-tasks-install` task to remove all ``.la`` files installed by ``libtool``. Removing these files results in them being absent from both the sysroot and target packages. @@ -2163,7 +2163,7 @@ The class collects debug information for recipe, recipe version, task, machine, distro, build system, target system, host distro, branch, commit, and log. From the information, report files using a JSON format are created and stored in -``${``\ ```LOG_DIR`` <#var-LOG_DIR>`__\ ``}/error-report``. +``${``\ :term:`LOG_DIR`\ ``}/error-report``. .. _ref-classes-rm-work: @@ -2216,7 +2216,7 @@ image and consist of the following classes: The root filesystem is created from packages using one of the ``rootfs*.bbclass`` files as determined by the -```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ variable. +:term:`PACKAGE_CLASSES` variable. For information on how root filesystem images are created, see the "`Image @@ -2242,7 +2242,7 @@ usually determines whether to include this class. The ``scons`` class supports recipes that need to build software that uses the SCons build system. You can use the -```EXTRA_OESCONS`` <#var-EXTRA_OESCONS>`__ variable to specify +:term:`EXTRA_OESCONS` variable to specify additional configuration options you want to pass SCons command line. .. _ref-classes-sdl: @@ -2293,8 +2293,8 @@ Python bindings. The ``siteconfig`` class provides functionality for handling site configuration. The class is used by the -```autotools`` <#ref-classes-autotools>`__ class to accelerate the -```do_configure`` <#ref-tasks-configure>`__ task. +:ref:`autotools ` class to accelerate the +:ref:`ref-tasks-configure` task. .. _ref-classes-siteinfo: @@ -2337,7 +2337,7 @@ build. The ``sstate`` class provides support for Shared State (sstate). By default, the class is enabled through the -```INHERIT_DISTRO`` <#var-INHERIT_DISTRO>`__ variable's default value. +:term:`INHERIT_DISTRO` variable's default value. For more information on sstate, see the "`Shared State Cache <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__" section in the Yocto @@ -2351,15 +2351,15 @@ Project Overview and Concepts Manual. The ``staging`` class installs files into individual recipe work directories for sysroots. The class contains the following key tasks: -- The ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task, +- The :ref:`ref-tasks-populate_sysroot` task, which is responsible for handing the files that end up in the recipe sysroots. - The - ```do_prepare_recipe_sysroot`` <#ref-tasks-prepare_recipe_sysroot>`__ + :ref:`ref-tasks-prepare_recipe_sysroot` task (a "partner" task to the ``populate_sysroot`` task), which installs the files into the individual recipe work directories (i.e. - ```WORKDIR`` <#var-WORKDIR>`__). + :term:`WORKDIR`). The code in the ``staging`` class is complex and basically works in two stages: @@ -2367,13 +2367,13 @@ stages: - *Stage One:* The first stage addresses recipes that have files they want to share with other recipes that have dependencies on the originating recipe. Normally these dependencies are installed through - the ```do_install`` <#ref-tasks-install>`__ task into - ``${``\ ```D`` <#var-D>`__\ ``}``. The ``do_populate_sysroot`` task + the :ref:`ref-tasks-install` task into + ``${``\ :term:`D`\ ``}``. The ``do_populate_sysroot`` task copies a subset of these files into ``${SYSROOT_DESTDIR}``. This subset of files is controlled by the - ```SYSROOT_DIRS`` <#var-SYSROOT_DIRS>`__, - ```SYSROOT_DIRS_NATIVE`` <#var-SYSROOT_DIRS_NATIVE>`__, and - ```SYSROOT_DIRS_BLACKLIST`` <#var-SYSROOT_DIRS_BLACKLIST>`__ + :term:`SYSROOT_DIRS`, + :term:`SYSROOT_DIRS_NATIVE`, and + :term:`SYSROOT_DIRS_BLACKLIST` variables. .. note:: @@ -2391,17 +2391,17 @@ stages: hardcoded locations are replaced by tokens and a list of the files needing such replacements is created. These adjustments are referred to as "FIXMEs". The list of files that are scanned for paths is - controlled by the ```SSTATE_SCAN_FILES`` <#var-SSTATE_SCAN_FILES>`__ + controlled by the :term:`SSTATE_SCAN_FILES` variable. - *Stage Two:* The second stage addresses recipes that want to use something from another recipe and declare a dependency on that recipe - through the ```DEPENDS`` <#var-DEPENDS>`__ variable. The recipe will + through the :term:`DEPENDS` variable. The recipe will have a - ```do_prepare_recipe_sysroot`` <#ref-tasks-prepare_recipe_sysroot>`__ + :ref:`ref-tasks-prepare_recipe_sysroot` task and when this task executes, it creates the ``recipe-sysroot`` and ``recipe-sysroot-native`` in the recipe work directory (i.e. - ```WORKDIR`` <#var-WORKDIR>`__). The OpenEmbedded build system + :term:`WORKDIR`). The OpenEmbedded build system creates hard links to copies of the relevant files from ``sysroots-components`` into the recipe work directory. @@ -2437,7 +2437,7 @@ stages: is used so that builds should be identical regardless of whether sstate was used or not. For a closer look, see the ``setscene_depvalid()`` function in the - ```sstate`` <#ref-classes-sstate>`__ class. + :ref:`sstate ` class. The build system is careful to maintain manifests of the files it installs so that any given dependency can be installed as needed. The @@ -2454,37 +2454,37 @@ bootable images. The class supports the following variables: -- ```INITRD`` <#var-INITRD>`__: Indicates list of filesystem images to +- :term:`INITRD`: Indicates list of filesystem images to concatenate and use as an initial RAM disk (initrd). This variable is optional. -- ```ROOTFS`` <#var-ROOTFS>`__: Indicates a filesystem image to include +- :term:`ROOTFS`: Indicates a filesystem image to include as the root filesystem. This variable is optional. -- ```AUTO_SYSLINUXMENU`` <#var-AUTO_SYSLINUXMENU>`__: Enables creating +- :term:`AUTO_SYSLINUXMENU`: Enables creating an automatic menu when set to "1". -- ```LABELS`` <#var-LABELS>`__: Lists targets for automatic +- :term:`LABELS`: Lists targets for automatic configuration. -- ```APPEND`` <#var-APPEND>`__: Lists append string overrides for each +- :term:`APPEND`: Lists append string overrides for each label. -- ```SYSLINUX_OPTS`` <#var-SYSLINUX_OPTS>`__: Lists additional options +- :term:`SYSLINUX_OPTS`: Lists additional options to add to the syslinux file. Semicolon characters separate multiple options. -- ```SYSLINUX_SPLASH`` <#var-SYSLINUX_SPLASH>`__: Lists a background +- :term:`SYSLINUX_SPLASH`: Lists a background for the VGA boot menu when you are using the boot menu. -- ```SYSLINUX_DEFAULT_CONSOLE`` <#var-SYSLINUX_DEFAULT_CONSOLE>`__: Set +- :term:`SYSLINUX_DEFAULT_CONSOLE`: Set to "console=ttyX" to change kernel boot default console. -- ```SYSLINUX_SERIAL`` <#var-SYSLINUX_SERIAL>`__: Sets an alternate +- :term:`SYSLINUX_SERIAL`: Sets an alternate serial port. Or, turns off serial when the variable is set with an empty string. -- ```SYSLINUX_SERIAL_TTY`` <#var-SYSLINUX_SERIAL_TTY>`__: Sets an +- :term:`SYSLINUX_SERIAL_TTY`: Sets an alternate "console=tty..." kernel boot argument. .. _ref-classes-systemd: @@ -2496,24 +2496,24 @@ The ``systemd`` class provides support for recipes that install systemd unit files. The functionality for this class is disabled unless you have "systemd" -in ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__. +in :term:`DISTRO_FEATURES`. Under this class, the recipe or Makefile (i.e. whatever the recipe is -calling during the ```do_install`` <#ref-tasks-install>`__ task) +calling during the :ref:`ref-tasks-install` task) installs unit files into -``${``\ ```D`` <#var-D>`__\ ``}${systemd_unitdir}/system``. If the unit +``${``\ :term:`D`\ ``}${systemd_unitdir}/system``. If the unit files being installed go into packages other than the main package, you -need to set ```SYSTEMD_PACKAGES`` <#var-SYSTEMD_PACKAGES>`__ in your +need to set :term:`SYSTEMD_PACKAGES` in your recipe to identify the packages in which the files will be installed. -You should set ```SYSTEMD_SERVICE`` <#var-SYSTEMD_SERVICE>`__ to the +You should set :term:`SYSTEMD_SERVICE` to the name of the service file. You should also use a package name override to indicate the package to which the value applies. If the value applies to -the recipe's main package, use ``${``\ ```PN`` <#var-PN>`__\ ``}``. Here +the recipe's main package, use ``${``\ :term:`PN`\ ``}``. Here is an example from the connman recipe: SYSTEMD_SERVICE_${PN} = "connman.service" Services are set up to start on boot automatically unless you have set -```SYSTEMD_AUTO_ENABLE`` <#var-SYSTEMD_AUTO_ENABLE>`__ to "disable". +:term:`SYSTEMD_AUTO_ENABLE` to "disable". For more information on ``systemd``, see the "`Selecting an Initialization @@ -2539,14 +2539,14 @@ internal class and is not intended to be used directly. systemd project. -Set the ```EFI_PROVIDER`` <#var-EFI_PROVIDER>`__ variable to +Set the :term:`EFI_PROVIDER` variable to "systemd-boot" to use this class. Doing so creates a standalone EFI bootloader that is not dependent on systemd. For information on more variables used and supported in this class, see -the ```SYSTEMD_BOOT_CFG`` <#var-SYSTEMD_BOOT_CFG>`__, -```SYSTEMD_BOOT_ENTRIES`` <#var-SYSTEMD_BOOT_ENTRIES>`__, and -```SYSTEMD_BOOT_TIMEOUT`` <#var-SYSTEMD_BOOT_TIMEOUT>`__ variables. +the :term:`SYSTEMD_BOOT_CFG`, +:term:`SYSTEMD_BOOT_ENTRIES`, and +:term:`SYSTEMD_BOOT_TIMEOUT` variables. You can also see the `Systemd-boot documentation `__ @@ -2558,15 +2558,15 @@ for more information. ==================== The ``terminal`` class provides support for starting a terminal session. -The ```OE_TERMINAL`` <#var-OE_TERMINAL>`__ variable controls which +The :term:`OE_TERMINAL` variable controls which terminal emulator is used for the session. Other classes use the ``terminal`` class anywhere a separate terminal session needs to be started. For example, the -```patch`` <#ref-classes-patch>`__ class assuming -```PATCHRESOLVE`` <#var-PATCHRESOLVE>`__ is set to "user", the +:ref:`patch ` class assuming +:term:`PATCHRESOLVE` is set to "user", the ```cml1`` <#ref-classes-cml1>`__ class, and the -```devshell`` <#ref-classes-devshell>`__ class all use the ``terminal`` +:ref:`devshell ` class all use the ``terminal`` class. .. _ref-classes-testimage*: @@ -2595,7 +2595,7 @@ test is written in Python and makes use of the ``unittest`` module. The ``testimage.bbclass`` runs tests on an image when called using the following: $ bitbake -c testimage image The ``testimage-auto`` class runs tests on an image after the image is constructed (i.e. -```TESTIMAGE_AUTO`` <#var-TESTIMAGE_AUTO>`__ must be set to "1"). +:term:`TESTIMAGE_AUTO` must be set to "1"). For information on how to enable, run, and create new tests, see the "`Performing Automated Runtime @@ -2693,8 +2693,8 @@ The ``uboot-config`` class provides support for U-Boot configuration for a machine. Specify the machine in your recipe as follows: UBOOT_CONFIG ??= UBOOT_CONFIG[foo] = "config,images" You can also specify the machine using this method: UBOOT_MACHINE = "config" See the -```UBOOT_CONFIG`` <#var-UBOOT_CONFIG>`__ and -```UBOOT_MACHINE`` <#var-UBOOT_MACHINE>`__ variables for additional +:term:`UBOOT_CONFIG` and +:term:`UBOOT_MACHINE` variables for additional information. .. _ref-classes-uninative: @@ -2738,13 +2738,13 @@ packages. To use this class, you need to define a number of variables: -- ```ALTERNATIVE`` <#var-ALTERNATIVE>`__ +- :term:`ALTERNATIVE` -- ```ALTERNATIVE_LINK_NAME`` <#var-ALTERNATIVE_LINK_NAME>`__ +- :term:`ALTERNATIVE_LINK_NAME` -- ```ALTERNATIVE_TARGET`` <#var-ALTERNATIVE_TARGET>`__ +- :term:`ALTERNATIVE_TARGET` -- ```ALTERNATIVE_PRIORITY`` <#var-ALTERNATIVE_PRIORITY>`__ +- :term:`ALTERNATIVE_PRIORITY` These variables list alternative commands needed by a package, provide pathnames for links, default links for targets, and so forth. For @@ -2783,7 +2783,7 @@ usage by the package on the target. For example, if you have packages that contain system services that should be run under their own user or group, you can use these classes to enable creation of the user or group. The ``meta-skeleton/recipes-skeleton/useradd/useradd-example.bb`` -recipe in the `Source Directory <#source-directory>`__ provides a simple +recipe in the :term:`Source Directory` provides a simple example that shows how to add three users and groups to two packages. See the ``useradd-example.bb`` recipe for more information on how to use these classes. @@ -2792,10 +2792,10 @@ The ``useradd_base`` class provides basic functionality for user or groups settings. The ``useradd*`` classes support the -```USERADD_PACKAGES`` <#var-USERADD_PACKAGES>`__, -```USERADD_PARAM`` <#var-USERADD_PARAM>`__, -```GROUPADD_PARAM`` <#var-GROUPADD_PARAM>`__, and -```GROUPMEMS_PARAM`` <#var-GROUPMEMS_PARAM>`__ variables. +:term:`USERADD_PACKAGES`, +:term:`USERADD_PARAM`, +:term:`GROUPADD_PARAM`, and +:term:`GROUPMEMS_PARAM` variables. The ``useradd-staticids`` class supports the addition of users or groups that have static user identification (``uid``) and group identification @@ -2810,15 +2810,15 @@ the final ``uid`` and ``gid`` values. However, if non-deterministic ``uid`` and ``gid`` values are a problem, you can override the default, dynamic application of these values by setting static values. When you set static values, the OpenEmbedded build system looks in -```BBPATH`` <#var-BBPATH>`__ for ``files/passwd`` and ``files/group`` +:term:`BBPATH` for ``files/passwd`` and ``files/group`` files for the values. To use static ``uid`` and ``gid`` values, you need to set some -variables. See the ```USERADDEXTENSION`` <#var-USERADDEXTENSION>`__, -```USERADD_UID_TABLES`` <#var-USERADD_UID_TABLES>`__, -```USERADD_GID_TABLES`` <#var-USERADD_GID_TABLES>`__, and -```USERADD_ERROR_DYNAMIC`` <#var-USERADD_ERROR_DYNAMIC>`__ variables. -You can also see the ```useradd`` <#ref-classes-useradd>`__ class for +variables. See the :term:`USERADDEXTENSION`, +:term:`USERADD_UID_TABLES`, +:term:`USERADD_GID_TABLES`, and +:term:`USERADD_ERROR_DYNAMIC` variables. +You can also see the :ref:`useradd ` class for additional information. .. note:: @@ -2844,11 +2844,11 @@ additional information. The ``utility-tasks`` class provides support for various "utility" type tasks that are applicable to all recipes, such as -```do_clean`` <#ref-tasks-clean>`__ and -```do_listtasks`` <#ref-tasks-listtasks>`__. +:ref:`ref-tasks-clean` and +:ref:`ref-tasks-listtasks`. This class is enabled by default because it is inherited by the -```base`` <#ref-classes-base>`__ class. +:ref:`base ` class. .. _ref-classes-utils: @@ -2860,7 +2860,7 @@ typically used in inline Python expressions (e.g. ``${@...}``). One example use is for ``bb.utils.contains()``. This class is enabled by default because it is inherited by the -```base`` <#ref-classes-base>`__ class. +:ref:`base ` class. .. _ref-classes-vala: @@ -2877,7 +2877,7 @@ using the Vala programming language. The ``waf`` class supports recipes that need to build software that uses the Waf build system. You can use the -```EXTRA_OECONF`` <#var-EXTRA_OECONF>`__ or -```PACKAGECONFIG_CONFARGS`` <#var-PACKAGECONFIG_CONFARGS>`__ variables +:term:`EXTRA_OECONF` or +:term:`PACKAGECONFIG_CONFARGS` variables to specify additional configuration options to be passed on the Waf command line. diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst index 5bb1a64d99..b0c4bcc7a0 100644 --- a/documentation/ref-manual/ref-devtool-reference.rst +++ b/documentation/ref-manual/ref-devtool-reference.rst @@ -217,7 +217,7 @@ Git, checks out a branch for development, and applies any patches from the recipe as commits on top. You can use the following command to checkout the source files: $ devtool modify recipe Using the above command form, ``devtool`` uses the existing recipe's -```SRC_URI`` <#var-SRC_URI>`__ statement to locate the upstream source, +:term:`SRC_URI` statement to locate the upstream source, extracts the source into the default sources location in the workspace. The default development branch used is "devtool". @@ -360,9 +360,9 @@ When you use the ``devtool upgrade`` command, you must supply the root name of the recipe (i.e. no version, paths, or extensions), and you must supply the directory to which you want the source extracted. Additional command options let you control things such as the version number to -which you want to upgrade (i.e. the ```PV`` <#var-PV>`__), the source +which you want to upgrade (i.e. the :term:`PV`), the source revision to which you want to upgrade (i.e. the -```SRCREV`` <#var-SRCREV>`__), whether or not to apply patches, and so +:term:`SRCREV`), whether or not to apply patches, and so forth. You can read more on the ``devtool upgrade`` workflow in the "`Use @@ -439,7 +439,7 @@ The target is the address of the target machine, which must be running an SSH server (i.e. ``user@hostname[:destdir]``). This command deploys all files installed during the -```do_install`` <#ref-tasks-install>`__ task. Furthermore, you do not +:ref:`ref-tasks-install` task. Furthermore, you do not need to have package management enabled within the target machine. If you do, the package manager is bypassed. @@ -492,7 +492,7 @@ Creating the Workspace Layer in an Alternative Location ======================================================= Use the ``devtool create-workspace`` command to create a new workspace -layer in your `Build Directory <#build-directory>`__. When you create a +layer in your :term:`Build Directory`. When you create a new workspace layer, it is populated with the ``README`` file and the ``conf`` directory only. diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst index 1aa57a27d4..0e901edaeb 100644 --- a/documentation/ref-manual/ref-features.rst +++ b/documentation/ref-manual/ref-features.rst @@ -24,7 +24,7 @@ included if the distribution itself does not support them. One method you can use to determine which recipes are checking to see if a particular feature is contained or not is to ``grep`` through the -`Metadata <#metadata>`__ for the feature. Here is an example that +:term:`Metadata` for the feature. Here is an example that discovers the recipes whose build is potentially changed based on a given feature: $ cd poky $ git grep 'contains.*MACHINE_FEATURES.*feature' @@ -35,12 +35,12 @@ Machine Features ================ The items below are features you can use with -```MACHINE_FEATURES`` <#var-MACHINE_FEATURES>`__. Features do not have a +:term:`MACHINE_FEATURES`. Features do not have a one-to-one correspondence to packages, and they can go beyond simply controlling the installation of a package or packages. Sometimes a feature can influence how certain recipes are built. For example, a feature might determine whether a particular configure option is -specified within the ```do_configure`` <#ref-tasks-configure>`__ task +specified within the :ref:`ref-tasks-configure` task for a particular recipe. This feature list only represents features as shipped with the Yocto @@ -92,18 +92,18 @@ Distro Features =============== The items below are features you can use with -```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ to enable features across +:term:`DISTRO_FEATURES` to enable features across your distribution. Features do not have a one-to-one correspondence to packages, and they can go beyond simply controlling the installation of a package or packages. In most cases, the presence or absence of a feature translates to the appropriate option supplied to the configure -script during the ```do_configure`` <#ref-tasks-configure>`__ task for +script during the :ref:`ref-tasks-configure` task for the recipes that optionally support the feature. Some distro features are also machine features. These select features make sense to be controlled both at the machine and distribution configuration level. See the -```COMBINED_FEATURES`` <#var-COMBINED_FEATURES>`__ variable for more +:term:`COMBINED_FEATURES` variable for more information. This list only represents features as shipped with the Yocto Project @@ -189,8 +189,8 @@ Image Features ============== The contents of images generated by the OpenEmbedded build system can be -controlled by the ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ and -```EXTRA_IMAGE_FEATURES`` <#var-EXTRA_IMAGE_FEATURES>`__ variables that +controlled by the :term:`IMAGE_FEATURES` and +:term:`EXTRA_IMAGE_FEATURES` variables that you typically configure in your image recipes. Through these variables, you can add several different predefined packages such as development utilities or packages with debug information needed to investigate @@ -254,7 +254,7 @@ The following image features are available for all images: a given image. Some image features are available only when you inherit the -```core-image`` <#ref-classes-core-image>`__ class. The current list of +:ref:`core-image ` class. The current list of these valid features is as follows: - *hwcodecs:* Installs hardware acceleration codecs. @@ -299,8 +299,8 @@ Feature Backfilling =================== Sometimes it is necessary in the OpenEmbedded build system to extend -```MACHINE_FEATURES`` <#var-MACHINE_FEATURES>`__ or -```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ to control functionality +:term:`MACHINE_FEATURES` or +:term:`DISTRO_FEATURES` to control functionality that was previously enabled and not able to be disabled. For these cases, we need to add an additional feature item to appear in one of these variables, but we do not want to force developers who have @@ -310,8 +310,8 @@ Thus, the OpenEmbedded build system has a mechanism to automatically "backfill" these added features into existing distro or machine configurations. You can see the list of features for which this is done by finding the -```DISTRO_FEATURES_BACKFILL`` <#var-DISTRO_FEATURES_BACKFILL>`__ and -```MACHINE_FEATURES_BACKFILL`` <#var-MACHINE_FEATURES_BACKFILL>`__ +:term:`DISTRO_FEATURES_BACKFILL` and +:term:`MACHINE_FEATURES_BACKFILL` variables in the ``meta/conf/bitbake.conf`` file. Because such features are backfilled by default into all configurations @@ -319,9 +319,9 @@ as described in the previous paragraph, developers who wish to disable the new features need to be able to selectively prevent the backfilling from occurring. They can do this by adding the undesired feature or features to the -```DISTRO_FEATURES_BACKFILL_CONSIDERED`` <#var-DISTRO_FEATURES_BACKFILL_CONSIDERED>`__ +:term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` or -```MACHINE_FEATURES_BACKFILL_CONSIDERED`` <#var-MACHINE_FEATURES_BACKFILL_CONSIDERED>`__ +:term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` variables for distro features and machine features respectively. Here are two examples to help illustrate feature backfilling: diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/ref-images.rst index f0f8398338..5aeaa43833 100644 --- a/documentation/ref-manual/ref-images.rst +++ b/documentation/ref-manual/ref-images.rst @@ -86,7 +86,7 @@ Following is a list of supported recipes: has the Minimal RAM-based Initial Root Filesystem (initramfs) as part of the kernel, which allows the system to find the first “init” program more efficiently. See the - ```PACKAGE_INSTALL`` <#var-PACKAGE_INSTALL>`__ variable for + :term:`PACKAGE_INSTALL` variable for additional information helpful when working with initramfs images. - ``core-image-minimal-mtdutils``: A ``core-image-minimal`` image that diff --git a/documentation/ref-manual/ref-kickstart.rst b/documentation/ref-manual/ref-kickstart.rst index 599e38080c..5f8c834f33 100644 --- a/documentation/ref-manual/ref-kickstart.rst +++ b/documentation/ref-manual/ref-kickstart.rst @@ -167,7 +167,7 @@ the ``part`` and ``partition`` commands: - *``--fsuuid``:* This option is a Wic-specific option that specifies the filesystem UUID. You can generate or modify - ```WKS_FILE`` <#var-WKS_FILE>`__ with this option if a preconfigured + :term:`WKS_FILE` with this option if a preconfigured filesystem UUID is added to the kernel command line in the bootloader configuration before you run Wic. diff --git a/documentation/ref-manual/ref-qa-checks.rst b/documentation/ref-manual/ref-qa-checks.rst index e83fad8e10..d60c0616f0 100644 --- a/documentation/ref-manual/ref-qa-checks.rst +++ b/documentation/ref-manual/ref-qa-checks.rst @@ -28,7 +28,7 @@ error form along with an explanation. .. note:: - At the end of each message, the name of the associated QA test (as - listed in the "```insane.bbclass`` <#ref-classes-insane>`__" + listed in the ":ref:`insane.bbclass `" section) appears within square brackets. - As mentioned, this list of error and warning messages is for QA @@ -56,10 +56,10 @@ Errors and Warnings The specified binary produced by the recipe contains dynamic library load paths (rpaths) that contain build system paths such as - ```TMPDIR`` <#var-TMPDIR>`__, which are incorrect for the target and + :term:`TMPDIR`, which are incorrect for the target and could potentially be a security issue. Check for bad ``-rpath`` options being passed to the linker in your - ```do_compile`` <#ref-tasks-compile>`__ log. Depending on the build + :ref:`ref-tasks-compile` log. Depending on the build system used by the software being built, there might be a configure option to disable rpath usage completely within the build of the software. @@ -82,7 +82,7 @@ Errors and Warnings A file-level dependency has been identified from the specified package on the specified files, but there is no explicit - corresponding entry in ```RDEPENDS`` <#var-RDEPENDS>`__. If + corresponding entry in :term:`RDEPENDS`. If particular files are required at runtime then ``RDEPENDS`` should be declared in the recipe to ensure the packages providing them are built. @@ -95,7 +95,7 @@ Errors and Warnings there is nothing explicit within the recipe to enable the OpenEmbedded build system to ensure that dependency is satisfied. This condition is usually triggered by an - ```RDEPENDS`` <#var-RDEPENDS>`__ value being added at the packaging + :term:`RDEPENDS` value being added at the packaging stage rather than up front, which is usually automatic based on the contents of the package. In most cases, you should change the recipe to add an explicit ``RDEPENDS`` for the dependency. @@ -107,8 +107,8 @@ Errors and Warnings Symlink ``.so`` files are for development only, and should therefore go into the ``-dev`` package. This situation might occur if you add ``*.so*`` rather than ``*.so.*`` to a non-dev package. Change - ```FILES`` <#var-FILES>`__ (and possibly - ```PACKAGES`` <#var-PACKAGES>`__) such that the specified ``.so`` + :term:`FILES` (and possibly + :term:`PACKAGES`) such that the specified ``.so`` file goes into an appropriate ``-dev`` package.   @@ -116,8 +116,8 @@ Errors and Warnings - ``non -staticdev package contains static .a library: path '' [staticdev]`` Static ``.a`` library files should go into a ``-staticdev`` package. - Change ```FILES`` <#var-FILES>`__ (and possibly - ```PACKAGES`` <#var-PACKAGES>`__) such that the specified ``.a`` file + Change :term:`FILES` (and possibly + :term:`PACKAGES`) such that the specified ``.a`` file goes into an appropriate ``-staticdev`` package.   @@ -130,7 +130,7 @@ Errors and Warnings "lib32". Another example is when recipes install ``/usr/lib64/foo.so`` when ``${libdir}`` is "/usr/lib". False positives occasionally exist. For these cases add "libdir" to - ```INSANE_SKIP`` <#var-INSANE_SKIP>`__ for the package. + :term:`INSANE_SKIP` for the package.   @@ -141,7 +141,7 @@ Errors and Warnings occur if you add a path which contains a ``.debug`` directory and do not explicitly add the ``.debug`` directory to the ``-dbg`` package. If this is the case, add the ``.debug`` directory explicitly to - ``FILES_${PN}-dbg``. See ```FILES`` <#var-FILES>`__ for additional + ``FILES_${PN}-dbg``. See :term:`FILES` for additional information on ``FILES``.   @@ -158,8 +158,8 @@ Errors and Warnings the error for is firmware that is not intended to be executed within the target operating system or is intended to run on a separate processor within the device, you can add "arch" to - ```INSANE_SKIP`` <#var-INSANE_SKIP>`__ for the package. Another - option is to check the ```do_compile`` <#ref-tasks-compile>`__ log + :term:`INSANE_SKIP` for the package. Another + option is to check the :ref:`ref-tasks-compile` log and verify that the compiler options being used are correct.   @@ -176,8 +176,8 @@ Errors and Warnings the error for is firmware that is not intended to be executed within the target operating system or is intended to run on a separate processor within the device, you can add "arch" to - ```INSANE_SKIP`` <#var-INSANE_SKIP>`__ for the package. Another - option is to check the ```do_compile`` <#ref-tasks-compile>`__ log + :term:`INSANE_SKIP` for the package. Another + option is to check the :ref:`ref-tasks-compile` log and verify that the compiler options being used are correct.   @@ -194,8 +194,8 @@ Errors and Warnings the error for is firmware that is not intended to be executed within the target operating system or is intended to run on a separate processor within the device, you can add "arch" to - ```INSANE_SKIP`` <#var-INSANE_SKIP>`__ for the package. Another - option is to check the ```do_compile`` <#ref-tasks-compile>`__ log + :term:`INSANE_SKIP` for the package. Another + option is to check the :ref:`ref-tasks-compile` log and verify that the compiler options being used are correct.   @@ -208,7 +208,7 @@ Errors and Warnings Typically, the way to solve this performance issue is to add "-fPIC" or "-fpic" to the compiler command-line options. For example, given - software that reads ```CFLAGS`` <#var-CFLAGS>`__ when you build it, + software that reads :term:`CFLAGS` when you build it, you could add the following to your recipe: CFLAGS_append = " -fPIC " For more information on text relocations at runtime, see @@ -219,11 +219,11 @@ Errors and Warnings - ``No GNU_HASH in the elf binary: '' [ldflags]`` This indicates that binaries produced when building the recipe have - not been linked with the ```LDFLAGS`` <#var-LDFLAGS>`__ options + not been linked with the :term:`LDFLAGS` options provided by the build system. Check to be sure that the ``LDFLAGS`` variable is being passed to the linker command. A common workaround for this situation is to pass in ``LDFLAGS`` using - ```TARGET_CC_ARCH`` <#var-TARGET_CC_ARCH>`__ within the recipe as + :term:`TARGET_CC_ARCH` within the recipe as follows: TARGET_CC_ARCH += "${LDFLAGS}"   @@ -243,7 +243,7 @@ Errors and Warnings - ``The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir]`` The ``/usr/share/info/dir`` should not be packaged. Add the following - line to your ```do_install`` <#ref-tasks-install>`__ task or to your + line to your :ref:`ref-tasks-install` task or to your ``do_install_append`` within the recipe as follows: rm ${D}${infodir}/dir @@ -251,7 +251,7 @@ Errors and Warnings - ``Symlink in points to TMPDIR [symlink-to-sysroot]`` - The specified symlink points into ```TMPDIR`` <#var-TMPDIR>`__ on the + The specified symlink points into :term:`TMPDIR` on the host. Such symlinks will work on the host. However, they are clearly invalid when running on the target. You should either correct the symlink to use a relative path or remove the symlink. @@ -260,7 +260,7 @@ Errors and Warnings - `` failed sanity test (workdir) in path [la]`` - The specified ``.la`` file contains ```TMPDIR`` <#var-TMPDIR>`__ + The specified ``.la`` file contains :term:`TMPDIR` paths. Any ``.la`` file containing these paths is incorrect since ``libtool`` adds the correct sysroot prefix when using the files automatically itself. @@ -270,7 +270,7 @@ Errors and Warnings - `` failed sanity test (tmpdir) in path [pkgconfig]`` The specified ``.pc`` file contains - ```TMPDIR`` <#var-TMPDIR>`__\ ``/``\ ```WORKDIR`` <#var-WORKDIR>`__ + :term:`TMPDIR`\ ``/``\ :term:`WORKDIR` paths. Any ``.pc`` file containing these paths is incorrect since ``pkg-config`` itself adds the correct sysroot prefix when the files are accessed. @@ -285,9 +285,9 @@ Errors and Warnings brought in using several different methods: - Using the ``dbg-pkgs`` - ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ value. + :term:`IMAGE_FEATURES` value. - - Using ```IMAGE_INSTALL`` <#var-IMAGE_INSTALL>`__. + - Using :term:`IMAGE_INSTALL`. - As a dependency of another ``dbg`` package that was brought in using one of the above methods. @@ -295,7 +295,7 @@ Errors and Warnings The dependency might have been automatically added because the ``dbg`` package erroneously contains files that it should not contain (e.g. a non-symlink ``.so`` file) or it might have been added - manually (e.g. by adding to ```RDEPENDS`` <#var-RDEPENDS>`__). + manually (e.g. by adding to :term:`RDEPENDS`).   @@ -307,9 +307,9 @@ Errors and Warnings usually brought in using several different methods: - Using the ``dev-pkgs`` - ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ value. + :term:`IMAGE_FEATURES` value. - - Using ```IMAGE_INSTALL`` <#var-IMAGE_INSTALL>`__. + - Using :term:`IMAGE_INSTALL`. - As a dependency of another ``dev`` package that was brought in using one of the above methods. @@ -317,19 +317,19 @@ Errors and Warnings The dependency might have been automatically added (because the ``dev`` package erroneously contains files that it should not have (e.g. a non-symlink ``.so`` file) or it might have been added - manually (e.g. by adding to ```RDEPENDS`` <#var-RDEPENDS>`__). + manually (e.g. by adding to :term:`RDEPENDS`).   - ``_ is invalid: () only comparisons <, =, >, <=, and >= are allowed [dep-cmp]`` If you are adding a versioned dependency relationship to one of the - dependency variables (```RDEPENDS`` <#var-RDEPENDS>`__, - ```RRECOMMENDS`` <#var-RRECOMMENDS>`__, - ```RSUGGESTS`` <#var-RSUGGESTS>`__, - ```RPROVIDES`` <#var-RPROVIDES>`__, - ```RREPLACES`` <#var-RREPLACES>`__, or - ```RCONFLICTS`` <#var-RCONFLICTS>`__), you must only use the named + dependency variables (:term:`RDEPENDS`, + :term:`RRECOMMENDS`, + :term:`RSUGGESTS`, + :term:`RPROVIDES`, + :term:`RREPLACES`, or + :term:`RCONFLICTS`), you must only use the named comparison operators. Change the versioned dependency values you are adding to match those listed in the message. @@ -337,7 +337,7 @@ Errors and Warnings - ``: The compile log indicates that host include and/or library paths were used. Please check the log '' for more information. [compile-host-path]`` - The log for the ```do_compile`` <#ref-tasks-compile>`__ task + The log for the :ref:`ref-tasks-compile` task indicates that paths on the host were searched for files, which is not appropriate when cross-compiling. Look for "is unsafe for cross-compilation" or "CROSS COMPILE Badness" in the specified log @@ -347,7 +347,7 @@ Errors and Warnings - ``: The install log indicates that host include and/or library paths were used. Please check the log '' for more information. [install-host-path]`` - The log for the ```do_install`` <#ref-tasks-install>`__ task + The log for the :ref:`ref-tasks-install` task indicates that paths on the host were searched for files, which is not appropriate when cross-compiling. Look for "is unsafe for cross-compilation" or "CROSS COMPILE Badness" in the specified log @@ -357,7 +357,7 @@ Errors and Warnings - ``This autoconf log indicates errors, it looked at host include and/or library paths while determining system capabilities. Rerun configure task after fixing this. The path was ''`` - The log for the ```do_configure`` <#ref-tasks-configure>`__ task + The log for the :ref:`ref-tasks-configure` task indicates that paths on the host were searched for files, which is not appropriate when cross-compiling. Look for "is unsafe for cross-compilation" or "CROSS COMPILE Badness" in the specified log @@ -371,7 +371,7 @@ Errors and Warnings enforced by the package manager itself) is to require that package names are all lower case and to allow a restricted set of characters. If your recipe name does not match this, or you add packages to - ```PACKAGES`` <#var-PACKAGES>`__ that do not conform to the + :term:`PACKAGES` that do not conform to the convention, then you will receive this error. Rename your recipe. Or, if you have added a non-conforming package name to ``PACKAGES``, change the package name appropriately. @@ -388,38 +388,38 @@ Errors and Warnings upstream build documentation, the ``./configure --help`` output, and the upstream change log or release notes. Once you have worked out what the appropriate change is, you can update - ```EXTRA_OECONF`` <#var-EXTRA_OECONF>`__, - ```PACKAGECONFIG_CONFARGS`` <#var-PACKAGECONFIG_CONFARGS>`__, or the - individual ```PACKAGECONFIG`` <#var-PACKAGECONFIG>`__ option values + :term:`EXTRA_OECONF`, + :term:`PACKAGECONFIG_CONFARGS`, or the + individual :term:`PACKAGECONFIG` option values accordingly.   - ``Recipe has PN of "" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides]`` - The specified recipe has a name (```PN`` <#var-PN>`__) value that - appears in ```OVERRIDES`` <#var-OVERRIDES>`__. If a recipe is named + The specified recipe has a name (:term:`PN`) value that + appears in :term:`OVERRIDES`. If a recipe is named such that its ``PN`` value matches something already in ``OVERRIDES`` - (e.g. ``PN`` happens to be the same as ```MACHINE`` <#var-MACHINE>`__ - or ```DISTRO`` <#var-DISTRO>`__), it can have unexpected + (e.g. ``PN`` happens to be the same as :term:`MACHINE` + or :term:`DISTRO`), it can have unexpected consequences. For example, assignments such as ``FILES_${PN} = "xyz"`` effectively turn into ``FILES = "xyz"``. Rename your recipe (or if ``PN`` is being set explicitly, change the ``PN`` value) so that the conflict does not occur. See - ```FILES`` <#var-FILES>`__ for additional information. + :term:`FILES` for additional information.   - ``: Variable is set as not being package specific, please fix this. [pkgvarcheck]`` - Certain variables (```RDEPENDS`` <#var-RDEPENDS>`__, - ```RRECOMMENDS`` <#var-RRECOMMENDS>`__, - ```RSUGGESTS`` <#var-RSUGGESTS>`__, - ```RCONFLICTS`` <#var-RCONFLICTS>`__, - ```RPROVIDES`` <#var-RPROVIDES>`__, - ```RREPLACES`` <#var-RREPLACES>`__, ```FILES`` <#var-FILES>`__, + Certain variables (:term:`RDEPENDS`, + :term:`RRECOMMENDS`, + :term:`RSUGGESTS`, + :term:`RCONFLICTS`, + :term:`RPROVIDES`, + :term:`RREPLACES`, :term:`FILES`, ``pkg_preinst``, ``pkg_postinst``, ``pkg_prerm``, ``pkg_postrm``, and - ```ALLOW_EMPTY`` <#var-ALLOW_EMPTY>`__) should always be set specific + :term:`ALLOW_EMPTY`) should always be set specific to a package (i.e. they should be set with a package name override such as ``RDEPENDS_${PN} = "value"`` rather than ``RDEPENDS = "value"``). If you receive this error, correct any @@ -456,7 +456,7 @@ Errors and Warnings - `` is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list]`` Package names must appear only once in the - ```PACKAGES`` <#var-PACKAGES>`__ variable. You might receive this + :term:`PACKAGES` variable. You might receive this error if you are attempting to add a package to ``PACKAGES`` that is already in the variable's value. @@ -465,7 +465,7 @@ Errors and Warnings - ``FILES variable for package contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid]`` The string "//" is invalid in a Unix path. Correct all occurrences - where this string appears in a ```FILES`` <#var-FILES>`__ variable so + where this string appears in a :term:`FILES` variable so that there is only a single "/".   @@ -473,14 +473,14 @@ Errors and Warnings - ``: Files/directories were installed but not shipped in any package [installed-vs-shipped]`` Files have been installed within the - ```do_install`` <#ref-tasks-install>`__ task but have not been - included in any package by way of the ```FILES`` <#var-FILES>`__ + :ref:`ref-tasks-install` task but have not been + included in any package by way of the :term:`FILES` variable. Files that do not appear in any package cannot be present in an image later on in the build process. You need to do one of the following: - Add the files to ``FILES`` for the package you want them to appear - in (e.g. ``FILES_${``\ ```PN`` <#var-PN>`__\ ``}`` for the main + in (e.g. ``FILES_${``\ :term:`PN`\ ``}`` for the main package). - Delete the files at the end of the ``do_install`` task if the @@ -496,15 +496,15 @@ Errors and Warnings message might indicate that a private version of a library is being erroneously picked up as the provider for a common library. If that is the case, you should add the library's ``.so`` file name to - ```PRIVATE_LIBS`` <#var-PRIVATE_LIBS>`__ in the recipe that provides + :term:`PRIVATE_LIBS` in the recipe that provides the private version of the library. - ``LICENSE_ includes licenses () that are not listed in LICENSE [unlisted-pkg-lics]`` - The ```LICENSE`` <#var-LICENSE>`__ of the recipe should be a superset + The :term:`LICENSE` of the recipe should be a superset of all the licenses of all packages produced by this recipe. In other words, any license in ``LICENSE_*`` should also appear in - ```LICENSE`` <#var-LICENSE>`__. + :term:`LICENSE`.   @@ -513,11 +513,11 @@ Configuring and Disabling QA Checks You can configure the QA checks globally so that specific check failures either raise a warning or an error message, using the -```WARN_QA`` <#var-WARN_QA>`__ and ```ERROR_QA`` <#var-ERROR_QA>`__ +:term:`WARN_QA` and :term:`ERROR_QA` variables, respectively. You can also disable checks within a particular -recipe using ```INSANE_SKIP`` <#var-INSANE_SKIP>`__. For information on +recipe using :term:`INSANE_SKIP`. For information on how to work with the QA checks, see the -"```insane.bbclass`` <#ref-classes-insane>`__" section. +":ref:`insane.bbclass `" section. .. note:: diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst index c09fd7a075..95ec686a13 100644 --- a/documentation/ref-manual/ref-release-process.rst +++ b/documentation/ref-manual/ref-release-process.rst @@ -41,7 +41,7 @@ Major Release Codenames Each major release receives a codename that identifies the release in the `Yocto Project Source Repositories <&YOCTO_DOCS_OM_URL;#yocto-project-repositories>`__. The -concept is that branches of `Metadata <#metadata>`__ with the same +concept is that branches of :term:`Metadata` with the same codename are likely to be compatible and thus work together. .. note:: @@ -107,12 +107,12 @@ consists of the following pieces: - ``bitbake-selftest``: A standalone command that runs unit tests on key pieces of BitBake and its fetchers. -- ```sanity.bbclass`` <#ref-classes-sanity>`__: This automatically +- :ref:`sanity.bbclass `: This automatically included class checks the build environment for missing tools (e.g. ``gcc``) or common misconfigurations such as - ```MACHINE`` <#var-MACHINE>`__ set incorrectly. + :term:`MACHINE` set incorrectly. -- ```insane.bbclass`` <#ref-classes-insane>`__: This class checks the +- :ref:`insane.bbclass `: This class checks the generated output from builds for sanity. For example, if building for an ARM target, did the build produce ARM binaries. If, for example, the build produced PPC binaries then there is a problem. @@ -149,7 +149,7 @@ efficiently. The Yocto Project's main Autobuilder (``autobuilder.yoctoproject.org``) publicly tests each Yocto Project release's code in the -`OE-Core <#oe-core>`__, Poky, and BitBake repositories. The testing +:term:`OpenEmbedded-Core (OE-Core)`, Poky, and BitBake repositories. The testing occurs for both the current state of the "master" branch and also for submitted patches. Testing for submitted patches usually occurs in the "ross/mut" branch in the ``poky-contrib`` repository (i.e. the diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst index 5e30a08041..c63900e604 100644 --- a/documentation/ref-manual/ref-structure.rst +++ b/documentation/ref-manual/ref-structure.rst @@ -4,7 +4,7 @@ Source Directory Structure ************************** -The `Source Directory <#source-directory>`__ consists of numerous files, +The :term:`Source Directory` consists of numerous files, directories and subdirectories; understanding their locations and contents is key to using the Yocto Project effectively. This chapter describes the Source Directory and gives information about those files @@ -36,7 +36,7 @@ Directory <#source-directory>`__. This directory includes a copy of BitBake for ease of use. The copy usually matches the current stable BitBake release from the BitBake -project. BitBake, a `Metadata <#metadata>`__ interpreter, reads the +project. BitBake, a :term:`Metadata` interpreter, reads the Yocto Project Metadata and runs the tasks defined by that data. Failures are usually caused by errors in your Metadata and not from BitBake itself; consequently, most users do not need to worry about BitBake. @@ -63,7 +63,7 @@ the OpenEmbedded build environment setup script (i.e. ````` <#structure-core-script>`__). It is also possible to place output and configuration files in a -directory separate from the `Source Directory <#source-directory>`__ by +directory separate from the :term:`Source Directory` by providing a directory name when you ``source`` the setup script. For information on separating output from your local Source Directory files (commonly described as an "out of tree" build), see the @@ -152,7 +152,7 @@ BitBake commands. The script uses other scripts within the ``scripts`` directory to do the bulk of the work. When you run this script, your Yocto Project environment is set up, a -`Build Directory <#build-directory>`__ is created, your working +:term:`Build Directory` is created, your working directory becomes the Build Directory, and you are presented with some simple suggestions as to what to do next, including a list of some possible targets to build. Here is an example: $ source @@ -162,7 +162,7 @@ core-image-sato meta-toolchain meta-ide-support You can also run generated qemu images with a command like 'runqemu qemux86-64' The default output of the ``oe-init-build-env`` script is from the ``conf-notes.txt`` file, which is found in the ``meta-poky`` directory -within the `Source Directory <#source-directory>`__. If you design a +within the :term:`Source Directory`. If you design a custom distribution, you can include your own version of this configuration file to mention the targets defined by your distribution. See the "`Creating a Custom Template Configuration @@ -213,7 +213,7 @@ Directory a specific name when you run the setup script, the name defaults to ``build/``. For subsequent parsing and processing, the name of the Build directory -is available via the ```TOPDIR`` <#var-TOPDIR>`__ variable. +is available via the :term:`TOPDIR` variable. .. _structure-build-buildhistory: @@ -243,7 +243,7 @@ relatively rare. At a minimum, you would normally edit this file to select the target ``MACHINE``, which package types you wish to use -(```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__), and the location from +(:term:`PACKAGE_CLASSES`), and the location from which you want to access downloaded files (``DL_DIR``). If ``local.conf`` is not present when you start the build, the @@ -261,7 +261,7 @@ build environment from any layer by setting the variable in the top-level build environment setup script as follows: TEMPLATECONF=your_layer/conf Once the build process gets the sample file, it uses ``sed`` to substitute final -``${``\ ```OEROOT`` <#var-OEROOT>`__\ ``}`` values for all +``${``\ :term:`OEROOT`\ ``}`` values for all ``##OEROOT##`` values. .. note:: @@ -286,7 +286,7 @@ file, it uses ``sed`` to substitute final This configuration file defines `layers <&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers>`__, which are directory trees, traversed (or walked) by BitBake. The -``bblayers.conf`` file uses the ```BBLAYERS`` <#var-BBLAYERS>`__ +``bblayers.conf`` file uses the :term:`BBLAYERS` variable to list the layers BitBake tries to find. If ``bblayers.conf`` is not present when you start the build, the @@ -304,7 +304,7 @@ implies that you can base your build from any layer by setting the variable in the top-level build environment setup script as follows: TEMPLATECONF=your_layer/conf Once the build process gets the sample file, it uses ``sed`` to substitute final -``${``\ ```OEROOT`` <#var-OEROOT>`__\ ``}`` values for all +``${``\ :term:`OEROOT`\ ``}`` values for all ``##OEROOT##`` values. .. note:: @@ -355,7 +355,7 @@ You can control the location of this directory through the -------------- The OpenEmbedded build system creates and uses this directory for all -the build system's output. The ```TMPDIR`` <#var-TMPDIR>`__ variable +the build system's output. The :term:`TMPDIR` variable points to this directory. BitBake creates this directory if it does not exist. As a last resort, @@ -393,7 +393,7 @@ cache is reused. If the file has changed, it is reparsed. --------------------- This directory contains any "end result" output from the OpenEmbedded -build process. The ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__ variable points +build process. The :term:`DEPLOY_DIR` variable points to this directory. For more detail on the contents of the ``deploy`` directory, see the "`Images <&YOCTO_DOCS_OM_URL;#images-dev-environment>`__" and @@ -497,11 +497,11 @@ another. ---------------------------------- This directory is the location of the sysroot contents that the task -```do_prepare_recipe_sysroot`` <#ref-tasks-prepare_recipe_sysroot>`__ +:ref:`ref-tasks-prepare_recipe_sysroot` links or copies into the recipe-specific sysroot for each recipe listed -in ```DEPENDS`` <#var-DEPENDS>`__. Population of this directory is +in :term:`DEPENDS`. Population of this directory is handled through shared state, while the path is specified by the -```COMPONENTS_DIR`` <#var-COMPONENTS_DIR>`__ variable. Apart from a few +:term:`COMPONENTS_DIR` variable. Apart from a few unusual circumstances, handling of the ``sysroots-components`` directory should be automatic, and recipes should not directly reference ``build/tmp/sysroots-components``. @@ -514,7 +514,7 @@ should be automatic, and recipes should not directly reference Previous versions of the OpenEmbedded build system used to create a global shared sysroot per machine along with a native sysroot. Beginning with the DISTRO version of the Yocto Project, sysroots exist in -recipe-specific ```WORKDIR`` <#var-WORKDIR>`__ directories. Thus, the +recipe-specific :term:`WORKDIR` directories. Thus, the ``build/tmp/sysroots/`` directory is unused. .. note:: @@ -566,7 +566,7 @@ directory. For example, the source for a particular package is unpacked, patched, configured and compiled all within its own work directory. Within the work directory, organization is based on the package group and version for which the source is being compiled as defined by the -```WORKDIR`` <#var-WORKDIR>`__. +:term:`WORKDIR`. It is worth considering the structure of a typical work directory. As an example, consider ``linux-yocto-kernel-3.0`` on the machine ``qemux86`` @@ -599,12 +599,12 @@ As described earlier in the "```build/tmp/sysroots/`` <#structure-build-tmp-sysroots>`__" section, beginning with the DISTRO release of the Yocto Project, the OpenEmbedded build system builds each recipe in its own work directory (i.e. -```WORKDIR`` <#var-WORKDIR>`__). The path to the work directory is +:term:`WORKDIR`). The path to the work directory is constructed using the architecture of the given build (e.g. -```TUNE_PKGARCH`` <#var-TUNE_PKGARCH>`__, -```MACHINE_ARCH`` <#var-MACHINE_ARCH>`__, or "allarch"), the recipe +:term:`TUNE_PKGARCH`, +:term:`MACHINE_ARCH`, or "allarch"), the recipe name, and the version of the recipe (i.e. -```PE`` <#var-PE>`__\ ``:``\ ```PV`` <#var-PV>`__\ ``-``\ ```PR`` <#var-PR>`__). +:term:`PE`\ ``:``\ :term:`PV`\ ``-``\ :term:`PR`). A number of key subdirectories exist within each recipe work directory: @@ -614,17 +614,17 @@ A number of key subdirectories exist within each recipe work directory: which tasks were executed. - ``${WORKDIR}/image``: Contains the output of the - ```do_install`` <#ref-tasks-install>`__ task, which corresponds to - the ``${``\ ```D`` <#var-D>`__\ ``}`` variable in that task. + :ref:`ref-tasks-install` task, which corresponds to + the ``${``\ :term:`D`\ ``}`` variable in that task. - ``${WORKDIR}/pseudo``: Contains the pseudo database and log for any tasks executed under pseudo for the recipe. - ``${WORKDIR}/sysroot-destdir``: Contains the output of the - ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task. + :ref:`ref-tasks-populate_sysroot` task. - ``${WORKDIR}/package``: Contains the output of the - ```do_package`` <#ref-tasks-package>`__ task before the output is + :ref:`ref-tasks-package` task before the output is split into individual packages. - ``${WORKDIR}/packages-split``: Contains the output of the @@ -645,7 +645,7 @@ A number of key subdirectories exist within each recipe work directory: - ``${WORKDIR}/build``: This subdirectory applies only to recipes that support builds where the source is separate from the build artifacts. The OpenEmbedded build system uses this directory as a separate build - directory (i.e. ``${``\ ```B`` <#var-B>`__\ ``}``). + directory (i.e. ``${``\ :term:`B`\ ``}``). .. _structure-build-work-shared: @@ -662,7 +662,7 @@ recipes. In practice, this is only used for ``gcc`` and its variants The Metadata - ``meta/`` ======================== -As mentioned previously, `Metadata <#metadata>`__ is the core of the +As mentioned previously, :term:`Metadata` is the core of the Yocto Project. Metadata has several important subdivisions: .. _structure-meta-classes: @@ -681,7 +681,7 @@ generation or packaging also have their specific class files such as ``image.bbclass``, ``rootfs_*.bbclass`` and ``package*.bbclass``. For reference information on classes, see the -"`Classes <#ref-classes>`__" chapter. +":ref:`ref-manual/ref-classes:Classes`" chapter. .. _structure-meta-conf: @@ -726,7 +726,7 @@ file mainly inherits its configuration from Poky. The OpenEmbedded build system searches this directory for configuration files that correspond to the value of -```SDKMACHINE`` <#var-SDKMACHINE>`__. By default, 32-bit and 64-bit x86 +:term:`SDKMACHINE`. By default, 32-bit and 64-bit x86 files ship with the Yocto Project that support some SDK hosts. However, it is possible to extend that support to other SDK hosts by adding additional configuration files in this subdirectory within another diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst index 1e4b8197a0..aa7c0df552 100644 --- a/documentation/ref-manual/ref-tasks.rst +++ b/documentation/ref-manual/ref-tasks.rst @@ -32,7 +32,7 @@ tasks required to build a recipe. -------------- Compiles the source code. This task runs with the current working -directory set to ``${``\ ```B`` <#var-B>`__\ ``}``. +directory set to ``${``\ :term:`B`\ ``}``. The default behavior of this task is to run the ``oe_runmake`` function if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found. @@ -52,11 +52,11 @@ Compiles the runtime test suite included in the software being built. Configures the source by enabling and disabling any build-time and configuration options for the software being built. The task runs with -the current working directory set to ``${``\ ```B`` <#var-B>`__\ ``}``. +the current working directory set to ``${``\ :term:`B`\ ``}``. The default behavior of this task is to run ``oe_runmake clean`` if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found and -```CLEANBROKEN`` <#var-CLEANBROKEN>`__ is not set to "1". If no such +:term:`CLEANBROKEN` is not set to "1". If no such file is found or the ``CLEANBROKEN`` variable is set to "1", the ``do_configure`` task does nothing. @@ -73,13 +73,13 @@ Configures the runtime test suite included in the software being built. ------------- Writes output files that are to be deployed to -``${``\ ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__\ ``}``. The +``${``\ :term:`DEPLOY_DIR_IMAGE`\ ``}``. The task runs with the current working directory set to -``${``\ ```B`` <#var-B>`__\ ``}``. +``${``\ :term:`B`\ ``}``. Recipes implementing this task should inherit the -```deploy`` <#ref-classes-deploy>`__ class and should write the output -to ``${``\ ```DEPLOYDIR`` <#var-DEPLOYDIR>`__\ ``}``, which is not to be +:ref:`deploy ` class and should write the output +to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be confused with ``${DEPLOY_DIR}``. The ``deploy`` class sets up ``do_deploy`` as a shared state (sstate) task that can be accelerated through sstate use. The sstate mechanism takes care of copying the @@ -93,7 +93,7 @@ output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``. The ``do_deploy`` task is not added as a task by default and consequently needs to be added manually. If you want the task to run -after ```do_compile`` <#ref-tasks-compile>`__, you can add it by doing +after :ref:`ref-tasks-compile`, you can add it by doing the following: addtask deploy after do_compile Adding ``do_deploy`` after other tasks works the same way. @@ -124,7 +124,7 @@ If the ``do_deploy`` task re-executes, any previous output is removed ------------ Fetches the source code. This task uses the -```SRC_URI`` <#var-SRC_URI>`__ variable and the argument's prefix to +:term:`SRC_URI` variable and the argument's prefix to determine the correct `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ module. @@ -135,12 +135,12 @@ module. Starts the image generation process. The ``do_image`` task runs after the OpenEmbedded build system has run the -```do_rootfs`` <#ref-tasks-rootfs>`__ task during which packages are +:ref:`ref-tasks-rootfs` task during which packages are identified for installation into the image and the root filesystem is created, complete with post-processing. The ``do_image`` task performs pre-processing on the image through the -```IMAGE_PREPROCESS_COMMAND`` <#var-IMAGE_PREPROCESS_COMMAND>`__ and +:term:`IMAGE_PREPROCESS_COMMAND` and dynamically generates supporting ``do_image_*`` tasks as needed. For more information on image creation, see the "`Image @@ -154,13 +154,13 @@ section in the Yocto Project Overview and Concepts Manual. Completes the image generation process. The ``do_image_complete`` task runs after the OpenEmbedded build system has run the -```do_image`` <#ref-tasks-image>`__ task during which image +:ref:`ref-tasks-image` task during which image pre-processing occurs and through dynamically generated ``do_image_*`` tasks the image is constructed. The ``do_image_complete`` task performs post-processing on the image through the -```IMAGE_POSTPROCESS_COMMAND`` <#var-IMAGE_POSTPROCESS_COMMAND>`__. +:term:`IMAGE_POSTPROCESS_COMMAND`. For more information on image creation, see the "`Image Generation <&YOCTO_DOCS_OM_URL;#image-generation-dev-environment>`__" @@ -172,13 +172,13 @@ section in the Yocto Project Overview and Concepts Manual. -------------- Copies files that are to be packaged into the holding area -``${``\ ```D`` <#var-D>`__\ ``}``. This task runs with the current -working directory set to ``${``\ ```B`` <#var-B>`__\ ``}``, which is the +``${``\ :term:`D`\ ``}``. This task runs with the current +working directory set to ``${``\ :term:`B`\ ``}``, which is the compilation directory. The ``do_install`` task, as well as other tasks that either directly or indirectly depend on the installed files (e.g. -```do_package`` <#ref-tasks-package>`__, +:ref:`ref-tasks-package`, ```do_package_write_*`` <#ref-tasks-package_write_deb>`__, and -```do_rootfs`` <#ref-tasks-rootfs>`__), run under +:ref:`ref-tasks-rootfs`), run under `fakeroot <&YOCTO_DOCS_OM_URL;#fakeroot-and-pseudo>`__. .. note:: @@ -199,7 +199,7 @@ that either directly or indirectly depend on the installed files (e.g. - The ``tar`` command with the "--no-same-owner" option. See the ``bin_package.bbclass`` file in the ``meta/classes`` directory of - the `Source Directory <#source-directory>`__ for an example. + the :term:`Source Directory` for an example. .. _ref-tasks-install_ptest_base: @@ -215,15 +215,15 @@ holding area. -------------- Analyzes the content of the holding area -``${``\ ```D`` <#var-D>`__\ ``}`` and splits the content into subsets +``${``\ :term:`D`\ ``}`` and splits the content into subsets based on available packages and files. This task makes use of the -```PACKAGES`` <#var-PACKAGES>`__ and ```FILES`` <#var-FILES>`__ +:term:`PACKAGES` and :term:`FILES` variables. The ``do_package`` task, in conjunction with the -```do_packagedata`` <#ref-tasks-packagedata>`__ task, also saves some +:ref:`ref-tasks-packagedata` task, also saves some important package metadata. For additional information, see the -```PKGDESTWORK`` <#var-PKGDESTWORK>`__ variable and the "`Automatically +:term:`PKGDESTWORK` variable and the "`Automatically Added Runtime Dependencies <&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies>`__" section in the Yocto Project Overview and Concepts Manual. @@ -234,7 +234,7 @@ section in the Yocto Project Overview and Concepts Manual. ----------------- Runs QA checks on packaged files. For more information on these checks, -see the ```insane`` <#ref-classes-insane>`__ class. +see the :ref:`insane ` class. .. _ref-tasks-package_write_deb: @@ -242,7 +242,7 @@ see the ```insane`` <#ref-classes-insane>`__ class. ------------------------ Creates Debian packages (i.e. ``*.deb`` files) and places them in the -``${``\ ```DEPLOY_DIR_DEB`` <#var-DEPLOY_DIR_DEB>`__\ ``}`` directory in +``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in the package feeds area. For more information, see the "`Package Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in the Yocto Project Overview and Concepts Manual. @@ -253,7 +253,7 @@ the Yocto Project Overview and Concepts Manual. ------------------------ Creates IPK packages (i.e. ``*.ipk`` files) and places them in the -``${``\ ```DEPLOY_DIR_IPK`` <#var-DEPLOY_DIR_IPK>`__\ ``}`` directory in +``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in the package feeds area. For more information, see the "`Package Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in the Yocto Project Overview and Concepts Manual. @@ -264,7 +264,7 @@ the Yocto Project Overview and Concepts Manual. ------------------------ Creates RPM packages (i.e. ``*.rpm`` files) and places them in the -``${``\ ```DEPLOY_DIR_RPM`` <#var-DEPLOY_DIR_RPM>`__\ ``}`` directory in +``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in the package feeds area. For more information, see the "`Package Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in the Yocto Project Overview and Concepts Manual. @@ -275,7 +275,7 @@ the Yocto Project Overview and Concepts Manual. ------------------------ Creates tarballs and places them in the -``${``\ ```DEPLOY_DIR_TAR`` <#var-DEPLOY_DIR_TAR>`__\ ``}`` directory in +``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in the package feeds area. For more information, see the "`Package Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in the Yocto Project Overview and Concepts Manual. @@ -286,8 +286,8 @@ the Yocto Project Overview and Concepts Manual. ------------------ Saves package metadata generated by the -```do_package`` <#ref-tasks-package>`__ task in -```PKGDATA_DIR`` <#var-PKGDATA_DIR>`__ to make it available globally. +:ref:`ref-tasks-package` task in +:term:`PKGDATA_DIR` to make it available globally. .. _ref-tasks-patch: @@ -297,7 +297,7 @@ Saves package metadata generated by the Locates patch files and applies them to the source code. After fetching and unpacking source files, the build system uses the -recipe's ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ statements +recipe's :term:`SRC_URI` statements to locate and apply patch files to the source code. .. note:: @@ -375,7 +375,7 @@ information. ----------------------- Stages (copies) a subset of the files installed by the -```do_install`` <#ref-tasks-install>`__ task into the appropriate +:ref:`ref-tasks-install` task into the appropriate sysroot. For information on how to access these files from other recipes, see the ```STAGING_DIR*`` <#var-STAGING_DIR_HOST>`__ variables. Directories that would typically not be needed by other recipes at build @@ -398,9 +398,9 @@ that if the task is re-executed, any previous output is removed (i.e. Installs the files into the individual recipe specific sysroots (i.e. ``recipe-sysroot`` and ``recipe-sysroot-native`` under -``${``\ ```WORKDIR`` <#var-WORKDIR>`__\ ``}`` based upon the -dependencies specified by ```DEPENDS`` <#var-DEPENDS>`__). See the -"```staging`` <#ref-classes-staging>`__" class for more information. +``${``\ :term:`WORKDIR`\ ``}`` based upon the +dependencies specified by :term:`DEPENDS`). See the +":ref:`staging `" class for more information. .. _ref-tasks-rm_work: @@ -417,7 +417,7 @@ them. You can learn more by looking at the ------------- Unpacks the source code into a working directory pointed to by -``${``\ ```WORKDIR`` <#var-WORKDIR>`__\ ``}``. The ```S`` <#var-S>`__ +``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` variable also plays a role in where unpacked source files ultimately reside. For more information on how source files are unpacked, see the "`Source @@ -459,7 +459,7 @@ default, the results are stored in ```$LOG_DIR`` <#var-LOG_DIR>`__ (e.g. ``do_checkuri`` --------------- -Validates the ```SRC_URI`` <#var-SRC_URI>`__ value. +Validates the :term:`SRC_URI` value. .. _ref-tasks-clean: @@ -467,11 +467,11 @@ Validates the ```SRC_URI`` <#var-SRC_URI>`__ value. ------------ Removes all output files for a target from the -```do_unpack`` <#ref-tasks-unpack>`__ task forward (i.e. ``do_unpack``, -```do_configure`` <#ref-tasks-configure>`__, -```do_compile`` <#ref-tasks-compile>`__, -```do_install`` <#ref-tasks-install>`__, and -```do_package`` <#ref-tasks-package>`__). +:ref:`ref-tasks-unpack` task forward (i.e. ``do_unpack``, +:ref:`ref-tasks-configure`, +:ref:`ref-tasks-compile`, +:ref:`ref-tasks-install`, and +:ref:`ref-tasks-package`). You can run this task using BitBake as follows: $ bitbake -c clean recipe @@ -481,7 +481,7 @@ Running this task does not remove the Consequently, if no changes have been made and the recipe is rebuilt after cleaning, output files are simply restored from the sstate cache. If you want to remove the sstate cache files for the recipe, you need to -use the ```do_cleansstate`` <#ref-tasks-cleansstate>`__ task instead +use the :ref:`ref-tasks-cleansstate` task instead (i.e. ``bitbake -c cleansstate`` recipe). .. _ref-tasks-cleanall: @@ -492,15 +492,15 @@ use the ```do_cleansstate`` <#ref-tasks-cleansstate>`__ task instead Removes all output files, shared state (`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) cache, and downloaded source files for a target (i.e. the contents of -```DL_DIR`` <#var-DL_DIR>`__). Essentially, the ``do_cleanall`` task is -identical to the ```do_cleansstate`` <#ref-tasks-cleansstate>`__ task +:term:`DL_DIR`). Essentially, the ``do_cleanall`` task is +identical to the :ref:`ref-tasks-cleansstate` task with the added removal of downloaded source files. You can run this task using BitBake as follows: $ bitbake -c cleanall recipe Typically, you would not normally use the ``cleanall`` task. Do so only -if you want to start fresh with the ```do_fetch`` <#ref-tasks-fetch>`__ +if you want to start fresh with the :ref:`ref-tasks-fetch` task. .. _ref-tasks-cleansstate: @@ -511,7 +511,7 @@ task. Removes all output files and shared state (`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) cache for a target. Essentially, the ``do_cleansstate`` task is identical to the -```do_clean`` <#ref-tasks-clean>`__ task with the added removal of +:ref:`ref-tasks-clean` task with the added removal of shared state (`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) cache. @@ -596,7 +596,7 @@ The following tasks are applicable to image recipes. -------------- Creates a bootable live image. See the -```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable for additional +:term:`IMAGE_FSTYPES` variable for additional information on live image types. .. _ref-tasks-bundle_initramfs: @@ -606,7 +606,7 @@ information on live image types. Combines an initial RAM disk (initramfs) image and kernel together to form a single image. The -```CONFIG_INITRAMFS_SOURCE`` <#var-CONFIG_INITRAMFS_SOURCE>`__ variable +:term:`CONFIG_INITRAMFS_SOURCE` variable has some more information about these types of images. .. _ref-tasks-rootfs: @@ -638,7 +638,7 @@ section in the Yocto Project Development Tasks Manual. Boots an image and performs runtime tests within the image immediately after it has been built. This task is enabled when you set -```TESTIMAGE_AUTO`` <#var-TESTIMAGE_AUTO>`__ equal to "1". +:term:`TESTIMAGE_AUTO` equal to "1". For information on automatically testing images, see the "`Performing Automated Runtime @@ -649,7 +649,7 @@ Kernel-Related Tasks ==================== The following tasks are applicable to kernel recipes. Some of these -tasks (e.g. the ```do_menuconfig`` <#ref-tasks-menuconfig>`__ task) are +tasks (e.g. the :ref:`ref-tasks-menuconfig` task) are also applicable to recipes that use Linux kernel style configuration such as the BusyBox recipe. @@ -669,9 +669,9 @@ kernel consists of two steps: 1) the kernel (``vmlinux``) is built, and When invoked by the user, this task creates a file containing the differences between the original config as produced by -```do_kernel_configme`` <#ref-tasks-kernel_configme>`__ task and the +:ref:`ref-tasks-kernel_configme` task and the changes made by the user with other methods (i.e. using -(```do_kernel_menuconfig`` <#ref-tasks-kernel_menuconfig>`__). Once the +(:ref:`ref-tasks-kernel_menuconfig`). Once the file of differences is created, it can be used to create a config fragment that only contains the differences. You can invoke this task from the command line as follows: $ bitbake linux-yocto -c diffconfig @@ -696,7 +696,7 @@ kernel with the correct branches checked out. ------------------------- Validates the configuration produced by the -```do_kernel_menuconfig`` <#ref-tasks-kernel_menuconfig>`__ task. The +:ref:`ref-tasks-kernel_menuconfig` task. The ``do_kernel_configcheck`` task produces warnings when a requested configuration does not appear in the final ``.config`` file or when you override a policy configuration in a hardware configuration fragment. @@ -711,7 +711,7 @@ section in the Yocto Project Linux Kernel Development Manual. ``do_kernel_configme`` ---------------------- -After the kernel is patched by the ```do_patch`` <#ref-tasks-patch>`__ +After the kernel is patched by the :ref:`ref-tasks-patch` task, the ``do_kernel_configme`` task assembles and merges all the kernel config fragments into a merged configuration that can then be passed to the kernel configuration phase proper. This is also the time @@ -746,12 +746,12 @@ information on this configuration tool. ---------------------- Collects all the features required for a given kernel build, whether the -features come from ```SRC_URI`` <#var-SRC_URI>`__ or from Git +features come from :term:`SRC_URI` or from Git repositories. After collection, the ``do_kernel_metadata`` task processes the features into a series of config fragments and patches, which can then be applied by subsequent tasks such as -```do_patch`` <#ref-tasks-patch>`__ and -```do_kernel_configme`` <#ref-tasks-kernel_configme>`__. +:ref:`ref-tasks-patch` and +:ref:`ref-tasks-kernel_configme`. .. _ref-tasks-menuconfig: @@ -772,7 +772,7 @@ When invoked by the user, creates a defconfig file that can be used instead of the default defconfig. The saved defconfig contains the differences between the default defconfig and the changes made by the user using other methods (i.e. the -```do_kernel_menuconfig`` <#ref-tasks-kernel_menuconfig>`__ task. You +:ref:`ref-tasks-kernel_menuconfig` task. You can invoke the task using the following command: $ bitbake linux-yocto -c savedefconfig @@ -785,7 +785,7 @@ After the kernel has been compiled but before the kernel modules have been compiled, this task copies files required for module builds and which are generated from the kernel build into the shared work directory. With these copies successfully copied, the -```do_compile_kernelmodules`` <#ref-tasks-compile_kernelmodules>`__ task +:ref:`ref-tasks-compile_kernelmodules` task can successfully build the kernel modules in the next step of the build. .. _ref-tasks-sizecheck: @@ -795,7 +795,7 @@ can successfully build the kernel modules in the next step of the build. After the kernel has been built, this task checks the size of the stripped kernel image against -```KERNEL_IMAGE_MAXSIZE`` <#var-KERNEL_IMAGE_MAXSIZE>`__. If that +:term:`KERNEL_IMAGE_MAXSIZE`. If that variable was set and the size of the stripped kernel exceeds that size, the kernel build produces a warning to that effect. @@ -816,9 +816,9 @@ sections from a size-sensitive configuration. After the kernel is unpacked but before it is patched, this task makes sure that the machine and metadata branches as specified by the -```SRCREV`` <#var-SRCREV>`__ variables actually exist on the specified +:term:`SRCREV` variables actually exist on the specified branches. If these branches do not exist and -```AUTOREV`` <#var-AUTOREV>`__ is not being used, the +:term:`AUTOREV` is not being used, the ``do_validate_branches`` task fails during the build. Miscellaneous Tasks @@ -833,4 +833,4 @@ The following sections describe miscellaneous tasks. A build stage that takes the source code and scans it on a remote FOSSOLOGY server in order to produce an SPDX document. This task applies -only to the ```spdx`` <#ref-classes-spdx>`__ class. +only to the :ref:`spdx ` class. diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst index 59100e9c88..4298e04965 100644 --- a/documentation/ref-manual/ref-terms.rst +++ b/documentation/ref-manual/ref-terms.rst @@ -113,7 +113,7 @@ universal, the list includes them just in case: Files that provide for logic encapsulation and inheritance so that commonly used patterns can be defined once and then easily used in multiple recipes. For reference information on the Yocto Project classes, - see the "`Classes <#ref-classes>`__" chapter. Class files end with the + see the ":ref:`ref-manual/ref-classes:Classes`" chapter. Class files end with the ``.bbclass`` filename extension. Configuration File @@ -200,7 +200,7 @@ universal, the list includes them just in case: Metadata A key element of the Yocto Project is the Metadata that is used to construct a Linux distribution and is contained in the - files that the `OpenEmbedded build system <#build-system-term>`__ + files that the :term:`OpenEmbedded Build System` parses when building an image. In general, Metadata includes recipes, configuration files, and other information that refers to the build instructions themselves, as well as the data used to control what @@ -233,7 +233,7 @@ universal, the list includes them just in case: OpenEmbedded Build System The build system specific to the Yocto Project. The OpenEmbedded build system is based on another project - known as "Poky", which uses `BitBake <#bitbake-term>`__ as the task + known as "Poky", which uses :term:`BitBake` as the task executor. Throughout the Yocto Project documentation set, the OpenEmbedded build system is sometimes referred to simply as "the build system". If other build systems, such as a host or target build @@ -262,8 +262,8 @@ universal, the list includes them just in case: Another point worth noting is that historically within the Yocto Project, recipes were referred to as packages - thus, the existence of several BitBake variables that are seemingly mis-named, (e.g. - ```PR`` <#var-PR>`__, ```PV`` <#var-PV>`__, and - ```PE`` <#var-PE>`__). + :term:`PR`, :term:`PV`, and + :term:`PE`). Package Groups Arbitrary groups of software Recipes. You use @@ -373,9 +373,9 @@ universal, the list includes them just in case: Task A unit of execution for BitBake (e.g. - ```do_compile`` <#ref-tasks-compile>`__, - ```do_fetch`` <#ref-tasks-fetch>`__, - ```do_patch`` <#ref-tasks-patch>`__, and so forth). + :ref:`ref-tasks-compile`, + :ref:`ref-tasks-fetch`, + :ref:`ref-tasks-patch`, and so forth). Toaster A web interface to the Yocto Project's `OpenEmbedded Build diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index b84640c6a7..3eae836fd6 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst @@ -7,12 +7,12 @@ Variables Glossary This chapter lists common variables used in the OpenEmbedded build system and gives an overview of their function and contents. -`A <#var-ABIEXTENSION>`__ `B <#var-B>`__ `C <#var-CACHE>`__ -`D <#var-D>`__ `E <#var-EFI_PROVIDER>`__ `F <#var-FEATURE_PACKAGES>`__ +`A <#var-ABIEXTENSION>`__ :term:`B` `C <#var-CACHE>`__ +:term:`D` `E <#var-EFI_PROVIDER>`__ `F <#var-FEATURE_PACKAGES>`__ `G <#var-GCCPIE>`__ `H <#var-HOMEPAGE>`__ `I <#var-ICECC_DISABLED>`__ `K <#var-KARCH>`__ `L <#var-LABELS>`__ `M <#var-MACHINE>`__ -`N <#var-NATIVELSBSTRING>`__ `O <#var-OBJCOPY>`__ `P <#var-P>`__ -`R <#var-RANLIB>`__ `S <#var-S>`__ `T <#var-T>`__ +`N <#var-NATIVELSBSTRING>`__ `O <#var-OBJCOPY>`__ :term:`P` +`R <#var-RANLIB>`__ :term:`S` :term:`T` `U <#var-UBOOT_CONFIG>`__ `V <#var-VOLATILE_LOG_DIR>`__ `W <#var-WARN_QA>`__ `X <#var-XSERVER>`__ @@ -30,7 +30,7 @@ system and gives an overview of their function and contents. Specifies whether to produce an output package even if it is empty. By default, BitBake does not produce empty packages. This default behavior can cause issues when there is an - ```RDEPENDS`` <#var-RDEPENDS>`__ or some other hard runtime + :term:`RDEPENDS` or some other hard runtime requirement on the existence of the package. Like all package-controlling variables, you must always use them in @@ -49,7 +49,7 @@ system and gives an overview of their function and contents. has four commands that also exist as part of another package, you identify them as follows: ALTERNATIVE_busybox = "sh sed test bracket" For more information on the alternatives system, see the - "```update-alternatives.bbclass`` <#ref-classes-update-alternatives>`__" + ":ref:`update-alternatives.bbclass `" section. ALTERNATIVE_LINK_NAME @@ -72,7 +72,7 @@ system and gives an overview of their function and contents. . For more information on the alternatives system, see the - "```update-alternatives.bbclass`` <#ref-classes-update-alternatives>`__" + ":ref:`update-alternatives.bbclass `" section. ALTERNATIVE_PRIORITY @@ -86,7 +86,7 @@ system and gives an overview of their function and contents. ALTERNATIVE_PRIORITY_pkg[name] = "priority" For more information on the alternatives system, see the - "```update-alternatives.bbclass`` <#ref-classes-update-alternatives>`__" + ":ref:`update-alternatives.bbclass `" section. ALTERNATIVE_TARGET @@ -103,7 +103,7 @@ system and gives an overview of their function and contents. If ``ALTERNATIVE_TARGET`` is not defined, it inherits the value from the - ```ALTERNATIVE_LINK_NAME`` <#var-ALTERNATIVE_LINK_NAME>`__ + :term:`ALTERNATIVE_LINK_NAME` variable. If ``ALTERNATIVE_LINK_NAME`` and ``ALTERNATIVE_TARGET`` are the @@ -112,25 +112,25 @@ system and gives an overview of their function and contents. Finally, if the file referenced has not been renamed, the alternatives system will rename it to avoid the need to rename - alternative files in the ```do_install`` <#ref-tasks-install>`__ + alternative files in the :ref:`ref-tasks-install` task while retaining support for the command if necessary. For more information on the alternatives system, see the - "```update-alternatives.bbclass`` <#ref-classes-update-alternatives>`__" + ":ref:`update-alternatives.bbclass `" section. APPEND An override list of append strings for each target specified with - ```LABELS`` <#var-LABELS>`__. + :term:`LABELS`. - See the ```grub-efi`` <#ref-classes-grub-efi>`__ class for more + See the :ref:`grub-efi ` class for more information on how this variable is used. AR The minimal command and arguments used to run ``ar``. ARCHIVER_MODE - When used with the ```archiver`` <#ref-classes-archiver>`__ class, + When used with the :ref:`archiver ` class, determines the type of information used to create a released archive. You can use this variable to create archives of patched source, original source, configured source, and so forth by employing the @@ -151,7 +151,7 @@ system and gives an overview of their function and contents. Minimal command and arguments needed to run the assembler. ASSUME_PROVIDED - Lists recipe names (```PN`` <#var-PN>`__ values) BitBake does not + Lists recipe names (:term:`PN` values) BitBake does not attempt to build. Instead, BitBake assumes these recipes have already been built. @@ -178,7 +178,7 @@ system and gives an overview of their function and contents. order to send patches and forward bugs. AUTO_LIBNAME_PKGS - When the ```debian`` <#ref-classes-debian>`__ class is inherited, + When the :ref:`debian ` class is inherited, which is the default behavior, ``AUTO_LIBNAME_PKGS`` specifies which packages should be checked for libraries and renamed according to Debian library package naming. @@ -189,7 +189,7 @@ system and gives an overview of their function and contents. AUTO_SYSLINUXMENU Enables creating an automatic menu for the syslinux bootloader. You must set this variable in your recipe. The - ```syslinux`` <#ref-classes-syslinux>`__ class checks this variable. + :ref:`syslinux ` class checks this variable. AUTOREV When ``SRCREV`` is set to the value of this variable, it specifies to @@ -197,10 +197,10 @@ system and gives an overview of their function and contents. SRCREV = "${AUTOREV}" If you use the previous statement to retrieve the latest version of - software, you need to be sure ```PV`` <#var-PV>`__ contains - ``${``\ ```SRCPV`` <#var-SRCPV>`__\ ``}``. For example, suppose you + software, you need to be sure :term:`PV` contains + ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you have a kernel recipe that inherits the - `kernel <#ref-classes-kernel>`__ class and you use the previous + :ref:`kernel ` class and you use the previous statement. In this example, ``${SRCPV}`` does not automatically get into ``PV``. Consequently, you need to change ``PV`` in your recipe so that it does contain ``${SRCPV}``. @@ -212,8 +212,8 @@ system and gives an overview of their function and contents. AVAILABLE_LICENSES List of licenses found in the directories specified by - ```COMMON_LICENSE_DIR`` <#var-COMMON_LICENSE_DIR>`__ and - ```LICENSE_PATH`` <#var-LICENSE_PATH>`__. + :term:`COMMON_LICENSE_DIR` and + :term:`LICENSE_PATH`. .. note:: @@ -245,10 +245,10 @@ system and gives an overview of their function and contents. User Manual for more information. B - The directory within the `Build Directory <#build-directory>`__ in + The directory within the :term:`Build Directory` in which the OpenEmbedded build system places generated objects during a recipe's build process. By default, this directory is the same as the - ```S`` <#var-S>`__ directory, which is defined as: S = + :term:`S` directory, which is defined as: S = "${WORKDIR}/${BP}" You can separate the (``S``) directory and the directory pointed to @@ -259,7 +259,7 @@ system and gives an overview of their function and contents. BAD_RECOMMENDATIONS Lists "recommended-only" packages to not install. Recommended-only packages are packages installed only through the - ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ variable. You can prevent any + :term:`RRECOMMENDS` variable. You can prevent any of these "recommended" packages from being installed by listing them with the ``BAD_RECOMMENDATIONS`` variable: BAD_RECOMMENDATIONS = "package_name package_name package_name ..." @@ -270,15 +270,15 @@ system and gives an overview of their function and contents. It is important to realize that if you choose to not install packages using this variable and some other packages are dependent on them - (i.e. listed in a recipe's ```RDEPENDS`` <#var-RDEPENDS>`__ + (i.e. listed in a recipe's :term:`RDEPENDS` variable), the OpenEmbedded build system ignores your request and will install the packages to avoid dependency errors. Support for this variable exists only when using the IPK and RPM packaging backend. Support does not exist for DEB. - See the ```NO_RECOMMENDATIONS`` <#var-NO_RECOMMENDATIONS>`__ and the - ```PACKAGE_EXCLUDE`` <#var-PACKAGE_EXCLUDE>`__ variables for related + See the :term:`NO_RECOMMENDATIONS` and the + :term:`PACKAGE_EXCLUDE` variables for related information. BASE_LIB @@ -291,7 +291,7 @@ system and gives an overview of their function and contents. on Multilib. The ``BASE_LIB`` variable is defined in the machine include files in - the `Source Directory <#source-directory>`__. If Multilib is not + the :term:`Source Directory`. If Multilib is not being used, the value defaults to "lib". BASE_WORKDIR @@ -327,10 +327,10 @@ system and gives an overview of their function and contents. - Attempts to access networks not in the host list cause a failure. Using ``BB_ALLOWED_NETWORKS`` in conjunction with - ```PREMIRRORS`` <#var-PREMIRRORS>`__ is very useful. Adding the host + :term:`PREMIRRORS` is very useful. Adding the host you want to use to ``PREMIRRORS`` results in the source code being fetched from an allowed location and avoids raising an error when a - host that is not allowed is in a ```SRC_URI`` <#var-SRC_URI>`__ + host that is not allowed is in a :term:`SRC_URI` statement. This is because the fetcher does not attempt to use the host listed in ``SRC_URI`` after a successful fetch from the ``PREMIRRORS`` occurs. @@ -349,7 +349,7 @@ system and gives an overview of their function and contents. You can change the default behavior by setting this variable to "1", "yes", or "true" in your ``local.conf`` file, which is located in the - `Build Directory <#build-directory>`__: Here is an example: + :term:`Build Directory`: Here is an example: BB_DANGLINGAPPENDS_WARNONLY = "1" BB_DISKMON_DIRS @@ -358,7 +358,7 @@ system and gives an overview of their function and contents. Disk space monitoring is disabled by default. To enable monitoring, add the ``BB_DISKMON_DIRS`` variable to your ``conf/local.conf`` file - found in the `Build Directory <#build-directory>`__. Use the + found in the :term:`Build Directory`. Use the following form: BB_DISKMON_DIRS = "action,dir,threshold [...]" where: action is: ABORT: Immediately abort the build when a threshold is broken. STOPTASKS: Stop the build after the currently executing tasks @@ -379,7 +379,7 @@ system and gives an overview of their function and contents. WARN,${SSTATE_DIR},1G,100K" BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G" BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" The first example works only if you also provide the - ```BB_DISKMON_WARNINTERVAL`` <#var-BB_DISKMON_WARNINTERVAL>`__ + :term:`BB_DISKMON_WARNINTERVAL` variable in the ``conf/local.conf``. This example causes the build system to immediately abort when either the disk space in ``${TMPDIR}`` drops below 1 Gbyte or the available free inodes drops @@ -402,10 +402,10 @@ system and gives an overview of their function and contents. BB_DISKMON_WARNINTERVAL Defines the disk space and free inode warning intervals. To set these intervals, define the variable in your ``conf/local.conf`` file in - the `Build Directory <#build-directory>`__. + the :term:`Build Directory`. If you are going to use the ``BB_DISKMON_WARNINTERVAL`` variable, you - must also use the ```BB_DISKMON_DIRS`` <#var-BB_DISKMON_DIRS>`__ + must also use the :term:`BB_DISKMON_DIRS` variable and define its action as "WARN". During the build, subsequent warnings are issued each time disk space or number of free inodes further reduces by the respective interval. @@ -436,12 +436,12 @@ system and gives an overview of their function and contents. BB_GENERATE_MIRROR_TARBALLS Causes tarballs of the source control repositories (e.g. Git repositories), including metadata, to be placed in the - ```DL_DIR`` <#var-DL_DIR>`__ directory. + :term:`DL_DIR` directory. For performance reasons, creating and placing tarballs of these repositories is not the default action by the OpenEmbedded build system. BB_GENERATE_MIRROR_TARBALLS = "1" Set this variable in your - ``local.conf`` file in the `Build Directory <#build-directory>`__. + ``local.conf`` file in the :term:`Build Directory`. Once you have the tarballs containing your source files, you can clean up your ``DL_DIR`` directory by deleting any Git or other @@ -481,7 +481,7 @@ system and gives an overview of their function and contents. ``quilt-native``, which is a copy of Quilt built to run on the build system; "crosses" such as ``gcc-cross``, which is a compiler built to run on the build machine but produces binaries that run on the target - ```MACHINE`` <#var-MACHINE>`__; "nativesdk", which targets the SDK + :term:`MACHINE`; "nativesdk", which targets the SDK machine instead of ``MACHINE``; and "mulitlibs" in the form "``multilib:``\ multilib_name". @@ -495,7 +495,7 @@ system and gives an overview of their function and contents. Internally, the ``BBCLASSEXTEND`` mechanism generates recipe variants by rewriting variable values and applying overrides such as ``_class-native``. For example, to generate a native version of - a recipe, a ```DEPENDS`` <#var-DEPENDS>`__ on "foo" is rewritten + a recipe, a :term:`DEPENDS` on "foo" is rewritten to a ``DEPENDS`` on "foo-native". Even when using ``BBCLASSEXTEND``, the recipe is only parsed once. @@ -511,7 +511,7 @@ system and gives an overview of their function and contents. BBFILE_PATTERN Variable that expands to match files from - ```BBFILES`` <#var-BBFILES>`__ in a particular layer. This variable + :term:`BBFILES` in a particular layer. This variable is used in the ``conf/layer.conf`` file and must be suffixed with the name of the specific layer (e.g. ``BBFILE_PATTERN_emenlow``). @@ -523,7 +523,7 @@ system and gives an overview of their function and contents. prioritize a layer against other layers that contain the same recipe - effectively letting you control the precedence for the multiple layers. The precedence established through this variable stands - regardless of a recipe's version (```PV`` <#var-PV>`__ variable). For + regardless of a recipe's version (:term:`PV` variable). For example, a layer that has a recipe with a higher ``PV`` value but for which the ``BBFILE_PRIORITY`` is set to have a lower precedence still has a lower precedence. @@ -576,7 +576,7 @@ system and gives an overview of their function and contents. Variable that controls how BitBake displays logs on build failure. BBINCLUDELOGS_LINES - If ```BBINCLUDELOGS`` <#var-BBINCLUDELOGS>`__ is set, specifies the + If :term:`BBINCLUDELOGS` is set, specifies the maximum number of lines from the task log file to print when reporting a failed task. If you do not set ``BBINCLUDELOGS_LINES``, the entire log is printed. @@ -629,7 +629,7 @@ system and gives an overview of their function and contents. multiconfigname for each configuration file you are using. For example, the following line specifies three configuration files: BBMULTICONFIG = "configA configB configC" Each configuration file you - use must reside in the `Build Directory <#build-directory>`__ + use must reside in the :term:`Build Directory` ``conf/multiconfig`` directory (e.g. build_directory\ ``/conf/multiconfig/configA.conf``). @@ -672,7 +672,7 @@ system and gives an overview of their function and contents. BINCONFIG When inheriting the - ```binconfig-disabled`` <#ref-classes-binconfig-disabled>`__ class, + :ref:`binconfig-disabled ` class, this variable specifies binary configuration scripts to disable in favor of using ``pkg-config`` to query the information. The ``binconfig-disabled`` class will modify the specified scripts to @@ -684,7 +684,7 @@ system and gives an overview of their function and contents. ${bindir}/libpng16-config" BINCONFIG_GLOB - When inheriting the ```binconfig`` <#ref-classes-binconfig>`__ class, + When inheriting the :ref:`binconfig ` class, this variable specifies a wildcard for configuration scripts that need editing. The scripts are edited to correct any paths that have been set up during compilation so that they are correct for use when @@ -708,7 +708,7 @@ system and gives an overview of their function and contents. ``meta/classes/binconfig.bbclass`` in the `Source Directory <#source-directory>`__. You can also find general information on the class in the - "```binconfig.bbclass`` <#ref-classes-binconfig>`__" section. + ":ref:`binconfig.bbclass `" section. BP The base recipe name and version but without any special recipe name @@ -716,12 +716,12 @@ system and gives an overview of their function and contents. comprised of the following: ${BPN}-${PV} BPN - This variable is a version of the ```PN`` <#var-PN>`__ variable with + This variable is a version of the :term:`PN` variable with common prefixes and suffixes removed, such as ``nativesdk-``, ``-cross``, ``-native``, and multilib's ``lib64-`` and ``lib32-``. The exact lists of prefixes and suffixes removed are specified by the - ```MLPREFIX`` <#var-MLPREFIX>`__ and - ```SPECIAL_PKGSUFFIX`` <#var-SPECIAL_PKGSUFFIX>`__ variables, + :term:`MLPREFIX` and + :term:`SPECIAL_PKGSUFFIX` variables, respectively. BUGTRACKER @@ -747,37 +747,37 @@ system and gives an overview of their function and contents. Specifies the linker command to be used for the build host when the C compiler is being used as the linker. By default, ``BUILD_CCLD`` points to GCC and passes as arguments the value of - ```BUILD_CC_ARCH`` <#var-BUILD_CC_ARCH>`__, assuming + :term:`BUILD_CC_ARCH`, assuming ``BUILD_CC_ARCH`` is set. BUILD_CFLAGS Specifies the flags to pass to the C compiler when building for the build host. When building in the ``-native`` context, - ```CFLAGS`` <#var-CFLAGS>`__ is set to the value of this variable by + :term:`CFLAGS` is set to the value of this variable by default. BUILD_CPPFLAGS Specifies the flags to pass to the C preprocessor (i.e. to both the C and the C++ compilers) when building for the build host. When - building in the ``-native`` context, ```CPPFLAGS`` <#var-CPPFLAGS>`__ + building in the ``-native`` context, :term:`CPPFLAGS` is set to the value of this variable by default. BUILD_CXXFLAGS Specifies the flags to pass to the C++ compiler when building for the build host. When building in the ``-native`` context, - ```CXXFLAGS`` <#var-CXXFLAGS>`__ is set to the value of this variable + :term:`CXXFLAGS` is set to the value of this variable by default. BUILD_FC Specifies the Fortran compiler command for the build host. By default, ``BUILD_FC`` points to Gfortran and passes as arguments the - value of ```BUILD_CC_ARCH`` <#var-BUILD_CC_ARCH>`__, assuming + value of :term:`BUILD_CC_ARCH`, assuming ``BUILD_CC_ARCH`` is set. BUILD_LD Specifies the linker command for the build host. By default, ``BUILD_LD`` points to the GNU linker (ld) and passes as arguments - the value of ```BUILD_LD_ARCH`` <#var-BUILD_LD_ARCH>`__, assuming + the value of :term:`BUILD_LD_ARCH`, assuming ``BUILD_LD_ARCH`` is set. BUILD_LD_ARCH @@ -787,14 +787,14 @@ system and gives an overview of their function and contents. BUILD_LDFLAGS Specifies the flags to pass to the linker when building for the build host. When building in the ``-native`` context, - ```LDFLAGS`` <#var-LDFLAGS>`__ is set to the value of this variable + :term:`LDFLAGS` is set to the value of this variable by default. BUILD_OPTIMIZATION Specifies the optimization flags passed to the C compiler when building for the build host or the SDK. The flags are passed through - the ```BUILD_CFLAGS`` <#var-BUILD_CFLAGS>`__ and - ```BUILDSDK_CFLAGS`` <#var-BUILDSDK_CFLAGS>`__ default values. + the :term:`BUILD_CFLAGS` and + :term:`BUILDSDK_CFLAGS` default values. The default value of the ``BUILD_OPTIMIZATION`` variable is "-O2 -pipe". @@ -808,14 +808,14 @@ system and gives an overview of their function and contents. BUILD_PREFIX The toolchain binary prefix used for native recipes. The OpenEmbedded build system uses the ``BUILD_PREFIX`` value to set the - ```TARGET_PREFIX`` <#var-TARGET_PREFIX>`__ when building for + :term:`TARGET_PREFIX` when building for ``native`` recipes. BUILD_STRIP Specifies the command to be used to strip debugging symbols from binaries produced for the build host. By default, ``BUILD_STRIP`` points to - ``${``\ ```BUILD_PREFIX`` <#var-BUILD_PREFIX>`__\ ``}strip``. + ``${``\ :term:`BUILD_PREFIX`\ ``}strip``. BUILD_SYS Specifies the system, including the architecture and the operating @@ -823,9 +823,9 @@ system and gives an overview of their function and contents. ``native`` recipes). The OpenEmbedded build system automatically sets this variable based - on ```BUILD_ARCH`` <#var-BUILD_ARCH>`__, - ```BUILD_VENDOR`` <#var-BUILD_VENDOR>`__, and - ```BUILD_OS`` <#var-BUILD_OS>`__. You do not need to set the + on :term:`BUILD_ARCH`, + :term:`BUILD_VENDOR`, and + :term:`BUILD_OS`. You do not need to set the ``BUILD_SYS`` variable yourself. BUILD_VENDOR @@ -833,7 +833,7 @@ system and gives an overview of their function and contents. The default value is an empty string (""). BUILDDIR - Points to the location of the `Build Directory <#build-directory>`__. + Points to the location of the :term:`Build Directory`. You can define this directory indirectly through the ````` <#structure-core-script>`__ script by passing in a Build Directory path when you run the script. If you run the script and do @@ -841,7 +841,7 @@ system and gives an overview of their function and contents. ``build`` in the current directory. BUILDHISTORY_COMMIT - When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__ + When inheriting the :ref:`buildhistory ` class, this variable specifies whether or not to commit the build history output in a local Git repository. If set to "1", this local repository will be maintained automatically by the ``buildhistory`` @@ -854,10 +854,10 @@ system and gives an overview of their function and contents. history output in a local Git repository: BUILDHISTORY_COMMIT ?= "0" BUILDHISTORY_COMMIT_AUTHOR - When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__ + When inheriting the :ref:`buildhistory ` class, this variable specifies the author to use for each Git commit. In order for the ``BUILDHISTORY_COMMIT_AUTHOR`` variable to work, the - ```BUILDHISTORY_COMMIT`` <#var-BUILDHISTORY_COMMIT>`__ variable must + :term:`BUILDHISTORY_COMMIT` variable must be set to "1". Git requires that the value you provide for the @@ -869,7 +869,7 @@ system and gives an overview of their function and contents. BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory " BUILDHISTORY_DIR - When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__ + When inheriting the :ref:`buildhistory ` class, this variable specifies the directory in which build history information is kept. For more information on how the variable works, see the ``buildhistory.class``. @@ -878,7 +878,7 @@ system and gives an overview of their function and contents. BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory" BUILDHISTORY_FEATURES - When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__ + When inheriting the :ref:`buildhistory ` class, this variable specifies the build history features to be enabled. For more information on how build history works, see the "`Maintaining Build Output @@ -904,7 +904,7 @@ system and gives an overview of their function and contents. features: BUILDHISTORY_FEATURES ?= "image package sdk" BUILDHISTORY_IMAGE_FILES - When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__ + When inheriting the :ref:`buildhistory ` class, this variable specifies a list of paths to files copied from the image contents into the build history directory under an "image-files" directory in the directory for the image, so that you @@ -918,11 +918,11 @@ system and gives an overview of their function and contents. following files: BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group" BUILDHISTORY_PUSH_REPO - When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__ + When inheriting the :ref:`buildhistory ` class, this variable optionally specifies a remote repository to which build history pushes Git changes. In order for ``BUILDHISTORY_PUSH_REPO`` to work, - ```BUILDHISTORY_COMMIT`` <#var-BUILDHISTORY_COMMIT>`__ must be set to + :term:`BUILDHISTORY_COMMIT` must be set to "1". The repository should correspond to a remote address that specifies a @@ -936,33 +936,33 @@ system and gives an overview of their function and contents. BUILDSDK_CFLAGS Specifies the flags to pass to the C compiler when building for the SDK. When building in the ``nativesdk-`` context, - ```CFLAGS`` <#var-CFLAGS>`__ is set to the value of this variable by + :term:`CFLAGS` is set to the value of this variable by default. BUILDSDK_CPPFLAGS Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the SDK. When building in - the ``nativesdk-`` context, ```CPPFLAGS`` <#var-CPPFLAGS>`__ is set + the ``nativesdk-`` context, :term:`CPPFLAGS` is set to the value of this variable by default. BUILDSDK_CXXFLAGS Specifies the flags to pass to the C++ compiler when building for the SDK. When building in the ``nativesdk-`` context, - ```CXXFLAGS`` <#var-CXXFLAGS>`__ is set to the value of this variable + :term:`CXXFLAGS` is set to the value of this variable by default. BUILDSDK_LDFLAGS Specifies the flags to pass to the linker when building for the SDK. When building in the ``nativesdk-`` context, - ```LDFLAGS`` <#var-LDFLAGS>`__ is set to the value of this variable + :term:`LDFLAGS` is set to the value of this variable by default. BUILDSTATS_BASE Points to the location of the directory that holds build statistics when you use and enable the - ```buildstats`` <#ref-classes-buildstats>`__ class. The + :ref:`buildstats ` class. The ``BUILDSTATS_BASE`` directory defaults to - ``${``\ ```TMPDIR`` <#var-TMPDIR>`__\ ``}/buildstats/``. + ``${``\ :term:`TMPDIR`\ ``}/buildstats/``. BUSYBOX_SPLIT_SUID For the BusyBox recipe, specifies whether to split the output @@ -976,7 +976,7 @@ system and gives an overview of their function and contents. CACHE Specifies the directory BitBake uses to store a cache of the - `Metadata <#metadata>`__ so it does not need to be parsed every time + :term:`Metadata` so it does not need to be parsed every time BitBake is started. CC @@ -990,21 +990,21 @@ system and gives an overview of their function and contents. Default initialization for ``CFLAGS`` varies depending on what is being built: - - ```TARGET_CFLAGS`` <#var-TARGET_CFLAGS>`__ when building for the + - :term:`TARGET_CFLAGS` when building for the target - - ```BUILD_CFLAGS`` <#var-BUILD_CFLAGS>`__ when building for the + - :term:`BUILD_CFLAGS` when building for the build host (i.e. ``-native``) - - ```BUILDSDK_CFLAGS`` <#var-BUILDSDK_CFLAGS>`__ when building for + - :term:`BUILDSDK_CFLAGS` when building for an SDK (i.e. ``nativesdk-``) CLASSOVERRIDE An internal variable specifying the special class override that should currently apply (e.g. "class-target", "class-native", and so forth). The classes that use this variable (e.g. - ```native`` <#ref-classes-native>`__, - ```nativesdk`` <#ref-classes-nativesdk>`__, and so forth) set the + :ref:`native `, + :ref:`nativesdk `, and so forth) set the variable to appropriate values. .. note:: @@ -1022,19 +1022,19 @@ system and gives an overview of their function and contents. building for the build host: FOO_class-native = "native" FOO = "other" The underlying mechanism behind ``CLASSOVERRIDE`` is simply that it is included in the default value of - ```OVERRIDES`` <#var-OVERRIDES>`__. + :term:`OVERRIDES`. CLEANBROKEN If set to "1" within a recipe, ``CLEANBROKEN`` specifies that the ``make clean`` command does not work for the software being built. Consequently, the OpenEmbedded build system will not try to run - ``make clean`` during the ```do_configure`` <#ref-tasks-configure>`__ + ``make clean`` during the :ref:`ref-tasks-configure` task, which is the default behavior. COMBINED_FEATURES Provides a list of hardware features that are enabled in both - ```MACHINE_FEATURES`` <#var-MACHINE_FEATURES>`__ and - ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__. This select list of + :term:`MACHINE_FEATURES` and + :term:`DISTRO_FEATURES`. This select list of features contains features that make sense to be controlled both at the machine and distribution configuration level. For example, the "bluetooth" feature requires hardware support but should also be @@ -1050,7 +1050,7 @@ system and gives an overview of their function and contents. A regular expression that resolves to one or more hosts (when the recipe is native) or one or more targets (when the recipe is non-native) with which a recipe is compatible. The regular expression - is matched against ```HOST_SYS`` <#var-HOST_SYS>`__. You can use the + is matched against :term:`HOST_SYS`. You can use the variable to stop recipes from being built for classes of systems with which the recipes are not compatible. Stopping these builds is particularly useful with kernels. The variable also helps to increase @@ -1060,7 +1060,7 @@ system and gives an overview of their function and contents. COMPATIBLE_MACHINE A regular expression that resolves to one or more target machines with which a recipe is compatible. The regular expression is matched - against ```MACHINEOVERRIDES`` <#var-MACHINEOVERRIDES>`__. You can use + against :term:`MACHINEOVERRIDES`. You can use the variable to stop recipes from being built for machines with which the recipes are not compatible. Stopping these builds is particularly useful with kernels. The variable also helps to increase parsing @@ -1084,7 +1084,7 @@ system and gives an overview of their function and contents. The resulting list of complementary packages is associated with an item that can be added to - ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__. An example usage of + :term:`IMAGE_FEATURES`. An example usage of this is the "dev-pkgs" item that when added to ``IMAGE_FEATURES`` will install -dev packages (containing headers and other development files) for every package in the image. @@ -1099,9 +1099,9 @@ system and gives an overview of their function and contents. sysroots for other recipes. The default is - "``${``\ ```STAGING_DIR`` <#var-STAGING_DIR>`__\ ``}-components``." + "``${``\ :term:`STAGING_DIR`\ ``}-components``." (i.e. - "``${``\ ```TMPDIR`` <#var-TMPDIR>`__\ ``}/sysroots-components``"). + "``${``\ :term:`TMPDIR`\ ``}/sysroots-components``"). CONF_VERSION Tracks the version of the local configuration file (i.e. @@ -1183,7 +1183,7 @@ system and gives an overview of their function and contents. CONFLICT_DISTRO_FEATURES When inheriting the - ```distro_features_check`` <#ref-classes-distro_features_check>`__ + :ref:`distro_features_check ` class, this variable identifies distribution features that would be in conflict should the recipe be built. In other words, if the ``CONFLICT_DISTRO_FEATURES`` variable lists a feature that also @@ -1192,9 +1192,9 @@ system and gives an overview of their function and contents. COPYLEFT_LICENSE_EXCLUDE A space-separated list of licenses to exclude from the source - archived by the ```archiver`` <#ref-classes-archiver>`__ class. In + archived by the :ref:`archiver ` class. In other words, if a license in a recipe's - ```LICENSE`` <#var-LICENSE>`__ value is in the value of + :term:`LICENSE` value is in the value of ``COPYLEFT_LICENSE_EXCLUDE``, then its source is not archived by the class. @@ -1208,62 +1208,62 @@ system and gives an overview of their function and contents. The default value, which is "CLOSED Proprietary", for ``COPYLEFT_LICENSE_EXCLUDE`` is set by the - ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ class, which + :ref:`copyleft_filter ` class, which is inherited by the ``archiver`` class. COPYLEFT_LICENSE_INCLUDE A space-separated list of licenses to include in the source archived - by the ```archiver`` <#ref-classes-archiver>`__ class. In other - words, if a license in a recipe's ```LICENSE`` <#var-LICENSE>`__ + by the :ref:`archiver ` class. In other + words, if a license in a recipe's :term:`LICENSE` value is in the value of ``COPYLEFT_LICENSE_INCLUDE``, then its source is archived by the class. The default value is set by the - ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ class, which + :ref:`copyleft_filter ` class, which is inherited by the ``archiver`` class. The default value includes "GPL*", "LGPL*", and "AGPL*". COPYLEFT_PN_EXCLUDE A list of recipes to exclude in the source archived by the - ```archiver`` <#ref-classes-archiver>`__ class. The + :ref:`archiver ` class. The ``COPYLEFT_PN_EXCLUDE`` variable overrides the license inclusion and exclusion caused through the - ```COPYLEFT_LICENSE_INCLUDE`` <#var-COPYLEFT_LICENSE_INCLUDE>`__ and - ```COPYLEFT_LICENSE_EXCLUDE`` <#var-COPYLEFT_LICENSE_EXCLUDE>`__ + :term:`COPYLEFT_LICENSE_INCLUDE` and + :term:`COPYLEFT_LICENSE_EXCLUDE` variables, respectively. The default value, which is "" indicating to not explicitly exclude any recipes by name, for ``COPYLEFT_PN_EXCLUDE`` is set by the - ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ class, which + :ref:`copyleft_filter ` class, which is inherited by the ``archiver`` class. COPYLEFT_PN_INCLUDE A list of recipes to include in the source archived by the - ```archiver`` <#ref-classes-archiver>`__ class. The + :ref:`archiver ` class. The ``COPYLEFT_PN_INCLUDE`` variable overrides the license inclusion and exclusion caused through the - ```COPYLEFT_LICENSE_INCLUDE`` <#var-COPYLEFT_LICENSE_INCLUDE>`__ and - ```COPYLEFT_LICENSE_EXCLUDE`` <#var-COPYLEFT_LICENSE_EXCLUDE>`__ + :term:`COPYLEFT_LICENSE_INCLUDE` and + :term:`COPYLEFT_LICENSE_EXCLUDE` variables, respectively. The default value, which is "" indicating to not explicitly include any recipes by name, for ``COPYLEFT_PN_INCLUDE`` is set by the - ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ class, which + :ref:`copyleft_filter ` class, which is inherited by the ``archiver`` class. COPYLEFT_RECIPE_TYPES A space-separated list of recipe types to include in the source - archived by the ```archiver`` <#ref-classes-archiver>`__ class. + archived by the :ref:`archiver ` class. Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``, ``crosssdk``, and ``cross-canadian``. The default value, which is "target*", for ``COPYLEFT_RECIPE_TYPES`` - is set by the ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ + is set by the :ref:`copyleft_filter ` class, which is inherited by the ``archiver`` class. COPY_LIC_DIRS If set to "1" along with the - ```COPY_LIC_MANIFEST`` <#var-COPY_LIC_MANIFEST>`__ variable, the + :term:`COPY_LIC_MANIFEST` variable, the OpenEmbedded build system copies into the image the license files, which are located in ``/usr/share/common-licenses``, for each package. The license files are placed in directories within the image @@ -1304,7 +1304,7 @@ system and gives an overview of their function and contents. CORE_IMAGE_EXTRA_INSTALL Specifies the list of packages to be added to the image. You should only set this variable in the ``local.conf`` configuration file found - in the `Build Directory <#build-directory>`__. + in the :term:`Build Directory`. This variable replaces ``POKY_EXTRA_INSTALL``, which is no longer supported. @@ -1321,7 +1321,7 @@ system and gives an overview of their function and contents. the ``poky/meta`` layer. COREBASE_FILES - Lists files from the ```COREBASE`` <#var-COREBASE>`__ directory that + Lists files from the :term:`COREBASE` directory that should be copied other than the layers listed in the ``bblayers.conf`` file. The ``COREBASE_FILES`` variable exists for the purpose of copying metadata from the OpenEmbedded build system @@ -1345,19 +1345,19 @@ system and gives an overview of their function and contents. Default initialization for ``CPPFLAGS`` varies depending on what is being built: - - ```TARGET_CPPFLAGS`` <#var-TARGET_CPPFLAGS>`__ when building for + - :term:`TARGET_CPPFLAGS` when building for the target - - ```BUILD_CPPFLAGS`` <#var-BUILD_CPPFLAGS>`__ when building for the + - :term:`BUILD_CPPFLAGS` when building for the build host (i.e. ``-native``) - - ```BUILDSDK_CPPFLAGS`` <#var-BUILDSDK_CPPFLAGS>`__ when building + - :term:`BUILDSDK_CPPFLAGS` when building for an SDK (i.e. ``nativesdk-``) CROSS_COMPILE The toolchain binary prefix for the target tools. The ``CROSS_COMPILE`` variable is the same as the - ```TARGET_PREFIX`` <#var-TARGET_PREFIX>`__ variable. + :term:`TARGET_PREFIX` variable. .. note:: @@ -1381,19 +1381,19 @@ system and gives an overview of their function and contents. Default initialization for ``CXXFLAGS`` varies depending on what is being built: - - ```TARGET_CXXFLAGS`` <#var-TARGET_CXXFLAGS>`__ when building for + - :term:`TARGET_CXXFLAGS` when building for the target - - ```BUILD_CXXFLAGS`` <#var-BUILD_CXXFLAGS>`__ when building for the + - :term:`BUILD_CXXFLAGS` when building for the build host (i.e. ``-native``) - - ```BUILDSDK_CXXFLAGS`` <#var-BUILDSDK_CXXFLAGS>`__ when building + - :term:`BUILDSDK_CXXFLAGS` when building for an SDK (i.e. ``nativesdk-``) D The destination directory. The location in the `Build Directory <#build-directory>`__ where components are installed by the - ```do_install`` <#ref-tasks-install>`__ task. This location defaults + :ref:`ref-tasks-install` task. This location defaults to: ${WORKDIR}/image .. note:: @@ -1411,7 +1411,7 @@ system and gives an overview of their function and contents. suitable for timestamps. DEBIAN_NOAUTONAME - When the ```debian`` <#ref-classes-debian>`__ class is inherited, + When the :ref:`debian ` class is inherited, which is the default behavior, ``DEBIAN_NOAUTONAME`` specifies a particular package should not be renamed according to Debian library package naming. You must use the package name as an override when you @@ -1419,7 +1419,7 @@ system and gives an overview of their function and contents. DEBIAN_NOAUTONAME_fontconfig-utils = "1" DEBIANNAME - When the ```debian`` <#ref-classes-debian>`__ class is inherited, + When the :ref:`debian ` class is inherited, which is the default behavior, ``DEBIANNAME`` allows you to override the library name for an individual package. Overriding the library name in these cases is rare. You must use the package name as an @@ -1457,12 +1457,12 @@ system and gives an overview of their function and contents. The default CPU and Application Binary Interface (ABI) tunings (i.e. the "tune") used by the OpenEmbedded build system. The ``DEFAULTTUNE`` helps define - ```TUNE_FEATURES`` <#var-TUNE_FEATURES>`__. + :term:`TUNE_FEATURES`. The default tune is either implicitly or explicitly set by the - machine (```MACHINE`` <#var-MACHINE>`__). However, you can override + machine (:term:`MACHINE`). However, you can override the setting using available tunes as defined with - ```AVAILTUNES`` <#var-AVAILTUNES>`__. + :term:`AVAILTUNES`. DEPENDS Lists a recipe's build-time dependencies. These are dependencies on @@ -1474,12 +1474,12 @@ system and gives an overview of their function and contents. assignment is that all files installed by bar will be available in the appropriate staging sysroot, given by the ```STAGING_DIR*`` <#var-STAGING_DIR>`__ variables, by the time the - ```do_configure`` <#ref-tasks-configure>`__ task for ``foo`` runs. + :ref:`ref-tasks-configure` task for ``foo`` runs. This mechanism is implemented by having ``do_configure`` depend on - the ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task of + the :ref:`ref-tasks-populate_sysroot` task of each recipe listed in ``DEPENDS``, through a ``[``\ ```deptask`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` - declaration in the ```base`` <#ref-classes-base>`__ class. + declaration in the :ref:`base ` class. .. note:: @@ -1492,13 +1492,13 @@ system and gives an overview of their function and contents. that run on the build machine during the build. For example, a recipe that makes use of a code generator built by the recipe ``codegen`` might have the following: DEPENDS = "codegen-native" For more - information, see the ```native`` <#ref-classes-native>`__ class and - the ```EXTRANATIVEPATH`` <#var-EXTRANATIVEPATH>`__ variable. + information, see the :ref:`native ` class and + the :term:`EXTRANATIVEPATH` variable. .. note:: - ``DEPENDS`` is a list of recipe names. Or, to be more precise, - it is a list of ```PROVIDES`` <#var-PROVIDES>`__ names, which + it is a list of :term:`PROVIDES` names, which usually match recipe names. Putting a package name such as "foo-dev" in ``DEPENDS`` does not make sense. Use "foo" instead, as this will put files from all the packages that make @@ -1524,7 +1524,7 @@ system and gives an overview of their function and contents. fail to link against ``libfoo``. For information on runtime dependencies, see the - ```RDEPENDS`` <#var-RDEPENDS>`__ variable. You can also see the + :term:`RDEPENDS` variable. You can also see the "`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and "`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the BitBake User Manual for additional information on tasks and @@ -1534,7 +1534,7 @@ system and gives an overview of their function and contents. Points to the general area that the OpenEmbedded build system uses to place images, packages, SDKs, and other output files that are ready to be used outside of the build system. By default, this directory - resides within the `Build Directory <#build-directory>`__ as + resides within the :term:`Build Directory` as ``${TMPDIR}/deploy``. For more information on the structure of the Build Directory, see @@ -1550,17 +1550,17 @@ system and gives an overview of their function and contents. Points to the area that the OpenEmbedded build system uses to place Debian packages that are ready to be used outside of the build system. This variable applies only when - ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ contains + :term:`PACKAGE_CLASSES` contains "package_deb". The BitBake configuration file initially defines the ``DEPLOY_DIR_DEB`` variable as a sub-folder of - ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__: DEPLOY_DIR_DEB = + :term:`DEPLOY_DIR`: DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb" - The ```package_deb`` <#ref-classes-package_deb>`__ class uses the + The :ref:`package_deb ` class uses the ``DEPLOY_DIR_DEB`` variable to make sure the - ```do_package_write_deb`` <#ref-tasks-package_write_deb>`__ task + :ref:`ref-tasks-package_write_deb` task writes Debian packages into the appropriate folder. For more information on how packaging works, see the "`Package Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section @@ -1571,7 +1571,7 @@ system and gives an overview of their function and contents. images and other associated output files that are ready to be deployed onto the target machine. The directory is machine-specific as it contains the ``${MACHINE}`` name. By default, this directory - resides within the `Build Directory <#build-directory>`__ as + resides within the :term:`Build Directory` as ``${DEPLOY_DIR}/images/${MACHINE}/``. For more information on the structure of the Build Directory, see @@ -1586,16 +1586,16 @@ system and gives an overview of their function and contents. Points to the area that the OpenEmbedded build system uses to place IPK packages that are ready to be used outside of the build system. This variable applies only when - ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ contains + :term:`PACKAGE_CLASSES` contains "package_ipk". The BitBake configuration file initially defines this variable as a - sub-folder of ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__: DEPLOY_DIR_IPK = + sub-folder of :term:`DEPLOY_DIR`: DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk" - The ```package_ipk`` <#ref-classes-package_ipk>`__ class uses the + The :ref:`package_ipk ` class uses the ``DEPLOY_DIR_IPK`` variable to make sure the - ```do_package_write_ipk`` <#ref-tasks-package_write_ipk>`__ task + :ref:`ref-tasks-package_write_ipk` task writes IPK packages into the appropriate folder. For more information on how packaging works, see the "`Package Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section @@ -1605,16 +1605,16 @@ system and gives an overview of their function and contents. Points to the area that the OpenEmbedded build system uses to place RPM packages that are ready to be used outside of the build system. This variable applies only when - ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ contains + :term:`PACKAGE_CLASSES` contains "package_rpm". The BitBake configuration file initially defines this variable as a - sub-folder of ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__: DEPLOY_DIR_RPM = + sub-folder of :term:`DEPLOY_DIR`: DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm" - The ```package_rpm`` <#ref-classes-package_rpm>`__ class uses the + The :ref:`package_rpm ` class uses the ``DEPLOY_DIR_RPM`` variable to make sure the - ```do_package_write_rpm`` <#ref-tasks-package_write_rpm>`__ task + :ref:`ref-tasks-package_write_rpm` task writes RPM packages into the appropriate folder. For more information on how packaging works, see the "`Package Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section @@ -1624,40 +1624,40 @@ system and gives an overview of their function and contents. Points to the area that the OpenEmbedded build system uses to place tarballs that are ready to be used outside of the build system. This variable applies only when - ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ contains + :term:`PACKAGE_CLASSES` contains "package_tar". The BitBake configuration file initially defines this variable as a - sub-folder of ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__: DEPLOY_DIR_TAR = + sub-folder of :term:`DEPLOY_DIR`: DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar" - The ```package_tar`` <#ref-classes-package_tar>`__ class uses the + The :ref:`package_tar ` class uses the ``DEPLOY_DIR_TAR`` variable to make sure the - ```do_package_write_tar`` <#ref-tasks-package_write_tar>`__ task + :ref:`ref-tasks-package_write_tar` task writes TAR packages into the appropriate folder. For more information on how packaging works, see the "`Package Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in the Yocto Project Overview and Concepts Manual. DEPLOYDIR - When inheriting the ```deploy`` <#ref-classes-deploy>`__ class, the + When inheriting the :ref:`deploy ` class, the ``DEPLOYDIR`` points to a temporary work area for deployed files that is set in the ``deploy`` class as follows: DEPLOYDIR = - "${WORKDIR}/deploy-${```PN`` <#var-PN>`__}" + "${WORKDIR}/deploy-${:term:`PN`}" Recipes inheriting the ``deploy`` class should copy files to be deployed into ``DEPLOYDIR``, and the class will take care of copying - them into ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__ + them into :term:`DEPLOY_DIR_IMAGE` afterwards. DESCRIPTION The package description used by package managers. If not set, - ``DESCRIPTION`` takes the value of the ```SUMMARY`` <#var-SUMMARY>`__ + ``DESCRIPTION`` takes the value of the :term:`SUMMARY` variable. DISTRO The short name of the distribution. For information on the long name - of the distribution, see the ```DISTRO_NAME`` <#var-DISTRO_NAME>`__ + of the distribution, see the :term:`DISTRO_NAME` variable. The ``DISTRO`` variable corresponds to a distribution configuration @@ -1671,7 +1671,7 @@ system and gives an overview of their function and contents. follows: DISTRO = "poky" Distribution configuration files are located in a ``conf/distro`` - directory within the `Metadata <#metadata>`__ that contains the + directory within the :term:`Metadata` that contains the distribution configuration. The value for ``DISTRO`` must not contain spaces, and is typically all lower-case. @@ -1709,7 +1709,7 @@ system and gives an overview of their function and contents. In most cases, the presence or absence of a feature in ``DISTRO_FEATURES`` is translated to the appropriate option supplied to the configure script during the - ```do_configure`` <#ref-tasks-configure>`__ task for recipes that + :ref:`ref-tasks-configure` task for recipes that optionally support the feature. For example, specifying "x11" in ``DISTRO_FEATURES``, causes every piece of software built for the target that can optionally support X11 to have its X11 support @@ -1744,59 +1744,59 @@ system and gives an overview of their function and contents. When creating a custom distribution, you might find it useful to be able to reuse the default - ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ options without the + :term:`DISTRO_FEATURES` options without the need to write out the full set. Here is an example that uses ``DISTRO_FEATURES_DEFAULT`` from a custom distro configuration file: DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} myfeature" DISTRO_FEATURES_FILTER_NATIVE Specifies a list of features that if present in the target - ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ value should be + :term:`DISTRO_FEATURES` value should be included in ``DISTRO_FEATURES`` when building native recipes. This variable is used in addition to the features filtered using the - ```DISTRO_FEATURES_NATIVE`` <#var-DISTRO_FEATURES_NATIVE>`__ + :term:`DISTRO_FEATURES_NATIVE` variable. DISTRO_FEATURES_FILTER_NATIVESDK Specifies a list of features that if present in the target - ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ value should be + :term:`DISTRO_FEATURES` value should be included in ``DISTRO_FEATURES`` when building nativesdk recipes. This variable is used in addition to the features filtered using the - ```DISTRO_FEATURES_NATIVESDK`` <#var-DISTRO_FEATURES_NATIVESDK>`__ + :term:`DISTRO_FEATURES_NATIVESDK` variable. DISTRO_FEATURES_NATIVE Specifies a list of features that should be included in - ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ when building native + :term:`DISTRO_FEATURES` when building native recipes. This variable is used in addition to the features filtered using the - ```DISTRO_FEATURES_FILTER_NATIVE`` <#var-DISTRO_FEATURES_FILTER_NATIVE>`__ + :term:`DISTRO_FEATURES_FILTER_NATIVE` variable. DISTRO_FEATURES_NATIVESDK Specifies a list of features that should be included in - ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ when building + :term:`DISTRO_FEATURES` when building nativesdk recipes. This variable is used in addition to the features filtered using the - ```DISTRO_FEATURES_FILTER_NATIVESDK`` <#var-DISTRO_FEATURES_FILTER_NATIVESDK>`__ + :term:`DISTRO_FEATURES_FILTER_NATIVESDK` variable. DISTRO_NAME The long name of the distribution. For information on the short name - of the distribution, see the ```DISTRO`` <#var-DISTRO>`__ variable. + of the distribution, see the :term:`DISTRO` variable. The ``DISTRO_NAME`` variable corresponds to a distribution configuration file whose root name is the same as the variable's argument and whose filename extension is ``.conf``. For example, the distribution configuration file for the Poky distribution is named ``poky.conf`` and resides in the ``meta-poky/conf/distro`` directory - of the `Source Directory <#source-directory>`__. + of the :term:`Source Directory`. Within that ``poky.conf`` file, the ``DISTRO_NAME`` variable is set as follows: DISTRO_NAME = "Poky (Yocto Project Reference Distro)" Distribution configuration files are located in a ``conf/distro`` - directory within the `Metadata <#metadata>`__ that contains the + directory within the :term:`Metadata` that contains the distribution configuration. .. note:: @@ -1814,27 +1814,27 @@ system and gives an overview of their function and contents. DISTROOVERRIDES A colon-separated list of overrides specific to the current distribution. By default, this list includes the value of - ```DISTRO`` <#var-DISTRO>`__. + :term:`DISTRO`. You can extend ``DISTROOVERRIDES`` to add extra overrides that should apply to the distribution. The underlying mechanism behind ``DISTROOVERRIDES`` is simply that it is included in the default value of - ```OVERRIDES`` <#var-OVERRIDES>`__. + :term:`OVERRIDES`. DL_DIR The central download directory used by the build process to store downloads. By default, ``DL_DIR`` gets files suitable for mirroring for everything except Git repositories. If you want tarballs of Git repositories, use the - ```BB_GENERATE_MIRROR_TARBALLS`` <#var-BB_GENERATE_MIRROR_TARBALLS>`__ + :term:`BB_GENERATE_MIRROR_TARBALLS` variable. You can set this directory by defining the ``DL_DIR`` variable in the ``conf/local.conf`` file. This directory is self-maintaining and you should not have to touch it. By default, the directory is - ``downloads`` in the `Build Directory <#build-directory>`__. #DL_DIR + ``downloads`` in the :term:`Build Directory`. #DL_DIR ?= "${TOPDIR}/downloads" To specify a different download directory, simply remove the comment from the line and provide your directory. @@ -1859,7 +1859,7 @@ system and gives an overview of their function and contents. page. DOC_COMPRESS - When inheriting the ```compress_doc`` <#ref-classes-compress_doc>`__ + When inheriting the :ref:`compress_doc ` class, this variable sets the compression policy used when the OpenEmbedded build system compresses man pages and info pages. By default, the compression method used is gz (gzip). Other policies @@ -1870,12 +1870,12 @@ system and gives an overview of their function and contents. EFI_PROVIDER When building bootable images (i.e. where ``hddimg``, ``iso``, or - ``wic.vmdk`` is in ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__), the + ``wic.vmdk`` is in :term:`IMAGE_FSTYPES`), the ``EFI_PROVIDER`` variable specifies the EFI bootloader to use. The default is "grub-efi", but "systemd-boot" can be used instead. - See the ```systemd-boot`` <#ref-classes-systemd-boot>`__ and - ```image-live`` <#ref-classes-image-live>`__ classes for more + See the :ref:`systemd-boot ` and + :ref:`image-live ` classes for more information. ENABLE_BINARY_LOCALE_GENERATION @@ -1884,13 +1884,13 @@ system and gives an overview of their function and contents. less). ERR_REPORT_DIR - When used with the ```report-error`` <#ref-classes-report-error>`__ + When used with the :ref:`report-error ` class, specifies the path used for storing the debug files created by the `error reporting tool <&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool>`__, which allows you to submit build errors you encounter to a central database. By default, the value of this variable is - ``${``\ ```LOG_DIR`` <#var-LOG_DIR>`__\ ``}/error-report``. + ``${``\ :term:`LOG_DIR`\ ``}/error-report``. You can set ``ERR_REPORT_DIR`` to the path you want the error reporting tool to store the debug files as follows in your @@ -1901,7 +1901,7 @@ system and gives an overview of their function and contents. errors by the OpenEmbedded build system. You set this variable in your distribution configuration file. For a list of the checks you can control with this variable, see the - "```insane.bbclass`` <#ref-classes-insane>`__" section. + ":ref:`insane.bbclass `" section. EXCLUDE_FROM_SHLIBS Triggers the OpenEmbedded build system's shared libraries resolver to @@ -1918,7 +1918,7 @@ system and gives an overview of their function and contents. implicitly define some dependencies between packages. The ``EXCLUDE_FROM_SHLIBS`` variable is similar to the - ```PRIVATE_LIBS`` <#var-PRIVATE_LIBS>`__ variable, which excludes a + :term:`PRIVATE_LIBS` variable, which excludes a package's particular libraries only and not the whole package. Use the ``EXCLUDE_FROM_SHLIBS`` variable by setting it to "1" for a @@ -1945,13 +1945,13 @@ system and gives an overview of their function and contents. EXTENDPE Used with file and pathnames to create a prefix for a recipe's - version based on the recipe's ```PE`` <#var-PE>`__ value. If ``PE`` + version based on the recipe's :term:`PE` value. If ``PE`` is set and greater than zero for a recipe, ``EXTENDPE`` becomes that value (e.g if ``PE`` is equal to "1" then ``EXTENDPE`` becomes "1_"). If a recipe's ``PE`` is not set (the default) or is equal to zero, ``EXTENDPE`` becomes "". - See the ```STAMP`` <#var-STAMP>`__ variable for an example. + See the :term:`STAMP` variable for an example. EXTENDPKGV The full package version specification as it appears on the final @@ -1971,43 +1971,43 @@ system and gives an overview of their function and contents. any externally installed tools. Setting the ``EXTERNAL_KERNEL_TOOLS`` variable tells the OpenEmbedded build system to prefer the installed external tools. See the - ```kernel-yocto`` <#ref-classes-kernel-yocto>`__ class in + :ref:`kernel-yocto ` class in ``meta/classes`` to see how the variable is used. EXTERNALSRC - When inheriting the ```externalsrc`` <#ref-classes-externalsrc>`__ + When inheriting the :ref:`externalsrc ` class, this variable points to the source tree, which is outside of the OpenEmbedded build system. When set, this variable sets the - ```S`` <#var-S>`__ variable, which is what the OpenEmbedded build + :term:`S` variable, which is what the OpenEmbedded build system uses to locate unpacked recipe source code. For more information on ``externalsrc.bbclass``, see the - "```externalsrc.bbclass`` <#ref-classes-externalsrc>`__" section. You + ":ref:`externalsrc.bbclass `" section. You can also find information on how to use this variable in the "`Building Software from an External Source <&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source>`__" section in the Yocto Project Development Tasks Manual. EXTERNALSRC_BUILD - When inheriting the ```externalsrc`` <#ref-classes-externalsrc>`__ + When inheriting the :ref:`externalsrc ` class, this variable points to the directory in which the recipe's source code is built, which is outside of the OpenEmbedded build - system. When set, this variable sets the ```B`` <#var-B>`__ variable, + system. When set, this variable sets the :term:`B` variable, which is what the OpenEmbedded build system uses to locate the Build Directory. For more information on ``externalsrc.bbclass``, see the - "```externalsrc.bbclass`` <#ref-classes-externalsrc>`__" section. You + ":ref:`externalsrc.bbclass `" section. You can also find information on how to use this variable in the "`Building Software from an External Source <&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source>`__" section in the Yocto Project Development Tasks Manual. EXTRA_AUTORECONF - For recipes inheriting the ```autotools`` <#ref-classes-autotools>`__ + For recipes inheriting the :ref:`autotools ` class, you can use ``EXTRA_AUTORECONF`` to specify extra options to pass to the ``autoreconf`` command that is executed during the - ```do_configure`` <#ref-tasks-configure>`__ task. + :ref:`ref-tasks-configure` task. The default value is "--exclude=autopoint". @@ -2016,7 +2016,7 @@ system and gives an overview of their function and contents. more than one feature, separate them with a space. Typically, you configure this variable in your ``local.conf`` file, - which is found in the `Build Directory <#build-directory>`__. + which is found in the :term:`Build Directory`. Although you can use this variable from within a recipe, best practices dictate that you do not. @@ -2055,7 +2055,7 @@ system and gives an overview of their function and contents. EXTRA_IMAGECMD Specifies additional options for the image creation command that has - been specified in ```IMAGE_CMD`` <#var-IMAGE_CMD>`__. When setting + been specified in :term:`IMAGE_CMD`. When setting this variable, use an override for the associated image type. Here is an example: EXTRA_IMAGECMD_ext3 ?= "-i 4096" @@ -2080,7 +2080,7 @@ system and gives an overview of their function and contents. EXTRANATIVEPATH A list of subdirectories of - ``${``\ ```STAGING_BINDIR_NATIVE`` <#var-STAGING_BINDIR_NATIVE>`__\ ``}`` + ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}`` added to the beginning of the environment variable ``PATH``. As an example, the following prepends "${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" to @@ -2088,11 +2088,11 @@ system and gives an overview of their function and contents. EXTRA_OECMAKE Additional `CMake `__ options. See the - ```cmake`` <#ref-classes-cmake>`__ class for additional information. + :ref:`cmake ` class for additional information. EXTRA_OECONF Additional ``configure`` script options. See - ```PACKAGECONFIG_CONFARGS`` <#var-PACKAGECONFIG_CONFARGS>`__ for + :term:`PACKAGECONFIG_CONFARGS` for additional information on passing configure script options. EXTRA_OEMAKE @@ -2101,21 +2101,21 @@ system and gives an overview of their function and contents. Because the ``EXTRA_OEMAKE`` defaults to "", you need to set the variable to specify any required GNU options. - ```PARALLEL_MAKE`` <#var-PARALLEL_MAKE>`__ and - ```PARALLEL_MAKEINST`` <#var-PARALLEL_MAKEINST>`__ also make use of + :term:`PARALLEL_MAKE` and + :term:`PARALLEL_MAKEINST` also make use of ``EXTRA_OEMAKE`` to pass the required flags. EXTRA_OESCONS - When inheriting the ```scons`` <#ref-classes-scons>`__ class, this + When inheriting the :ref:`scons ` class, this variable specifies additional configuration options you want to pass to the ``scons`` command line. EXTRA_USERS_PARAMS - When inheriting the ```extrausers`` <#ref-classes-extrausers>`__ + When inheriting the :ref:`extrausers ` class, this variable provides image level user and group operations. This is a more global method of providing user and group configuration as compared to using the - ```useradd`` <#ref-classes-useradd>`__ class, which ties user and + :ref:`useradd ` class, which ties user and group configurations to a specific recipe. The set list of commands you can configure using the @@ -2127,7 +2127,7 @@ system and gives an overview of their function and contents. FEATURE_PACKAGES Defines one or more packages to include in an image when a specific - item is included in ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__. + item is included in :term:`IMAGE_FEATURES`. When setting the value, ``FEATURE_PACKAGES`` should have the name of the feature item as an override. Here is an example: FEATURE_PACKAGES_widget = "package1 package2" @@ -2161,7 +2161,7 @@ system and gives an overview of their function and contents. FILES The list of files and directories that are placed in a package. The - ```PACKAGES`` <#var-PACKAGES>`__ variable lists the packages + :term:`PACKAGES` variable lists the packages generated by a recipe. To use the ``FILES`` variable, provide a package name override that @@ -2183,7 +2183,7 @@ system and gives an overview of their function and contents. use ``${sysconfdir}`` rather than ``/etc``, or ``${bindir}`` rather than ``/usr/bin``. You can find a list of these variables at the top of the ``meta/conf/bitbake.conf`` file in - the `Source Directory <#source-directory>`__. You will also + the :term:`Source Directory`. You will also find the default values of the various ``FILES_*`` variables in this file. @@ -2191,12 +2191,12 @@ system and gives an overview of their function and contents. editable and you know they should not be overwritten during the package update process by the Package Management System (PMS), you can identify these files so that the PMS will not overwrite them. See - the ```CONFFILES`` <#var-CONFFILES>`__ variable for information on + the :term:`CONFFILES` variable for information on how to identify these files to the PMS. FILES_SOLIBSDEV Defines the file specification to match - ```SOLIBSDEV`` <#var-SOLIBSDEV>`__. In other words, + :term:`SOLIBSDEV`. In other words, ``FILES_SOLIBSDEV`` defines the full path name of the development symbolic link (symlink) for shared libraries on the target platform. @@ -2208,7 +2208,7 @@ system and gives an overview of their function and contents. Extends the search path the OpenEmbedded build system uses when looking for files and patches as it processes recipes and append files. The default directories BitBake uses when it processes recipes - are initially defined by the ```FILESPATH`` <#var-FILESPATH>`__ + are initially defined by the :term:`FILESPATH` variable. You can extend ``FILESPATH`` variable by using ``FILESEXTRAPATHS``. @@ -2223,7 +2223,7 @@ system and gives an overview of their function and contents. When extending ``FILESEXTRAPATHS``, be sure to use the immediate expansion (``:=``) operator. Immediate expansion makes sure that - BitBake evaluates ```THISDIR`` <#var-THISDIR>`__ at the time the + BitBake evaluates :term:`THISDIR` at the time the directive is encountered rather than at some later time when expansion might result in a directory that does not contain the files you need. @@ -2242,14 +2242,14 @@ system and gives an overview of their function and contents. FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" A final example shows how you can extend the search path and include - a ```MACHINE`` <#var-MACHINE>`__-specific override, which is useful + a :term:`MACHINE`-specific override, which is useful in a BSP layer: FILESEXTRAPATHS_prepend_intel-x86-common := "${THISDIR}/${PN}:" The previous statement appears in the ``linux-yocto-dev.bbappend`` file, which is found in the Yocto Project `Source Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ in ``meta-intel/common/recipes-kernel/linux``. Here, the machine - override is a special ```PACKAGE_ARCH`` <#var-PACKAGE_ARCH>`__ + override is a special :term:`PACKAGE_ARCH` definition for multiple ``meta-intel`` machines. .. note:: @@ -2264,12 +2264,12 @@ system and gives an overview of their function and contents. recipe to correctly extend the path. FILESOVERRIDES - A subset of ```OVERRIDES`` <#var-OVERRIDES>`__ used by the + A subset of :term:`OVERRIDES` used by the OpenEmbedded build system for creating - ```FILESPATH`` <#var-FILESPATH>`__. The ``FILESOVERRIDES`` variable + :term:`FILESPATH`. The ``FILESOVERRIDES`` variable uses overrides to automatically extend the - ```FILESPATH`` <#var-FILESPATH>`__ variable. For an example of how - that works, see the ```FILESPATH`` <#var-FILESPATH>`__ variable + :term:`FILESPATH` variable. For an example of how + that works, see the :term:`FILESPATH` variable description. Additionally, you find more information on how overrides are handled in the "`Conditional Syntax (Overrides) <&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides>`__" @@ -2293,7 +2293,7 @@ system and gives an overview of their function and contents. During the build process, BitBake searches each directory in ``FILESPATH`` in the specified order when looking for files and patches specified by each ``file://`` URI in a recipe's - ```SRC_URI`` <#var-SRC_URI>`__ statements. + :term:`SRC_URI` statements. The default value for the ``FILESPATH`` variable is defined in the ``base.bbclass`` class found in ``meta/classes`` in the `Source @@ -2301,14 +2301,14 @@ system and gives an overview of their function and contents. "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \\ "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" The ``FILESPATH`` variable is automatically extended using the overrides - from the ```FILESOVERRIDES`` <#var-FILESOVERRIDES>`__ variable. + from the :term:`FILESOVERRIDES` variable. .. note:: - Do not hand-edit the ``FILESPATH`` variable. If you want the build system to look in directories other than the defaults, extend the ``FILESPATH`` variable by using the - ```FILESEXTRAPATHS`` <#var-FILESEXTRAPATHS>`__ variable. + :term:`FILESEXTRAPATHS` variable. - Be aware that the default ``FILESPATH`` directories do not map to directories in custom layers where append files @@ -2323,7 +2323,7 @@ system and gives an overview of their function and contents. files/defconfig files/MACHINEA/defconfig files/MACHINEB/defconfig Also in the example, the ``SRC_URI`` statement contains "file://defconfig". Given this scenario, you can set - ```MACHINE`` <#var-MACHINE>`__ to "MACHINEA" and cause the build + :term:`MACHINE` to "MACHINEA" and cause the build system to use files from ``files/MACHINEA``. Set ``MACHINE`` to "MACHINEB" and the build system uses files from ``files/MACHINEB``. Finally, for any machine other than "MACHINEA" and "MACHINEB", the @@ -2334,7 +2334,7 @@ system and gives an overview of their function and contents. in the Yocto Project Overview and Concepts Manual and the "`Patching Code <&YOCTO_DOCS_DEV_URL;#new-recipe-patching-code>`__" section in the Yocto Project Development Tasks Manual. See the - ```do_patch`` <#ref-tasks-patch>`__ task as well. + :ref:`ref-tasks-patch` task as well. FILESYSTEM_PERMS_TABLES Allows you to define your own file permissions settings table as part @@ -2354,7 +2354,7 @@ system and gives an overview of their function and contents. Directory <#build-directory>`__, to point to your custom ``fs-perms.txt``. You can specify more than a single file permissions setting table. The paths you specify to these files must be defined - within the ```BBPATH`` <#var-BBPATH>`__ variable. + within the :term:`BBPATH` variable. For guidance on how to create your own file permissions settings table file, examine the existing ``fs-perms.txt``. @@ -2367,16 +2367,16 @@ system and gives an overview of their function and contents. For e.g. rsa2048. FONT_EXTRA_RDEPENDS - When inheriting the ```fontcache`` <#ref-classes-fontcache>`__ class, + When inheriting the :ref:`fontcache ` class, this variable specifies the runtime dependencies for font packages. By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils". FONT_PACKAGES - When inheriting the ```fontcache`` <#ref-classes-fontcache>`__ class, + When inheriting the :ref:`fontcache ` class, this variable identifies packages containing font files that need to be cached by Fontconfig. By default, the ``fontcache`` class assumes that fonts are in the recipe's main package (i.e. - ``${``\ ```PN`` <#var-PN>`__\ ``}``). Use this variable if fonts you + ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you need are in a package other than that main package. FORCE_RO_REMOVE @@ -2429,7 +2429,7 @@ system and gives an overview of their function and contents. "en_GB.UTF-8 en_US.UTF-8" GROUPADD_PARAM - When inheriting the ```useradd`` <#ref-classes-useradd>`__ class, + When inheriting the :ref:`useradd ` class, this variable specifies for a package what parameters should be passed to the ``groupadd`` command if you wish to add a group to the system when the package is installed. @@ -2439,7 +2439,7 @@ system and gives an overview of their function and contents. ``groupadd``, see ` `__. GROUPMEMS_PARAM - When inheriting the ```useradd`` <#ref-classes-useradd>`__ class, + When inheriting the :ref:`useradd ` class, this variable specifies for a package what parameters should be passed to the ``groupmems`` command if you wish to modify the members of a group when the package is installed. @@ -2453,7 +2453,7 @@ system and gives an overview of their function and contents. ``local.conf`` or distribution configuration file to enable graphics and serial in the menu. - See the ```grub-efi`` <#ref-classes-grub-efi>`__ class for more + See the :ref:`grub-efi ` class for more information on how this variable is used. GRUB_OPTS @@ -2462,7 +2462,7 @@ system and gives an overview of their function and contents. multiple options. The ``GRUB_OPTS`` variable is optional. See the - ```grub-efi`` <#ref-classes-grub-efi>`__ class for more information + :ref:`grub-efi ` class for more information on how this variable is used. GRUB_TIMEOUT @@ -2470,12 +2470,12 @@ system and gives an overview of their function and contents. GNU GRand Unified Bootloader (GRUB). The ``GRUB_TIMEOUT`` variable is optional. See the - ```grub-efi`` <#ref-classes-grub-efi>`__ class for more information + :ref:`grub-efi ` class for more information on how this variable is used. GTKIMMODULES_PACKAGES When inheriting the - ```gtk-immodules-cache`` <#ref-classes-gtk-immodules-cache>`__ class, + :ref:`gtk-immodules-cache ` class, this variable specifies the packages that contain the GTK+ input method modules being installed when the modules are in packages other than the main package. @@ -2486,7 +2486,7 @@ system and gives an overview of their function and contents. HOST_ARCH The name of the target architecture, which is normally the same as - ```TARGET_ARCH`` <#var-TARGET_ARCH>`__. The OpenEmbedded build system + :term:`TARGET_ARCH`. The OpenEmbedded build system supports many architectures. Here is an example list of architectures supported. This list is by no means complete as the architecture is configurable: arm i586 x86_64 powerpc powerpc64 mips mipsel @@ -2498,7 +2498,7 @@ system and gives an overview of their function and contents. Default initialization for ``HOST_CC_ARCH`` varies depending on what is being built: - - ```TARGET_CC_ARCH`` <#var-TARGET_CC_ARCH>`__ when building for the + - :term:`TARGET_CC_ARCH` when building for the target - ``BUILD_CC_ARCH`` when building for the build host (i.e. @@ -2509,14 +2509,14 @@ system and gives an overview of their function and contents. HOST_OS Specifies the name of the target operating system, which is normally - the same as the ```TARGET_OS`` <#var-TARGET_OS>`__. The variable can + the same as the :term:`TARGET_OS`. The variable can be set to "linux" for ``glibc``-based systems and to "linux-musl" for ``musl``. For ARM/EABI targets, there are also "linux-gnueabi" and "linux-musleabi" values possible. HOST_PREFIX Specifies the prefix for the cross-compile toolchain. ``HOST_PREFIX`` - is normally the same as ```TARGET_PREFIX`` <#var-TARGET_PREFIX>`__. + is normally the same as :term:`TARGET_PREFIX`. HOST_SYS Specifies the system, including the architecture and the operating @@ -2524,9 +2524,9 @@ system and gives an overview of their function and contents. current recipe. The OpenEmbedded build system automatically sets this variable based - on ```HOST_ARCH`` <#var-HOST_ARCH>`__, - ```HOST_VENDOR`` <#var-HOST_VENDOR>`__, and - ```HOST_OS`` <#var-HOST_OS>`__ variables. + on :term:`HOST_ARCH`, + :term:`HOST_VENDOR`, and + :term:`HOST_OS` variables. .. note:: @@ -2549,25 +2549,25 @@ system and gives an overview of their function and contents. is not started. For additional information, see - ```HOSTTOOLS_NONFATAL`` <#var-HOSTTOOLS_NONFATAL>`__. + :term:`HOSTTOOLS_NONFATAL`. HOSTTOOLS_NONFATAL A space-separated list (filter) of tools on the build host that should be allowed to be called from within build tasks. Using this filter helps reduce the possibility of host contamination. Unlike - ```HOSTTOOLS`` <#var-HOSTTOOLS>`__, the OpenEmbedded build system + :term:`HOSTTOOLS`, the OpenEmbedded build system does not produce an error if a tool specified in the value of ``HOSTTOOLS_NONFATAL`` is not found on the build host. Thus, you can use ``HOSTTOOLS_NONFATAL`` to filter optional host tools. HOST_VENDOR Specifies the name of the vendor. ``HOST_VENDOR`` is normally the - same as ```TARGET_VENDOR`` <#var-TARGET_VENDOR>`__. + same as :term:`TARGET_VENDOR`. ICECC_DISABLED Disables or enables the ``icecc`` (Icecream) function. For more information on this function and best practices for using this - variable, see the "```icecc.bbclass`` <#ref-classes-icecc>`__" + variable, see the ":ref:`icecc.bbclass `" section. Setting this variable to "1" in your ``local.conf`` disables the @@ -2576,7 +2576,7 @@ system and gives an overview of their function and contents. ICECC_ENV_EXEC Points to the ``icecc-create-env`` script that you provide. This - variable is used by the ```icecc`` <#ref-classes-icecc>`__ class. You + variable is used by the :ref:`icecc ` class. You set this variable in your ``local.conf`` file. If you do not point to a script that you provide, the OpenEmbedded @@ -2586,7 +2586,7 @@ system and gives an overview of their function and contents. ICECC_PARALLEL_MAKE Extra options passed to the ``make`` command during the - ```do_compile`` <#ref-tasks-compile>`__ task that specify parallel + :ref:`ref-tasks-compile` task that specify parallel compilation. This variable usually takes the form of "-j x", where x represents the maximum number of parallel threads ``make`` can run. @@ -2602,7 +2602,7 @@ system and gives an overview of their function and contents. performance could take some experimentation since machine speed, network lag, available memory, and existing machine loads can all affect build time. Consequently, unlike the - ```PARALLEL_MAKE`` <#var-PARALLEL_MAKE>`__ variable, there is no + :term:`PARALLEL_MAKE` variable, there is no rule-of-thumb for setting ``ICECC_PARALLEL_MAKE`` to achieve optimal performance. @@ -2613,13 +2613,13 @@ system and gives an overview of their function and contents. ICECC_PATH The location of the ``icecc`` binary. You can set this variable in your ``local.conf`` file. If your ``local.conf`` file does not define - this variable, the ```icecc`` <#ref-classes-icecc>`__ class attempts + this variable, the :ref:`icecc ` class attempts to define it by locating ``icecc`` using ``which``. ICECC_USER_CLASS_BL Identifies user classes that you do not want the Icecream distributed compile support to consider. This variable is used by the - ```icecc`` <#ref-classes-icecc>`__ class. You set this variable in + :ref:`icecc ` class. You set this variable in your ``local.conf`` file. When you list classes using this variable, you are "blacklisting" @@ -2629,7 +2629,7 @@ system and gives an overview of their function and contents. ICECC_USER_PACKAGE_BL Identifies user recipes that you do not want the Icecream distributed compile support to consider. This variable is used by the - ```icecc`` <#ref-classes-icecc>`__ class. You set this variable in + :ref:`icecc ` class. You set this variable in your ``local.conf`` file. When you list packages using this variable, you are "blacklisting" @@ -2638,15 +2638,15 @@ system and gives an overview of their function and contents. ICECC_USER_PACKAGE_WL Identifies user recipes that use an empty - ```PARALLEL_MAKE`` <#var-PARALLEL_MAKE>`__ variable that you want to + :term:`PARALLEL_MAKE` variable that you want to force remote distributed compilation on using the Icecream distributed compile support. This variable is used by the - ```icecc`` <#ref-classes-icecc>`__ class. You set this variable in + :ref:`icecc ` class. You set this variable in your ``local.conf`` file. IMAGE_BASENAME The base name of image output files. This variable defaults to the - recipe name (``${``\ ```PN`` <#var-PN>`__\ ``}``). + recipe name (``${``\ :term:`PN`\ ``}``). IMAGE_BOOT_FILES A space-separated list of files installed into the boot partition @@ -2656,7 +2656,7 @@ system and gives an overview of their function and contents. installed under the same name as the source files. To change the installed name, separate it from the original name with a semi-colon (;). Source files need to be located in - ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__. Here are two + :term:`DEPLOY_DIR_IMAGE`. Here are two examples: IMAGE_BOOT_FILES = "u-boot.img uImage;kernel" IMAGE_BOOT_FILES = "u-boot.${UBOOT_SUFFIX} ${KERNEL_IMAGETYPE}" @@ -2687,12 +2687,12 @@ system and gives an overview of their function and contents. configuration file. For more information, see ``meta/classes/image_types.bbclass`` in the - `Source Directory <#source-directory>`__. + :term:`Source Directory`. IMAGE_CMD Specifies the command to create the image file for a specific image type, which corresponds to the value set set in - ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__, (e.g. ``ext3``, + :term:`IMAGE_FSTYPES`, (e.g. ``ext3``, ``btrfs``, and so forth). When setting this variable, you should use an override for the associated type. Here is an example: IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \\ --faketime @@ -2701,7 +2701,7 @@ system and gives an overview of their function and contents. You typically do not need to set this variable unless you are adding support for a new image type. For more examples on how to set this - variable, see the ```image_types`` <#ref-classes-image_types>`__ + variable, see the :ref:`image_types ` class file, which is ``meta/classes/image_types.bbclass``. IMAGE_DEVICE_TABLES @@ -2710,7 +2710,7 @@ system and gives an overview of their function and contents. These files list basic device nodes that should be created under ``/dev`` within the image. If ``IMAGE_DEVICE_TABLES`` is not set, ``files/device_table-minimal.txt`` is used, which is located by - ```BBPATH`` <#var-BBPATH>`__. For details on how you should write + :term:`BBPATH`. For details on how you should write device table files, see ``meta/files/device_table-minimal.txt`` as an example. @@ -2744,7 +2744,7 @@ system and gives an overview of their function and contents. IMAGE_FSTYPES = "ext3 tar.bz2" For the complete list of supported image formats from which you can - choose, see ```IMAGE_TYPES`` <#var-IMAGE_TYPES>`__. + choose, see :term:`IMAGE_TYPES`. .. note:: @@ -2759,13 +2759,13 @@ system and gives an overview of their function and contents. IMAGE_INSTALL Used by recipes to specify the packages to install into an image - through the ```image`` <#ref-classes-image>`__ class. Use the + through the :ref:`image ` class. Use the ``IMAGE_INSTALL`` variable with care to avoid ordering issues. Image recipes set ``IMAGE_INSTALL`` to specify the packages to install into an image through ``image.bbclass``. Additionally, "helper" classes such as the - ```core-image`` <#ref-classes-core-image>`__ class exist that can + :ref:`core-image ` class exist that can take lists used with ``IMAGE_FEATURES`` and turn them into auto-generated entries in ``IMAGE_INSTALL`` in addition to its default contents. @@ -2781,7 +2781,7 @@ system and gives an overview of their function and contents. ```core-image-minimal-initramfs`` <#images-core-image-minimal-initramfs>`__ image, do not use the ``IMAGE_INSTALL`` variable to specify packages for installation. Instead, use the - ```PACKAGE_INSTALL`` <#var-PACKAGE_INSTALL>`__ variable, which + :term:`PACKAGE_INSTALL` variable, which allows the initial RAM filesystem (initramfs) recipe to use a fixed set of packages and not be affected by ``IMAGE_INSTALL``. For information on creating an initramfs, see the "`Building an @@ -2820,7 +2820,7 @@ system and gives an overview of their function and contents. only provide locale files by language and not by country-specific language). - See the ```GLIBC_GENERATE_LOCALES`` <#var-GLIBC_GENERATE_LOCALES>`__ + See the :term:`GLIBC_GENERATE_LOCALES` variable for information on generating GLIBC locales. IMAGE_MANIFEST @@ -2829,19 +2829,19 @@ system and gives an overview of their function and contents. information on a line-per-package basis as follows: packagename packagearch version - The ```image`` <#ref-classes-image>`__ class defines the manifest + The :ref:`image ` class defines the manifest file as follows: IMAGE_MANIFEST = "${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest" The location is - derived using the ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__ - and ```IMAGE_NAME`` <#var-IMAGE_NAME>`__ variables. You can find + derived using the :term:`DEPLOY_DIR_IMAGE` + and :term:`IMAGE_NAME` variables. You can find information on how the image is created in the "`Image Generation <&YOCTO_DOCS_OM_URL;#image-generation-dev-environment>`__" section in the Yocto Project Overview and Concepts Manual. IMAGE_NAME The name of the output image files minus the extension. This variable - is derived using the ```IMAGE_BASENAME`` <#var-IMAGE_BASENAME>`__, - ```MACHINE`` <#var-MACHINE>`__, and ```DATETIME`` <#var-DATETIME>`__ + is derived using the :term:`IMAGE_BASENAME`, + :term:`MACHINE`, and :term:`DATETIME` variables: IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}" IMAGE_OVERHEAD_FACTOR @@ -2874,10 +2874,10 @@ system and gives an overview of their function and contents. IMAGE_PKGTYPE Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the OpenEmbedded build system. The variable is defined appropriately by - the ```package_deb`` <#ref-classes-package_deb>`__, - ```package_rpm`` <#ref-classes-package_rpm>`__, - ```package_ipk`` <#ref-classes-package_ipk>`__, or - ```package_tar`` <#ref-classes-package_tar>`__ class. + the :ref:`package_deb `, + :ref:`package_rpm `, + :ref:`package_ipk `, or + :ref:`package_tar ` class. .. note:: @@ -2887,13 +2887,13 @@ system and gives an overview of their function and contents. do not use it. The ```populate_sdk_*`` <#ref-classes-populate-sdk-*>`__ and - ```image`` <#ref-classes-image>`__ classes use the ``IMAGE_PKGTYPE`` + :ref:`image ` classes use the ``IMAGE_PKGTYPE`` for packaging up images and SDKs. You should not set the ``IMAGE_PKGTYPE`` manually. Rather, the variable is set indirectly through the appropriate ```package_*`` <#ref-classes-package>`__ class using the - ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ variable. The + :term:`PACKAGE_CLASSES` variable. The OpenEmbedded build system uses the first package type (e.g. DEB, RPM, or IPK) that appears with the variable @@ -2913,7 +2913,7 @@ system and gives an overview of their function and contents. If you need to pass the root filesystem path to a command within the function, you can use ``${IMAGE_ROOTFS}``, which points to the directory that becomes the root filesystem image. See the - ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more + :term:`IMAGE_ROOTFS` variable for more information. IMAGE_PREPROCESS_COMMAND @@ -2925,19 +2925,19 @@ system and gives an overview of their function and contents. If you need to pass the root filesystem path to a command within the function, you can use ``${IMAGE_ROOTFS}``, which points to the directory that becomes the root filesystem image. See the - ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more + :term:`IMAGE_ROOTFS` variable for more information. IMAGE_ROOTFS The location of the root filesystem while it is under construction - (i.e. during the ```do_rootfs`` <#ref-tasks-rootfs>`__ task). This + (i.e. during the :ref:`ref-tasks-rootfs` task). This variable is not configurable. Do not change it. IMAGE_ROOTFS_ALIGNMENT Specifies the alignment for the output image file in Kbytes. If the size of the image is not a multiple of this value, then the size is rounded up to the nearest multiple of the value. The default value is - "1". See ```IMAGE_ROOTFS_SIZE`` <#var-IMAGE_ROOTFS_SIZE>`__ for + "1". See :term:`IMAGE_ROOTFS_SIZE` for additional information. IMAGE_ROOTFS_EXTRA_SPACE @@ -2971,17 +2971,17 @@ system and gives an overview of their function and contents. internal-rootfs-size = Initial root filesystem size before any modifications. xspace = IMAGE_ROOTFS_EXTRA_SPACE - See the ```IMAGE_OVERHEAD_FACTOR`` <#var-IMAGE_OVERHEAD_FACTOR>`__ - and ```IMAGE_ROOTFS_EXTRA_SPACE`` <#var-IMAGE_ROOTFS_EXTRA_SPACE>`__ + See the :term:`IMAGE_OVERHEAD_FACTOR` + and :term:`IMAGE_ROOTFS_EXTRA_SPACE` variables for related information. IMAGE_TYPEDEP Specifies a dependency from one image type on another. Here is an - example from the ```image-live`` <#ref-classes-image-live>`__ class: + example from the :ref:`image-live ` class: IMAGE_TYPEDEP_live = "ext3" In the previous example, the variable ensures that when "live" is - listed with the ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable, + listed with the :term:`IMAGE_FSTYPES` variable, the OpenEmbedded build system produces an ``ext3`` image first since one of the components of the live image is an ``ext3`` formatted partition containing the root filesystem. @@ -3005,7 +3005,7 @@ system and gives an overview of their function and contents. Suppose, for example, you have a set of recipes that are used across several projects. And, within each of those recipes the revision (its - ```PR`` <#var-PR>`__ value) is set accordingly. In this case, when + :term:`PR` value) is set accordingly. In this case, when the revision of those recipes changes, the burden is on you to find all those recipes and be sure that they get changed to reflect the updated version of the recipe. In this scenario, it can get @@ -3034,7 +3034,7 @@ system and gives an overview of their function and contents. INCOMPATIBLE_LICENSE Specifies a space-separated list of license names (as they would - appear in ```LICENSE`` <#var-LICENSE>`__) that should be excluded + appear in :term:`LICENSE`) that should be excluded from the build. Recipes that provide no alternatives to listed incompatible licenses are not built. Packages that are individually licensed with the specified incompatible licenses will be deleted. @@ -3095,7 +3095,7 @@ system and gives an overview of their function and contents. INHIBIT_DEFAULT_DEPS Prevents the default dependencies, namely the C compiler and standard - C library (libc), from being added to ```DEPENDS`` <#var-DEPENDS>`__. + C library (libc), from being added to :term:`DEPENDS`. This variable is usually used within recipes that do not require any compilation using the C compiler. @@ -3106,9 +3106,9 @@ system and gives an overview of their function and contents. Prevents the OpenEmbedded build system from splitting out debug information during packaging. By default, the build system splits out debugging information during the - ```do_package`` <#ref-tasks-package>`__ task. For more information on + :ref:`ref-tasks-package` task. For more information on how debug information is split out, see the - ```PACKAGE_DEBUG_SPLIT_STYLE`` <#var-PACKAGE_DEBUG_SPLIT_STYLE>`__ + :term:`PACKAGE_DEBUG_SPLIT_STYLE` variable. To prevent the build system from splitting out debug information @@ -3121,7 +3121,7 @@ system and gives an overview of their function and contents. files. By default, the OpenEmbedded build system strips binaries and puts - the debugging symbols into ``${``\ ```PN`` <#var-PN>`__\ ``}-dbg``. + the debugging symbols into ``${``\ :term:`PN`\ ``}-dbg``. Consequently, you should not set ``INHIBIT_PACKAGE_STRIP`` when you plan to debug in general. @@ -3135,7 +3135,7 @@ system and gives an overview of their function and contents. this stripping. If you want to use this variable, include the - ```staging`` <#ref-classes-staging>`__ class. This class uses a + :ref:`staging ` class. This class uses a ``sys_strip()`` function to test for the variable and acts accordingly. @@ -3153,7 +3153,7 @@ system and gives an overview of their function and contents. Defines the format for the output image of an initial RAM filesystem (initramfs), which is used during boot. Supported formats are the same as those supported by the - ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable. + :term:`IMAGE_FSTYPES` variable. The default value of this variable, which is set in the ``meta/conf/bitbake.conf`` configuration file in the `Source @@ -3163,14 +3163,14 @@ system and gives an overview of their function and contents. an optionally compressed cpio archive. INITRAMFS_IMAGE - Specifies the ```PROVIDES`` <#var-PROVIDES>`__ name of an image + Specifies the :term:`PROVIDES` name of an image recipe that is used to build an initial RAM filesystem (initramfs) image. In other words, the ``INITRAMFS_IMAGE`` variable causes an additional recipe to be built as a dependency to whatever root filesystem recipe you might be using (e.g. ``core-image-sato``). The initramfs image recipe you provide should set - ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ to - ```INITRAMFS_FSTYPES`` <#var-INITRAMFS_FSTYPES>`__. + :term:`IMAGE_FSTYPES` to + :term:`INITRAMFS_FSTYPES`. An initramfs image provides a temporary root filesystem used for early system initialization (e.g. loading of modules needed to locate @@ -3189,15 +3189,15 @@ system and gives an overview of their function and contents. You can also find more information by referencing the ``meta-poky/conf/local.conf.sample.extended`` configuration file in - the Source Directory, the ```image`` <#ref-classes-image>`__ class, - and the ```kernel`` <#ref-classes-kernel>`__ class to see how to use + the Source Directory, the :ref:`image ` class, + and the :ref:`kernel ` class to see how to use the ``INITRAMFS_IMAGE`` variable. If ``INITRAMFS_IMAGE`` is empty, which is the default, then no initramfs image is built. For more information, you can also see the - ```INITRAMFS_IMAGE_BUNDLE`` <#var-INITRAMFS_IMAGE_BUNDLE>`__ + :term:`INITRAMFS_IMAGE_BUNDLE` variable, which allows the generated image to be bundled inside the kernel image. Additionally, for information on creating an initramfs image, see the "`Building an Initial RAM Filesystem (initramfs) @@ -3206,13 +3206,13 @@ system and gives an overview of their function and contents. INITRAMFS_IMAGE_BUNDLE Controls whether or not the image recipe specified by - ```INITRAMFS_IMAGE`` <#var-INITRAMFS_IMAGE>`__ is run through an + :term:`INITRAMFS_IMAGE` is run through an extra pass - (```do_bundle_initramfs`` <#ref-tasks-bundle_initramfs>`__) during + (:ref:`ref-tasks-bundle_initramfs`) during kernel compilation in order to build a single binary that contains both the kernel image and the initial RAM filesystem (initramfs) image. This makes use of the - ```CONFIG_INITRAMFS_SOURCE`` <#var-CONFIG_INITRAMFS_SOURCE>`__ kernel + :term:`CONFIG_INITRAMFS_SOURCE` kernel feature. .. note:: @@ -3225,13 +3225,13 @@ system and gives an overview of their function and contents. since the initramfs is bundled inside the kernel image. The combined binary is deposited into the ``tmp/deploy`` directory, - which is part of the `Build Directory <#build-directory>`__. + which is part of the :term:`Build Directory`. Setting the variable to "1" in a configuration file causes the OpenEmbedded build system to generate a kernel image with the initramfs specified in ``INITRAMFS_IMAGE`` bundled within: INITRAMFS_IMAGE_BUNDLE = "1" By default, the - ```kernel`` <#ref-classes-kernel>`__ class sets this variable to a + :ref:`kernel ` class sets this variable to a null string as follows: INITRAMFS_IMAGE_BUNDLE ?= "" .. note:: @@ -3257,14 +3257,14 @@ system and gives an overview of their function and contents. file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - See the ```MACHINE`` <#var-MACHINE>`__ variable for additional + See the :term:`MACHINE` variable for additional information. INITRAMFS_NAME The base name of the initial RAM filesystem image. This variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" The - value of the ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__ + value of the :term:`KERNEL_ARTIFACT_NAME` variable, which is set in the same file, has the following value: KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" @@ -3274,16 +3274,16 @@ system and gives an overview of their function and contents. initial RAM disk (``initrd``). The ``INITRD`` variable is an optional variable used with the - ```image-live`` <#ref-classes-image-live>`__ class. + :ref:`image-live ` class. INITRD_IMAGE When building a "live" bootable image (i.e. when - ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ contains "live"), + :term:`IMAGE_FSTYPES` contains "live"), ``INITRD_IMAGE`` specifies the image recipe that should be built to provide the initial RAM disk image. The default value is "core-image-minimal-initramfs". - See the ```image-live`` <#ref-classes-image-live>`__ class for more + See the :ref:`image-live ` class for more information. INITSCRIPT_NAME @@ -3299,7 +3299,7 @@ system and gives an overview of their function and contents. ``INITSCRIPT_*`` as an override. This variable is used in recipes when using ``update-rc.d.bbclass``. - The variable is optional and defaults to the ```PN`` <#var-PN>`__ + The variable is optional and defaults to the :term:`PN` variable. INITSCRIPT_PARAMS @@ -3310,7 +3310,7 @@ system and gives an overview of their function and contents. in initlevels 2 and 5, and stops the script in levels 0, 1 and 6. The variable's default value is "defaults", which is set in the - ```update-rc.d`` <#ref-classes-update-rc.d>`__ class. + :ref:`update-rc.d ` class. The value in ``INITSCRIPT_PARAMS`` is passed through to the ``update-rc.d`` command. For more information on valid parameters, @@ -3324,7 +3324,7 @@ system and gives an overview of their function and contents. recipe. The package name override must be used, which in this example is ``${PN}``: INSANE_SKIP_${PN} += "dev-so" - See the "```insane.bbclass`` <#ref-classes-insane>`__" section for a + See the ":ref:`insane.bbclass `" section for a list of the valid QA checks you can specify using this variable. INSTALL_TIMEZONE_FILE @@ -3376,7 +3376,7 @@ system and gives an overview of their function and contents. BSP. KBUILD_DEFCONFIG - When used with the ```kernel-yocto`` <#ref-classes-kernel-yocto>`__ + When used with the :ref:`kernel-yocto ` class, specifies an "in-tree" kernel configuration file for use during a kernel build. @@ -3386,7 +3386,7 @@ system and gives an overview of their function and contents. "out-of-tree"). However, if you want to use a ``defconfig`` file that is part of the kernel tree (i.e. "in-tree"), you can use the ``KBUILD_DEFCONFIG`` variable and append the - ```KMACHINE`` <#var-KMACHINE>`__ variable to point to the + :term:`KMACHINE` variable to point to the ``defconfig`` file. To use the variable, set it in the append file for your kernel recipe @@ -3404,7 +3404,7 @@ system and gives an overview of their function and contents. KERNEL_ALT_IMAGETYPE Specifies an alternate kernel image type for creation in addition to the kernel image type specified using the - ```KERNEL_IMAGETYPE`` <#var-KERNEL_IMAGETYPE>`__ variable. + :term:`KERNEL_IMAGETYPE` variable. KERNEL_ARTIFACT_NAME Specifies the name of all of the build artifacts. You can change the @@ -3416,8 +3416,8 @@ system and gives an overview of their function and contents. following default value: KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - See the ```PKGE`` <#var-PKGE>`__, ```PKGV`` <#var-PKGV>`__, - ```PKGR`` <#var-PKGR>`__, and ```MACHINE`` <#var-MACHINE>`__ + See the :term:`PKGE`, :term:`PKGV`, + :term:`PKGR`, and :term:`MACHINE` variables for additional information. .. note:: @@ -3430,7 +3430,7 @@ system and gives an overview of their function and contents. KERNEL_CLASSES A list of classes defining kernel image types that the - ```kernel`` <#ref-classes-kernel>`__ class should inherit. You + :ref:`kernel ` class should inherit. You typically append this variable to enable extended image types. An example is the "kernel-fitimage", which enables fitImage support and resides in ``meta/classes/kernel-fitimage.bbclass``. You can register @@ -3449,7 +3449,7 @@ system and gives an overview of their function and contents. file is preferred. In order to use this variable, the - ```kernel-devicetree`` <#ref-classes-kernel-devicetree>`__ class must + :ref:`kernel-devicetree ` class must be inherited. KERNEL_DTB_LINK_NAME @@ -3460,14 +3460,14 @@ system and gives an overview of their function and contents. the same file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - See the ```MACHINE`` <#var-MACHINE>`__ variable for additional + See the :term:`MACHINE` variable for additional information. KERNEL_DTB_NAME The base name of the kernel device tree binary (DTB). This variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" The value of - the ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__ + the :term:`KERNEL_ARTIFACT_NAME` variable, which is set in the same file, has the following value: KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" @@ -3479,8 +3479,8 @@ system and gives an overview of their function and contents. KERNEL_FEATURES Includes additional kernel metadata. In the OpenEmbedded build system, the default Board Support Packages (BSPs) - `Metadata <#metadata>`__ is provided through the - ```KMACHINE`` <#var-KMACHINE>`__ and ```KBRANCH`` <#var-KBRANCH>`__ + :term:`Metadata` is provided through the + :term:`KMACHINE` and :term:`KBRANCH` variables. You can use the ``KERNEL_FEATURES`` variable from within the kernel recipe or kernel append file to further add metadata for all BSPs or specific BSPs. @@ -3511,14 +3511,14 @@ system and gives an overview of their function and contents. file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - See the ```MACHINE`` <#var-MACHINE>`__ variable for additional + See the :term:`MACHINE` variable for additional information. KERNEL_FIT_NAME The base name of the kernel flattened image tree (FIT) image. This variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" The - value of the ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__ + value of the :term:`KERNEL_ARTIFACT_NAME` variable, which is set in the same file, has the following value: KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" @@ -3531,14 +3531,14 @@ system and gives an overview of their function and contents. file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - See the ```MACHINE`` <#var-MACHINE>`__ variable for additional + See the :term:`MACHINE` variable for additional information. KERNEL_IMAGE_MAXSIZE Specifies the maximum size of the kernel image file in kilobytes. If ``KERNEL_IMAGE_MAXSIZE`` is set, the size of the kernel image file is checked against the set value during the - ```do_sizecheck`` <#ref-tasks-sizecheck>`__ task. The task fails if + :ref:`ref-tasks-sizecheck` task. The task fails if the kernel image file is larger than the setting. ``KERNEL_IMAGE_MAXSIZE`` is useful for target devices that have a @@ -3551,7 +3551,7 @@ system and gives an overview of their function and contents. The base name of the kernel image. This variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}" The value of the - ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__ variable, + :term:`KERNEL_ARTIFACT_NAME` variable, which is set in the same file, has the following value: KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" @@ -3563,7 +3563,7 @@ system and gives an overview of their function and contents. build. If you want to build an alternate kernel image type, use the - ```KERNEL_ALT_IMAGETYPE`` <#var-KERNEL_ALT_IMAGETYPE>`__ variable. + :term:`KERNEL_ALT_IMAGETYPE` variable. KERNEL_MODULE_AUTOLOAD Lists kernel modules that need to be auto-loaded during boot. @@ -3591,7 +3591,7 @@ system and gives an overview of their function and contents. For information on how to populate the ``modname.conf`` file with ``modprobe.d`` syntax lines, see the - ```KERNEL_MODULE_PROBECONF`` <#var-KERNEL_MODULE_PROBECONF>`__ + :term:`KERNEL_MODULE_PROBECONF` variable. KERNEL_MODULE_PROBECONF @@ -3603,29 +3603,29 @@ system and gives an overview of their function and contents. KERNEL_PATH The location of the kernel sources. This variable is set to the value - of the ```STAGING_KERNEL_DIR`` <#var-STAGING_KERNEL_DIR>`__ within - the ```module`` <#ref-classes-module>`__ class. For information on + of the :term:`STAGING_KERNEL_DIR` within + the :ref:`module ` class. For information on how this variable is used, see the "`Incorporating Out-of-Tree Modules <&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules>`__" section in the Yocto Project Linux Kernel Development Manual. To help maximize compatibility with out-of-tree drivers used to build modules, the OpenEmbedded build system also recognizes and uses the - ```KERNEL_SRC`` <#var-KERNEL_SRC>`__ variable, which is identical to + :term:`KERNEL_SRC` variable, which is identical to the ``KERNEL_PATH`` variable. Both variables are common variables used by external Makefiles to point to the kernel source directory. KERNEL_SRC The location of the kernel sources. This variable is set to the value - of the ```STAGING_KERNEL_DIR`` <#var-STAGING_KERNEL_DIR>`__ within - the ```module`` <#ref-classes-module>`__ class. For information on + of the :term:`STAGING_KERNEL_DIR` within + the :ref:`module ` class. For information on how this variable is used, see the "`Incorporating Out-of-Tree Modules <&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules>`__" section in the Yocto Project Linux Kernel Development Manual. To help maximize compatibility with out-of-tree drivers used to build modules, the OpenEmbedded build system also recognizes and uses the - ```KERNEL_PATH`` <#var-KERNEL_PATH>`__ variable, which is identical + :term:`KERNEL_PATH` variable, which is identical to the ``KERNEL_SRC`` variable. Both variables are common variables used by external Makefiles to point to the kernel source directory. @@ -3638,7 +3638,7 @@ system and gives an overview of their function and contents. KERNELDEPMODDEPEND Specifies whether the data referenced through - ```PKGDATA_DIR`` <#var-PKGDATA_DIR>`__ is needed or not. The + :term:`PKGDATA_DIR` is needed or not. The ``KERNELDEPMODDEPEND`` does not control whether or not that data exists, but simply whether or not it is used. If you do not need to use the data, set the ``KERNELDEPMODDEPEND`` variable in your @@ -3690,13 +3690,13 @@ system and gives an overview of their function and contents. You define the ``KTYPE`` variable in the `BSP Descriptions <&YOCTO_DOCS_KERNEL_DEV_URL;#bsp-descriptions>`__. The value you use must match the value used for the - ```LINUX_KERNEL_TYPE`` <#var-LINUX_KERNEL_TYPE>`__ value used by the + :term:`LINUX_KERNEL_TYPE` value used by the kernel recipe. LABELS Provides a list of targets for automatic configuration. - See the ```grub-efi`` <#ref-classes-grub-efi>`__ class for more + See the :ref:`grub-efi ` class for more information on how this variable is used. LAYERDEPENDS @@ -3705,7 +3705,7 @@ system and gives an overview of their function and contents. by adding it to the end of the layer name. Here is an example: LAYERDEPENDS_mylayer = "anotherlayer (=3)" In this previous example, version 3 of "anotherlayer" is compared against - ```LAYERVERSION`` <#var-LAYERVERSION>`__\ ``_anotherlayer``. + :term:`LAYERVERSION`\ ``_anotherlayer``. An error is produced if any dependency is missing or the version numbers (if specified) do not match exactly. This variable is used in @@ -3733,7 +3733,7 @@ system and gives an overview of their function and contents. ``LAYERRECOMMENDS_mylayer``). LAYERSERIES_COMPAT - Lists the versions of the `OpenEmbedded-Core <#oe-core>`__ for which + Lists the versions of the :term:`OpenEmbedded-Core (OE-Core)` for which a layer is compatible. Using the ``LAYERSERIES_COMPAT`` variable allows the layer maintainer to indicate which combinations of the layer and OE-Core can be expected to work. The variable gives the @@ -3762,7 +3762,7 @@ system and gives an overview of their function and contents. LAYERVERSION Optionally specifies the version of a layer as a single number. You - can use this within ```LAYERDEPENDS`` <#var-LAYERDEPENDS>`__ for + can use this within :term:`LAYERDEPENDS` for another layer in order to depend on a specific version of the layer. This variable is used in the ``conf/layer.conf`` file and must be suffixed with the name of the specific layer (e.g. @@ -3779,18 +3779,18 @@ system and gives an overview of their function and contents. Default initialization for ``LDFLAGS`` varies depending on what is being built: - - ```TARGET_LDFLAGS`` <#var-TARGET_LDFLAGS>`__ when building for the + - :term:`TARGET_LDFLAGS` when building for the target - - ```BUILD_LDFLAGS`` <#var-BUILD_LDFLAGS>`__ when building for the + - :term:`BUILD_LDFLAGS` when building for the build host (i.e. ``-native``) - - ```BUILDSDK_LDFLAGS`` <#var-BUILDSDK_LDFLAGS>`__ when building for + - :term:`BUILDSDK_LDFLAGS` when building for an SDK (i.e. ``nativesdk-``) LEAD_SONAME Specifies the lead (or primary) compiled library file (i.e. ``.so``) - that the ```debian`` <#ref-classes-debian>`__ class applies its + that the :ref:`debian ` class applies its naming policy to given a recipe that packages multiple libraries. This variable works in conjunction with the ``debian`` class. @@ -3804,7 +3804,7 @@ system and gives an overview of their function and contents. license change. This variable must be defined for all recipes (unless - ```LICENSE`` <#var-LICENSE>`__ is set to "CLOSED"). + :term:`LICENSE` is set to "CLOSED"). For more information, see the "`Tracking License Changes <&YOCTO_DOCS_DEV_URL;#usingpoky-configuring-LIC_FILES_CHKSUM>`__" @@ -3825,7 +3825,7 @@ system and gives an overview of their function and contents. - For standard licenses, use the names of the files in ``meta/files/common-licenses/`` or the - ```SPDXLICENSEMAP`` <#var-SPDXLICENSEMAP>`__ flag names defined in + :term:`SPDXLICENSEMAP` flag names defined in ``meta/conf/licenses.conf``. Here are some examples: LICENSE = "LGPLv2.1 \| GPLv3" LICENSE = @@ -3847,34 +3847,34 @@ system and gives an overview of their function and contents. LICENSE_CREATE_PACKAGE Setting ``LICENSE_CREATE_PACKAGE`` to "1" causes the OpenEmbedded build system to create an extra package (i.e. - ``${``\ ```PN`` <#var-PN>`__\ ``}-lic``) for each recipe and to add + ``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add those packages to the - ```RRECOMMENDS`` <#var-RRECOMMENDS>`__\ ``_${PN}``. + :term:`RRECOMMENDS`\ ``_${PN}``. The ``${PN}-lic`` package installs a directory in ``/usr/share/licenses`` named ``${PN}``, which is the recipe's base name, and installs files in that directory that contain license and copyright information (i.e. copies of the appropriate license files from ``meta/common-licenses`` that match the licenses specified in - the ```LICENSE`` <#var-LICENSE>`__ variable of the recipe metadata + the :term:`LICENSE` variable of the recipe metadata and copies of files marked in - ```LIC_FILES_CHKSUM`` <#var-LIC_FILES_CHKSUM>`__ as containing + :term:`LIC_FILES_CHKSUM` as containing license text). For related information on providing license text, see the - ```COPY_LIC_DIRS`` <#var-COPY_LIC_DIRS>`__ variable, the - ```COPY_LIC_MANIFEST`` <#var-COPY_LIC_MANIFEST>`__ variable, and the + :term:`COPY_LIC_DIRS` variable, the + :term:`COPY_LIC_MANIFEST` variable, and the "`Providing License Text <&YOCTO_DOCS_DEV_URL;#providing-license-text>`__" section in the Yocto Project Development Tasks Manual. LICENSE_FLAGS Specifies additional flags for a recipe you must whitelist through - ```LICENSE_FLAGS_WHITELIST`` <#var-LICENSE_FLAGS_WHITELIST>`__ in + :term:`LICENSE_FLAGS_WHITELIST` in order to allow the recipe to be built. When providing multiple flags, separate them with spaces. - This value is independent of ```LICENSE`` <#var-LICENSE>`__ and is + This value is independent of :term:`LICENSE` and is typically used to mark recipes that might require additional licenses in order to be used in a commercial product. For more information, see the "`Enabling Commercially Licensed @@ -3883,7 +3883,7 @@ system and gives an overview of their function and contents. LICENSE_FLAGS_WHITELIST Lists license flags that when specified in - ```LICENSE_FLAGS`` <#var-LICENSE_FLAGS>`__ within a recipe should not + :term:`LICENSE_FLAGS` within a recipe should not prevent that recipe from being built. This practice is otherwise known as "whitelisting" license flags. For more information, see the "`Enabling Commercially Licensed @@ -3907,10 +3907,10 @@ system and gives an overview of their function and contents. kernel types. If you do not specify a ``LINUX_KERNEL_TYPE``, it defaults to - "standard". Together with ```KMACHINE`` <#var-KMACHINE>`__, the + "standard". Together with :term:`KMACHINE`, the ``LINUX_KERNEL_TYPE`` variable defines the search arguments used by the kernel tools to find the appropriate description within the - kernel `Metadata <#metadata>`__ with which to build out the sources + kernel :term:`Metadata` with which to build out the sources and configuration. LINUX_VERSION @@ -3921,7 +3921,7 @@ system and gives an overview of their function and contents. ``meta/recipes-kernel/linux`` defines the variables as follows: LINUX_VERSION ?= "3.4.24" - The ``LINUX_VERSION`` variable is used to define ```PV`` <#var-PV>`__ + The ``LINUX_VERSION`` variable is used to define :term:`PV` for the recipe: PV = "${LINUX_VERSION}+git${SRCPV}" LINUX_VERSION_EXTENSION @@ -3929,7 +3929,7 @@ system and gives an overview of their function and contents. kernel built with the OpenEmbedded build system. You define this variable in the kernel recipe. For example, the linux-yocto kernel recipes all define the variable as follows: LINUX_VERSION_EXTENSION - ?= "-yocto-${`LINUX_KERNEL_TYPE <#var-LINUX_KERNEL_TYPE>`__}" + ?= "-yocto-${:term:`LINUX_KERNEL_TYPE`}" Defining this variable essentially sets the Linux kernel configuration item ``CONFIG_LOCALVERSION``, which is visible through @@ -3941,7 +3941,7 @@ system and gives an overview of their function and contents. overall log files. The default directory is ``${TMPDIR}/log``. For the directory containing logs specific to each task, see the - ```T`` <#var-T>`__ variable. + :term:`T` variable. MACHINE Specifies the target device for which the image is built. You define @@ -3954,7 +3954,7 @@ system and gives an overview of their function and contents. name, through which machine-specific configurations are set. Thus, when ``MACHINE`` is set to "qemux86" there exists the corresponding ``qemux86.conf`` machine configuration file, which can be found in - the `Source Directory <#source-directory>`__ in + the :term:`Source Directory` in ``meta/conf/machine``. The list of machines supported by the Yocto Project as shipped @@ -3974,8 +3974,8 @@ system and gives an overview of their function and contents. MACHINE_ARCH Specifies the name of the machine-specific architecture. This - variable is set automatically from ```MACHINE`` <#var-MACHINE>`__ or - ```TUNE_PKGARCH`` <#var-TUNE_PKGARCH>`__. You should not hand-edit + variable is set automatically from :term:`MACHINE` or + :term:`TUNE_PKGARCH`. You should not hand-edit the ``MACHINE_ARCH`` variable. MACHINE_ESSENTIAL_EXTRA_RDEPENDS @@ -4094,11 +4094,11 @@ system and gives an overview of their function and contents. MACHINE_FEATURES Specifies the list of hardware features the - ```MACHINE`` <#var-MACHINE>`__ is capable of supporting. For related + :term:`MACHINE` is capable of supporting. For related information on enabling features, see the - ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__, - ```COMBINED_FEATURES`` <#var-COMBINED_FEATURES>`__, and - ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ variables. + :term:`DISTRO_FEATURES`, + :term:`COMBINED_FEATURES`, and + :term:`IMAGE_FEATURES` variables. For a list of hardware features supported by the Yocto Project as shipped, see the "`Machine Features <#ref-features-machine>`__" @@ -4124,7 +4124,7 @@ system and gives an overview of their function and contents. MACHINEOVERRIDES A colon-separated list of overrides that apply to the current machine. By default, this list includes the value of - ```MACHINE`` <#var-MACHINE>`__. + :term:`MACHINE`. You can extend ``MACHINEOVERRIDES`` to add extra overrides that should apply to a machine. For example, all machines emulated in QEMU @@ -4136,7 +4136,7 @@ system and gives an overview of their function and contents. recipe: SRC_URI_append_qemuall = "file://wired.config \\ file://wired-setup \\ " The underlying mechanism behind ``MACHINEOVERRIDES`` is simply that it is included in the default - value of ```OVERRIDES`` <#var-OVERRIDES>`__. + value of :term:`OVERRIDES`. MAINTAINER The email address of the distribution maintainer. @@ -4146,18 +4146,18 @@ system and gives an overview of their function and contents. gets source code. When the build system searches for source code, it first tries the local download directory. If that location fails, the build system tries locations defined by - ```PREMIRRORS`` <#var-PREMIRRORS>`__, the upstream source, and then + :term:`PREMIRRORS`, the upstream source, and then locations specified by ``MIRRORS`` in that order. - Assuming your distribution (```DISTRO`` <#var-DISTRO>`__) is "poky", + Assuming your distribution (:term:`DISTRO`) is "poky", the default value for ``MIRRORS`` is defined in the ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. MLPREFIX - Specifies a prefix has been added to ```PN`` <#var-PN>`__ to create a + Specifies a prefix has been added to :term:`PN` to create a special version of a recipe or package (i.e. a Multilib version). The variable is used in places where the prefix needs to be added to or - removed from a the name (e.g. the ```BPN`` <#var-BPN>`__ variable). + removed from a the name (e.g. the :term:`BPN` variable). ``MLPREFIX`` gets set when a prefix has been added to ``PN``. .. note:: @@ -4174,10 +4174,10 @@ system and gives an overview of their function and contents. for it as well. To help understand when ``MLPREFIX`` might be needed, consider when - ```BBCLASSEXTEND`` <#var-BBCLASSEXTEND>`__ is used to provide a + :term:`BBCLASSEXTEND` is used to provide a ``nativesdk`` version of a recipe in addition to the target version. If that recipe declares build-time dependencies on tasks in other - recipes by using ```DEPENDS`` <#var-DEPENDS>`__, then a dependency on + recipes by using :term:`DEPENDS`, then a dependency on "foo" will automatically get rewritten to a dependency on "nativesdk-foo". However, dependencies like the following will not get rewritten automatically: do_foo[depends] += "recipe:do_foo" If @@ -4191,7 +4191,7 @@ system and gives an overview of their function and contents. module_autoload_rfcomm = "rfcomm" should now be replaced with: KERNEL_MODULE_AUTOLOAD += "rfcomm" See - the ```KERNEL_MODULE_AUTOLOAD`` <#var-KERNEL_MODULE_AUTOLOAD>`__ + the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information. module_conf @@ -4204,7 +4204,7 @@ system and gives an overview of their function and contents. configuration file, a distribution configuration file, an append file for the recipe, or the recipe itself). If you use this variable, you must also be sure to list the module name in the - ```KERNEL_MODULE_AUTOLOAD`` <#var-KERNEL_MODULE_AUTOLOAD>`__ + :term:`KERNEL_MODULE_AUTOLOAD` variable. Here is the general syntax: module_conf_module_name = @@ -4221,7 +4221,7 @@ system and gives an overview of their function and contents. For information on how to specify kernel modules to auto-load on boot, see the - ```KERNEL_MODULE_AUTOLOAD`` <#var-KERNEL_MODULE_AUTOLOAD>`__ + :term:`KERNEL_MODULE_AUTOLOAD` variable. MODULE_TARBALL_DEPLOY @@ -4237,14 +4237,14 @@ system and gives an overview of their function and contents. same file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - See the ```MACHINE`` <#var-MACHINE>`__ variable for additional + See the :term:`MACHINE` variable for additional information. MODULE_TARBALL_NAME The base name of the kernel module tarball. This variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" The value of the - ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__ variable, + :term:`KERNEL_ARTIFACT_NAME` variable, which is set in the same file, has the following value: KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" @@ -4257,11 +4257,11 @@ system and gives an overview of their function and contents. The default value of this variable is: ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS} Some classes (e.g. - ```cross-canadian`` <#ref-classes-cross-canadian>`__) modify the + :ref:`cross-canadian `) modify the ``MULTIMACH_TARGET_SYS`` value. - See the ```STAMP`` <#var-STAMP>`__ variable for an example. See the - ```STAGING_DIR_TARGET`` <#var-STAGING_DIR_TARGET>`__ variable for + See the :term:`STAMP` variable for an example. See the + :term:`STAGING_DIR_TARGET` variable for more information. NATIVELSBSTRING @@ -4276,7 +4276,7 @@ system and gives an overview of their function and contents. packages for different distributions (e.g. to avoid problems with ``glibc`` version incompatibilities). Additionally, the variable is checked against - ```SANITY_TESTED_DISTROS`` <#var-SANITY_TESTED_DISTROS>`__ if that + :term:`SANITY_TESTED_DISTROS` if that variable is set. NM @@ -4300,7 +4300,7 @@ system and gives an overview of their function and contents. NO_RECOMMENDATIONS Prevents installation of all "recommended-only" packages. Recommended-only packages are packages installed only through the - ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ variable). Setting the + :term:`RRECOMMENDS` variable). Setting the ``NO_RECOMMENDATIONS`` variable to "1" turns this feature on: NO_RECOMMENDATIONS = "1" @@ -4310,7 +4310,7 @@ system and gives an overview of their function and contents. It is important to realize that if you choose to not install packages using this variable and some other packages are dependent on them - (i.e. listed in a recipe's ```RDEPENDS`` <#var-RDEPENDS>`__ + (i.e. listed in a recipe's :term:`RDEPENDS` variable), the OpenEmbedded build system ignores your request and will install the packages to avoid dependency errors. @@ -4325,8 +4325,8 @@ system and gives an overview of their function and contents. Support for this variable exists only when using the IPK and RPM packaging backend. Support does not exist for DEB. - See the ```BAD_RECOMMENDATIONS`` <#var-BAD_RECOMMENDATIONS>`__ and - the ```PACKAGE_EXCLUDE`` <#var-PACKAGE_EXCLUDE>`__ variables for + See the :term:`BAD_RECOMMENDATIONS` and + the :term:`PACKAGE_EXCLUDE` variables for related information. NOAUTOPACKAGEDEBUG @@ -4345,7 +4345,7 @@ system and gives an overview of their function and contents. The minimal command and arguments to run ``objdump``. OE_BINCONFIG_EXTRA_MANGLE - When inheriting the ```binconfig`` <#ref-classes-binconfig>`__ class, + When inheriting the :ref:`binconfig ` class, this variable specifies additional arguments passed to the "sed" command. The sed command alters any paths in configuration scripts that have been set up during compilation. Inheriting this class @@ -4357,7 +4357,7 @@ system and gives an overview of their function and contents. Directory <#source-directory>`__ for details on how this class applies these additional sed command arguments. For general information on the ``binconfig`` class, see the - "```binconfig.bbclass`` <#ref-classes-binconfig>`__" section. + ":ref:`binconfig.bbclass `" section. OE_IMPORTS An internal variable used to tell the OpenEmbedded build system what @@ -4424,9 +4424,9 @@ system and gives an overview of their function and contents. overrides mechanism. The default value of ``OVERRIDES`` includes the values of the - ```CLASSOVERRIDE`` <#var-CLASSOVERRIDE>`__, - ```MACHINEOVERRIDES`` <#var-MACHINEOVERRIDES>`__, and - ```DISTROOVERRIDES`` <#var-DISTROOVERRIDES>`__ variables. Another + :term:`CLASSOVERRIDE`, + :term:`MACHINEOVERRIDES`, and + :term:`DISTROOVERRIDES` variables. Another important override included by default is ``pn-${PN}``. This override allows variables to be set for a single recipe within configuration (``.conf``) files. Here is an example: FOO_pn-myrecipe = @@ -4468,8 +4468,8 @@ system and gives an overview of their function and contents. The architecture of the resulting package or packages. By default, the value of this variable is set to - ```TUNE_PKGARCH`` <#var-TUNE_PKGARCH>`__ when building for the - target, ```BUILD_ARCH`` <#var-BUILD_ARCH>`__ when building for the + :term:`TUNE_PKGARCH` when building for the + target, :term:`BUILD_ARCH` when building for the build host, and "${SDK_ARCH}-${SDKPKGSUFFIX}" when building for the SDK. @@ -4482,7 +4482,7 @@ system and gives an overview of their function and contents. However, if your recipe's output packages are built specific to the target machine rather than generally for the architecture of the machine, you should set ``PACKAGE_ARCH`` to the value of - ```MACHINE_ARCH`` <#var-MACHINE_ARCH>`__ in the recipe as follows: + :term:`MACHINE_ARCH` in the recipe as follows: PACKAGE_ARCH = "${MACHINE_ARCH}" PACKAGE_ARCHS @@ -4524,7 +4524,7 @@ system and gives an overview of their function and contents. For information on packaging and build performance effects as a result of the package manager in use, see the - "```package.bbclass`` <#ref-classes-package>`__" section. + ":ref:`package.bbclass `" section. PACKAGE_DEBUG_SPLIT_STYLE Determines how to split up the binary and debug information when @@ -4566,7 +4566,7 @@ system and gives an overview of their function and contents. You might find that you want to prevent installing certain packages when you are installing complementary packages. For example, if you - are using ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ to install + are using :term:`IMAGE_FEATURES` to install ``dev-pkgs``, you might not want to install all packages from a particular multilib. If you find yourself in this situation, you can use the ``PACKAGE_EXCLUDE_COMPLEMENTARY`` variable to specify regular @@ -4583,7 +4583,7 @@ system and gives an overview of their function and contents. If you choose to not install a package using this variable and some other package is dependent on it (i.e. listed in a recipe's - ```RDEPENDS`` <#var-RDEPENDS>`__ variable), the OpenEmbedded build + :term:`RDEPENDS` variable), the OpenEmbedded build system generates a fatal installation error. Because the build system halts the process with a fatal error, you can use the variable with an iterative development process to remove specific components from a @@ -4592,8 +4592,8 @@ system and gives an overview of their function and contents. Support for this variable exists only when using the IPK and RPM packaging backend. Support does not exist for DEB. - See the ```NO_RECOMMENDATIONS`` <#var-NO_RECOMMENDATIONS>`__ and the - ```BAD_RECOMMENDATIONS`` <#var-BAD_RECOMMENDATIONS>`__ variables for + See the :term:`NO_RECOMMENDATIONS` and the + :term:`BAD_RECOMMENDATIONS` variables for related information. PACKAGE_EXTRA_ARCHS @@ -4606,8 +4606,8 @@ system and gives an overview of their function and contents. package feed URIs during the build. When used, the ``PACKAGE_FEED_ARCHS`` variable is appended to the final package feed URI, which is constructed using the - ```PACKAGE_FEED_URIS`` <#var-PACKAGE_FEED_URIS>`__ and - ```PACKAGE_FEED_BASE_PATHS`` <#var-PACKAGE_FEED_BASE_PATHS>`__ + :term:`PACKAGE_FEED_URIS` and + :term:`PACKAGE_FEED_BASE_PATHS` variables. .. note:: @@ -4640,8 +4640,8 @@ system and gives an overview of their function and contents. Specifies the base path used when constructing package feed URIs. The ``PACKAGE_FEED_BASE_PATHS`` variable makes up the middle portion of a package feed URI used by the OpenEmbedded build system. The base path - lies between the ```PACKAGE_FEED_URIS`` <#var-PACKAGE_FEED_URIS>`__ - and ```PACKAGE_FEED_ARCHS`` <#var-PACKAGE_FEED_ARCHS>`__ variables. + lies between the :term:`PACKAGE_FEED_URIS` + and :term:`PACKAGE_FEED_ARCHS` variables. Consider the following example where the ``PACKAGE_FEED_URIS``, ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are @@ -4663,8 +4663,8 @@ system and gives an overview of their function and contents. Specifies the front portion of the package feed URI used by the OpenEmbedded build system. Each final package feed URI is comprised of ``PACKAGE_FEED_URIS``, - ```PACKAGE_FEED_BASE_PATHS`` <#var-PACKAGE_FEED_BASE_PATHS>`__, and - ```PACKAGE_FEED_ARCHS`` <#var-PACKAGE_FEED_ARCHS>`__ variables. + :term:`PACKAGE_FEED_BASE_PATHS`, and + :term:`PACKAGE_FEED_ARCHS` variables. Consider the following example where the ``PACKAGE_FEED_URIS``, ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are @@ -4691,7 +4691,7 @@ system and gives an overview of their function and contents. not the final list of packages that are actually installed. This variable is internal to the image construction code. Consequently, in general, you should use the - ```IMAGE_INSTALL`` <#var-IMAGE_INSTALL>`__ variable to specify + :term:`IMAGE_INSTALL` variable to specify packages for installation. The exception to this is when working with the ```core-image-minimal-initramfs`` <#images-core-image-minimal-initramfs>`__ @@ -4709,7 +4709,7 @@ system and gives an overview of their function and contents. PACKAGE_PREPROCESS_FUNCS Specifies a list of functions run to pre-process the - ```PKGD`` <#var-PKGD>`__ directory prior to splitting the files out + :term:`PKGD` directory prior to splitting the files out to individual packages. PACKAGE_WRITE_DEPS @@ -4744,21 +4744,21 @@ system and gives an overview of their function and contents. order is important and specifies the following: 1. Extra arguments that should be added to the configure script - argument list (```EXTRA_OECONF`` <#var-EXTRA_OECONF>`__ or - ```PACKAGECONFIG_CONFARGS`` <#var-PACKAGECONFIG_CONFARGS>`__) if + argument list (:term:`EXTRA_OECONF` or + :term:`PACKAGECONFIG_CONFARGS`) if the feature is enabled. 2. Extra arguments that should be added to ``EXTRA_OECONF`` or ``PACKAGECONFIG_CONFARGS`` if the feature is disabled. - 3. Additional build dependencies (```DEPENDS`` <#var-DEPENDS>`__) + 3. Additional build dependencies (:term:`DEPENDS`) that should be added if the feature is enabled. - 4. Additional runtime dependencies (```RDEPENDS`` <#var-RDEPENDS>`__) + 4. Additional runtime dependencies (:term:`RDEPENDS`) that should be added if the feature is enabled. 5. Additional runtime recommendations - (```RRECOMMENDS`` <#var-RRECOMMENDS>`__) that should be added if + (:term:`RRECOMMENDS`) that should be added if the feature is enabled. 6. Any conflicting (that is, mutually exclusive) ``PACKAGECONFIG`` @@ -4797,10 +4797,10 @@ system and gives an overview of their function and contents. PACKAGECONFIG_CONFARGS A space-separated list of configuration options generated from the - ```PACKAGECONFIG`` <#var-PACKAGECONFIG>`__ setting. + :term:`PACKAGECONFIG` setting. - Classes such as ```autotools`` <#ref-classes-autotools>`__ and - ```cmake`` <#ref-classes-cmake>`__ use ``PACKAGECONFIG_CONFARGS`` to + Classes such as :ref:`autotools ` and + :ref:`cmake ` use ``PACKAGECONFIG_CONFARGS`` to pass ``PACKAGECONFIG`` options to ``configure`` and ``cmake``, respectively. If you are using ``PACKAGECONFIG`` but not a class that handles the ``do_configure`` task, then you need to use @@ -4808,7 +4808,7 @@ system and gives an overview of their function and contents. PACKAGEGROUP_DISABLE_COMPLEMENTARY For recipes inheriting the - ```packagegroup`` <#ref-classes-packagegroup>`__ class, setting + :ref:`packagegroup ` class, setting ``PACKAGEGROUP_DISABLE_COMPLEMENTARY`` to "1" specifies that the normal complementary packages (i.e. ``-dev``, ``-dbg``, and so forth) should not be automatically created by the ``packagegroup`` recipe, @@ -4819,8 +4819,8 @@ system and gives an overview of their function and contents. following: ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN} - During packaging, the ```do_package`` <#ref-tasks-package>`__ task - goes through ``PACKAGES`` and uses the ```FILES`` <#var-FILES>`__ + During packaging, the :ref:`ref-tasks-package` task + goes through ``PACKAGES`` and uses the :term:`FILES` variable corresponding to each package to assign files to the package. If a file matches the ``FILES`` variable for more than one package in ``PACKAGES``, it will be assigned to the earliest @@ -4828,26 +4828,26 @@ system and gives an overview of their function and contents. Packages in the variable's list that are empty (i.e. where none of the patterns in ``FILES_``\ pkg match any files installed by the - ```do_install`` <#ref-tasks-install>`__ task) are not generated, + :ref:`ref-tasks-install` task) are not generated, unless generation is forced through the - ```ALLOW_EMPTY`` <#var-ALLOW_EMPTY>`__ variable. + :term:`ALLOW_EMPTY` variable. PACKAGES_DYNAMIC A promise that your recipe satisfies runtime dependencies for optional modules that are found in other recipes. ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it only states that they should be satisfied. For example, if a hard, - runtime dependency (```RDEPENDS`` <#var-RDEPENDS>`__) of another + runtime dependency (:term:`RDEPENDS`) of another package is satisfied at build time through the ``PACKAGES_DYNAMIC`` variable, but a package with the module name is never actually produced, then the other package will be broken. Thus, if you attempt to include that package in an image, you will get a dependency failure from the packaging system during the - ```do_rootfs`` <#ref-tasks-rootfs>`__ task. + :ref:`ref-tasks-rootfs` task. Typically, if there is a chance that such a situation can occur and the package that is not created is valid without the dependency being - satisfied, then you should use ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ + satisfied, then you should use :term:`RRECOMMENDS` (a soft runtime dependency) instead of ``RDEPENDS``. For an example of how to use the ``PACKAGES_DYNAMIC`` variable when @@ -4860,14 +4860,14 @@ system and gives an overview of their function and contents. files into individual packages. Recipes can either prepend to this variable or prepend to the ``populate_packages`` function in order to perform additional package splitting. In either case, the function - should set ```PACKAGES`` <#var-PACKAGES>`__, - ```FILES`` <#var-FILES>`__, ```RDEPENDS`` <#var-RDEPENDS>`__ and + should set :term:`PACKAGES`, + :term:`FILES`, :term:`RDEPENDS` and other packaging variables appropriately in order to perform the desired splitting. PARALLEL_MAKE Extra options passed to the ``make`` command during the - ```do_compile`` <#ref-tasks-compile>`__ task in order to specify + :ref:`ref-tasks-compile` task in order to specify parallel compilation on the local build host. This variable is usually in the form "-j x", where x represents the maximum number of parallel threads ``make`` can run. @@ -4913,15 +4913,15 @@ system and gives an overview of their function and contents. PARALLEL_MAKEINST Extra options passed to the ``make install`` command during the - ```do_install`` <#ref-tasks-install>`__ task in order to specify + :ref:`ref-tasks-install` task in order to specify parallel installation. This variable defaults to the value of - ```PARALLEL_MAKE`` <#var-PARALLEL_MAKE>`__. + :term:`PARALLEL_MAKE`. .. note:: In order for ``PARALLEL_MAKEINST`` to be effective, ``make`` must be called with - ``${``\ ```EXTRA_OEMAKE`` <#var-EXTRA_OEMAKE>`__\ ``}``. An easy + ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy way to ensure this is to use the ``oe_runmake`` function. If the software being built experiences dependency issues during @@ -4946,7 +4946,7 @@ system and gives an overview of their function and contents. PATCHTOOL Specifies the utility used to apply patches for a recipe during the - ```do_patch`` <#ref-tasks-patch>`__ task. You can specify one of + :ref:`ref-tasks-patch` task. You can specify one of three utilities: "patch", "quilt", or "git". The default utility used is "quilt" except for the quilt-native recipe itself. Because the quilt tool is not available at the time quilt-native is being @@ -4961,20 +4961,20 @@ system and gives an overview of their function and contents. variable is used to make upgrades possible when the versioning scheme changes in some backwards incompatible way. - ``PE`` is the default value of the ```PKGE`` <#var-PKGE>`__ variable. + ``PE`` is the default value of the :term:`PKGE` variable. PF Specifies the recipe or package name and includes all version and revision numbers (i.e. ``glibc-2.13-r20+svnr15508/`` and ``bash-4.2-r1/``). This variable is comprised of the following: - ${`PN <#var-PN>`__}-${`EXTENDPE <#var-EXTENDPE>`__}${`PV <#var-PV>`__}-${`PR <#var-PR>`__} + ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`} PIXBUF_PACKAGES - When inheriting the ```pixbufcache`` <#ref-classes-pixbufcache>`__ + When inheriting the :ref:`pixbufcache ` class, this variable identifies packages that contain the pixbuf loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache`` class assumes that the loaders are in the recipe's main package (i.e. - ``${``\ ```PN`` <#var-PN>`__\ ``}``). Use this variable if the + ``${``\ :term:`PN`\ ``}``). Use this variable if the loaders you need are in a package other than that main package. PKG @@ -4987,7 +4987,7 @@ system and gives an overview of their function and contents. PKG variable, you must use a package name override. - For example, when the ```debian`` <#ref-classes-debian>`__ class + For example, when the :ref:`debian ` class renames the output package, it does so by setting ``PKG_packagename``. @@ -5005,7 +5005,7 @@ system and gives an overview of their function and contents. PKGDATA_DIR Points to a shared, global-state directory that holds data generated during the packaging process. During the packaging process, the - ```do_packagedata`` <#ref-tasks-packagedata>`__ task packages data + :ref:`ref-tasks-packagedata` task packages data for each recipe and installs it into this temporary, shared area. This directory defaults to the following, which you should not change: ${STAGING_DIR_HOST}/pkgdata For examples of how this data is @@ -5016,7 +5016,7 @@ system and gives an overview of their function and contents. ``oe-pkgdata-util`` <&YOCTO_DOCS_DEV_URL;#viewing-package-information-with-oe-pkgdata-util>`__" section in the Yocto Project Development Tasks Manual. For more information on the shared, global-state directory, see - ```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__. + :term:`STAGING_DIR_HOST`. PKGDEST Points to the parent directory for files to be packaged after they @@ -5024,30 +5024,30 @@ system and gives an overview of their function and contents. the following: ${WORKDIR}/packages-split Under this directory, the build system creates directories for each - package specified in ```PACKAGES`` <#var-PACKAGES>`__. Do not change + package specified in :term:`PACKAGES`. Do not change this default. PKGDESTWORK Points to a temporary work area where the - ```do_package`` <#ref-tasks-package>`__ task saves package metadata. + :ref:`ref-tasks-package` task saves package metadata. The ``PKGDESTWORK`` location defaults to the following: ${WORKDIR}/pkgdata Do not change this default. - The ```do_packagedata`` <#ref-tasks-packagedata>`__ task copies the + The :ref:`ref-tasks-packagedata` task copies the package metadata from ``PKGDESTWORK`` to - ```PKGDATA_DIR`` <#var-PKGDATA_DIR>`__ to make it available globally. + :term:`PKGDATA_DIR` to make it available globally. PKGE The epoch of the package(s) built by the recipe. By default, ``PKGE`` - is set to ```PE`` <#var-PE>`__. + is set to :term:`PE`. PKGR The revision of the package(s) built by the recipe. By default, - ``PKGR`` is set to ```PR`` <#var-PR>`__. + ``PKGR`` is set to :term:`PR`. PKGV The version of the package(s) built by the recipe. By default, - ``PKGV`` is set to ```PV`` <#var-PV>`__. + ``PKGV`` is set to :term:`PV`. PN This variable can have two separate functions depending on the @@ -5071,7 +5071,7 @@ system and gives an overview of their function and contents. PNBLACKLIST Lists recipes you do not want the OpenEmbedded build system to build. This variable works in conjunction with the - ```blacklist`` <#ref-classes-blacklist>`__ class, which is inherited + :ref:`blacklist ` class, which is inherited globally. To prevent a recipe from being built, use the ``PNBLACKLIST`` @@ -5088,7 +5088,7 @@ system and gives an overview of their function and contents. If you need to pass the SDK path to a command within a function, you can use ``${SDK_DIR}``, which points to the parent directory used by the OpenEmbedded build system when creating SDK output. See the - ```SDK_DIR`` <#var-SDK_DIR>`__ variable for more information. + :term:`SDK_DIR` variable for more information. POPULATE_SDK_POST_TARGET_COMMAND Specifies a list of functions to call once the OpenEmbedded build @@ -5099,12 +5099,12 @@ system and gives an overview of their function and contents. If you need to pass the SDK path to a command within a function, you can use ``${SDK_DIR}``, which points to the parent directory used by the OpenEmbedded build system when creating SDK output. See the - ```SDK_DIR`` <#var-SDK_DIR>`__ variable for more information. + :term:`SDK_DIR` variable for more information. PR The revision of the recipe. The default value for this variable is "r0". Subsequent revisions of the recipe conventionally have the - values "r1", "r2", and so forth. When ```PV`` <#var-PV>`__ increases, + values "r1", "r2", and so forth. When :term:`PV` increases, ``PR`` is conventionally reset to "r0". .. note:: @@ -5122,7 +5122,7 @@ system and gives an overview of their function and contents. The ``PR`` variable primarily becomes significant when a package manager dynamically installs packages on an already built image. In this case, ``PR``, which is the default value of - ```PKGR`` <#var-PKGR>`__, helps the package manager distinguish which + :term:`PKGR`, helps the package manager distinguish which package is the most recent one in cases where many packages have the same ``PV`` (i.e. ``PKGV``). A component having many packages with the same ``PV`` usually means that the packages all install the same @@ -5145,7 +5145,7 @@ system and gives an overview of their function and contents. which recipe is preferred and thus provides the item (i.e. the preferred provider). You should always suffix this variable with the name of the provided item. And, you should define the variable using - the preferred recipe's name (```PN`` <#var-PN>`__). Here is a common + the preferred recipe's name (:term:`PN`). Here is a common example: PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" In the previous example, multiple recipes are providing "virtual/kernel". The ``PREFERRED_PROVIDER`` variable is set with the name (``PN``) of @@ -5174,8 +5174,8 @@ system and gives an overview of their function and contents. PREFERRED_VERSION If multiple versions of recipes exist, this variable determines which version is given preference. You must always suffix the variable with - the ```PN`` <#var-PN>`__ you want to select, and you should set the - ```PV`` <#var-PV>`__ accordingly for precedence. + the :term:`PN` you want to select, and you should set the + :term:`PV` accordingly for precedence. The ``PREFERRED_VERSION`` variable supports limited wildcard use through the "``%``" character. You can use the character to match any @@ -5192,7 +5192,7 @@ system and gives an overview of their function and contents. string. You cannot use the wildcard character in any other location of the string. - The specified version is matched against ```PV`` <#var-PV>`__, which + The specified version is matched against :term:`PV`, which does not necessarily match the version part of the recipe's filename. For example, consider two recipes ``foo_1.2.bb`` and ``foo_git.bb`` where ``foo_git.bb`` contains the following assignment: PV = @@ -5204,7 +5204,7 @@ system and gives an overview of their function and contents. Sometimes the ``PREFERRED_VERSION`` variable can be set by configuration files in a way that is hard to change. You can use - ```OVERRIDES`` <#var-OVERRIDES>`__ to set a machine-specific + :term:`OVERRIDES` to set a machine-specific override. Here is an example: PREFERRED_VERSION_linux-yocto_qemux86 = "5.0%" Although not recommended, worst case, you can also use the "forcevariable" override, which is the strongest override possible. @@ -5226,9 +5226,9 @@ system and gives an overview of their function and contents. first tries the local download directory. If that location fails, the build system tries locations defined by ``PREMIRRORS``, the upstream source, and then locations specified by - ```MIRRORS`` <#var-MIRRORS>`__ in that order. + :term:`MIRRORS` in that order. - Assuming your distribution (```DISTRO`` <#var-DISTRO>`__) is "poky", + Assuming your distribution (:term:`DISTRO`) is "poky", the default value for ``PREMIRRORS`` is defined in the ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. @@ -5315,7 +5315,7 @@ system and gives an overview of their function and contents. "virtual/function" (e.g. "virtual/kernel"). The slash is simply part of the name and has no syntactical significance. - The ```PREFERRED_PROVIDER`` <#var-PREFERRED_PROVIDER>`__ variable is + The :term:`PREFERRED_PROVIDER` variable is used to select which particular recipe provides a virtual target. .. note:: @@ -5335,10 +5335,10 @@ system and gives an overview of their function and contents. PRSERV_HOST - The network based ```PR`` <#var-PR>`__ service host and port. + The network based :term:`PR` service host and port. The ``conf/local.conf.sample.extended`` configuration file in the - `Source Directory <#source-directory>`__ shows how the + :term:`Source Directory` shows how the ``PRSERV_HOST`` variable is set: PRSERV_HOST = "localhost:0" You must set the variable if you want to automatically start a local `PR service <&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service>`__. You can @@ -5350,7 +5350,7 @@ system and gives an overview of their function and contents. functionality is enabled when building a recipe. You should not set this variable directly. Enabling and disabling building Package Tests at build time should be done by adding "ptest" to (or removing it - from) ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__. + from) :term:`DISTRO_FEATURES`. PV The version of the recipe. The version is normally extracted from the @@ -5360,14 +5360,14 @@ system and gives an overview of their function and contents. building an unstable (i.e. development) version from a source code repository (e.g. Git or Subversion). - ``PV`` is the default value of the ```PKGV`` <#var-PKGV>`__ variable. + ``PV`` is the default value of the :term:`PKGV` variable. PYTHON_ABI When used by recipes that inherit the ```distutils3`` <#ref-classes-distutils3>`__, ```setuptools3`` <#ref-classes-setuptools3>`__, - ```distutils`` <#ref-classes-distutils>`__, or - ```setuptools`` <#ref-classes-setuptools>`__ classes, denotes the + :ref:`distutils `, or + :ref:`setuptools ` classes, denotes the Application Binary Interface (ABI) currently in use for Python. By default, the ABI is "m". You do not have to set this variable as the OpenEmbedded build system sets it for you. @@ -5384,8 +5384,8 @@ system and gives an overview of their function and contents. When used by recipes that inherit the ```distutils3`` <#ref-classes-distutils3>`__, ```setuptools3`` <#ref-classes-setuptools3>`__, - ```distutils`` <#ref-classes-distutils>`__, or - ```setuptools`` <#ref-classes-setuptools>`__ classes, specifies the + :ref:`distutils `, or + :ref:`setuptools ` classes, specifies the major Python version being built. For Python 3.x, ``PYTHON_PN`` would be "python3". You do not have to set this variable as the OpenEmbedded build system automatically sets it for you. @@ -5432,15 +5432,15 @@ system and gives an overview of their function and contents. ```do_package_write_*`` <#ref-tasks-package_write_deb>`__ tasks. Exactly how this is done depends on which package format is used, which is determined by - ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__. When the + :term:`PACKAGE_CLASSES`. When the corresponding package manager installs the package, it will know to also install the packages on which it depends. To ensure that the packages ``bar`` and ``baz`` get built, the previous ``RDEPENDS`` assignment also causes a task dependency to be added. This dependency is from the recipe's - ```do_build`` <#ref-tasks-build>`__ (not to be confused with - ```do_compile`` <#ref-tasks-compile>`__) task to the + :ref:`ref-tasks-build` (not to be confused with + :ref:`ref-tasks-compile`) task to the ``do_package_write_*`` task of the recipes that build ``bar`` and ``baz``. @@ -5449,7 +5449,7 @@ system and gives an overview of their function and contents. package names and recipe names usually match, the important point here is that you are providing package names within the ``RDEPENDS`` variable. For an example of the default list of packages created from - a recipe, see the ```PACKAGES`` <#var-PACKAGES>`__ variable. + a recipe, see the :term:`PACKAGES` variable. Because the ``RDEPENDS`` variable applies to packages being built, you should always use the variable in a form with an attached package @@ -5478,9 +5478,9 @@ system and gives an overview of their function and contents. . Use the "+=" operator rather than the "=" operator. The package names you use with ``RDEPENDS`` must appear as they would - in the ``PACKAGES`` variable. The ```PKG`` <#var-PKG>`__ variable + in the ``PACKAGES`` variable. The :term:`PKG` variable allows a different name to be used for the final package (e.g. the - ```debian`` <#ref-classes-debian>`__ class uses this to rename + :ref:`debian ` class uses this to rename packages), but this final package name cannot be used with ``RDEPENDS``, which makes sense as ``RDEPENDS`` is meant to be independent of the package format used. @@ -5503,7 +5503,7 @@ system and gives an overview of their function and contents. greater of the package ``foo``: RDEPENDS_${PN} = "foo (>= 1.2)" For information on build-time dependencies, see the - ```DEPENDS`` <#var-DEPENDS>`__ variable. You can also see the + :term:`DEPENDS` variable. You can also see the "`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and "`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the BitBake User Manual for additional information on tasks and @@ -5511,7 +5511,7 @@ system and gives an overview of their function and contents. REQUIRED_DISTRO_FEATURES When inheriting the - ```distro_features_check`` <#ref-classes-distro_features_check>`__ + :ref:`distro_features_check ` class, this variable identifies distribution features that must exist in the current configuration in order for the OpenEmbedded build system to build the recipe. In other words, if the @@ -5546,7 +5546,7 @@ system and gives an overview of their function and contents. Indicates a filesystem image to include as the root filesystem. The ``ROOTFS`` variable is an optional variable used with the - ```image-live`` <#ref-classes-image-live>`__ class. + :ref:`image-live ` class. ROOTFS_POSTINSTALL_COMMAND Specifies a list of functions to call after the OpenEmbedded build @@ -5556,7 +5556,7 @@ system and gives an overview of their function and contents. If you need to pass the root filesystem path to a command within a function, you can use ``${IMAGE_ROOTFS}``, which points to the directory that becomes the root filesystem image. See the - ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more + :term:`IMAGE_ROOTFS` variable for more information. ROOTFS_POSTPROCESS_COMMAND @@ -5568,7 +5568,7 @@ system and gives an overview of their function and contents. If you need to pass the root filesystem path to a command within a function, you can use ``${IMAGE_ROOTFS}``, which points to the directory that becomes the root filesystem image. See the - ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more + :term:`IMAGE_ROOTFS` variable for more information. ROOTFS_POSTUNINSTALL_COMMAND @@ -5582,7 +5582,7 @@ system and gives an overview of their function and contents. If you need to pass the root filesystem path to a command within a function, you can use ``${IMAGE_ROOTFS}``, which points to the directory that becomes the root filesystem image. See the - ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more + :term:`IMAGE_ROOTFS` variable for more information. ROOTFS_PREPROCESS_COMMAND @@ -5594,7 +5594,7 @@ system and gives an overview of their function and contents. If you need to pass the root filesystem path to a command within a function, you can use ``${IMAGE_ROOTFS}``, which points to the directory that becomes the root filesystem image. See the - ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more + :term:`IMAGE_ROOTFS` variable for more information. RPROVIDES @@ -5623,15 +5623,15 @@ system and gives an overview of their function and contents. The package manager will automatically install the ``RRECOMMENDS`` list of packages when installing the built package. However, you can prevent listed packages from being installed by using the - ```BAD_RECOMMENDATIONS`` <#var-BAD_RECOMMENDATIONS>`__, - ```NO_RECOMMENDATIONS`` <#var-NO_RECOMMENDATIONS>`__, and - ```PACKAGE_EXCLUDE`` <#var-PACKAGE_EXCLUDE>`__ variables. + :term:`BAD_RECOMMENDATIONS`, + :term:`NO_RECOMMENDATIONS`, and + :term:`PACKAGE_EXCLUDE` variables. Packages specified in ``RRECOMMENDS`` need not actually be produced. However, a recipe must exist that provides each package, either - through the ```PACKAGES`` <#var-PACKAGES>`__ or - ```PACKAGES_DYNAMIC`` <#var-PACKAGES_DYNAMIC>`__ variables or the - ```RPROVIDES`` <#var-RPROVIDES>`__ variable, or an error will occur + through the :term:`PACKAGES` or + :term:`PACKAGES_DYNAMIC` variables or the + :term:`RPROVIDES` variable, or an error will occur during the build. If such a recipe does exist and the package is not produced, the build continues without error. @@ -5684,9 +5684,9 @@ system and gives an overview of their function and contents. example: RSUGGESTS_${PN} = "useful_package another_package" S - The location in the `Build Directory <#build-directory>`__ where + The location in the :term:`Build Directory` where unpacked recipe source code resides. By default, this directory is - ``${``\ ```WORKDIR`` <#var-WORKDIR>`__\ ``}/${``\ ```BPN`` <#var-BPN>`__\ ``}-${``\ ```PV`` <#var-PV>`__\ ``}``, + ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe version. If the source tarball extracts the code to a directory named anything other than ``${BPN}-${PV}``, or if the source code is @@ -5694,7 +5694,7 @@ system and gives an overview of their function and contents. ``S`` in the recipe so that the OpenEmbedded build system knows where to find the unpacked source. - As an example, assume a `Source Directory <#source-directory>`__ + As an example, assume a :term:`Source Directory` top-level folder named ``poky`` and a default Build Directory at ``poky/build``. In this case, the work directory the build system uses to keep the unpacked recipe for ``db`` is the following: @@ -5703,7 +5703,7 @@ system and gives an overview of their function and contents. This next example assumes a Git repository. By default, Git repositories are cloned to ``${WORKDIR}/git`` during - ```do_fetch`` <#ref-tasks-fetch>`__. Since this path is different + :ref:`ref-tasks-fetch`. Since this path is different from the default value of ``S``, you must set it specifically so the source can be located: SRC_URI = "git://path/to/repo.git" S = "${WORKDIR}/git" @@ -5721,13 +5721,13 @@ system and gives an overview of their function and contents. as read from ``/etc/lsb-release``. Separate the list items with explicit newline characters (``\n``). If ``SANITY_TESTED_DISTROS`` is not empty and the current value of - ```NATIVELSBSTRING`` <#var-NATIVELSBSTRING>`__ does not appear in the + :term:`NATIVELSBSTRING` does not appear in the list, then the build system reports a warning that indicates the current host distribution has not been tested as a build host. SDK_ARCH The target architecture for the SDK. Typically, you do not directly - set this variable. Instead, use ```SDKMACHINE`` <#var-SDKMACHINE>`__. + set this variable. Instead, use :term:`SDKMACHINE`. SDK_DEPLOY The directory set up and used by the @@ -5773,8 +5773,8 @@ system and gives an overview of their function and contents. The ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class defines the manifest file as follows: SDK_HOST_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest" The location is - derived using the ```SDK_DEPLOY`` <#var-SDK_DEPLOY>`__ and - ```TOOLCHAIN_OUTPUTNAME`` <#var-TOOLCHAIN_OUTPUTNAME>`__ variables. + derived using the :term:`SDK_DEPLOY` and + :term:`TOOLCHAIN_OUTPUTNAME` variables. SDK_INCLUDE_PKGDATA When set to "1", specifies to include the packagedata for all recipes @@ -5794,7 +5794,7 @@ system and gives an overview of their function and contents. SDK_INCLUDE_TOOLCHAIN When set to "1", specifies to include the toolchain in the extensible SDK. Including the toolchain is useful particularly when - ```SDK_EXT_TYPE`` <#var-SDK_EXT_TYPE>`__ is set to "minimal" to keep + :term:`SDK_EXT_TYPE` is set to "minimal" to keep the SDK reasonably small but you still want to provide a usable toolchain. For example, suppose you want to use the toolchain from an IDE or from other tools and you do not want to perform additional @@ -5805,7 +5805,7 @@ system and gives an overview of their function and contents. ``SDK_EXT_TYPE`` is set to "full". SDK_INHERIT_BLACKLIST - A list of classes to remove from the ```INHERIT`` <#var-INHERIT>`__ + A list of classes to remove from the :term:`INHERIT` value globally within the extensible SDK configuration. The ```populate-sdk-ext`` <#ref-classes-populate-sdk-*>`__ class sets the default value: SDK_INHERIT_BLACKLIST ?= "buildhistory icecc" @@ -5829,14 +5829,14 @@ system and gives an overview of their function and contents. By default, ``SDK_LOCAL_CONF_BLACKLIST`` is set in the ```populate-sdk-ext`` <#ref-classes-populate-sdk-*>`__ class and excludes the following variables: - `CONF_VERSION <#var-CONF_VERSION>`__ - `BB_NUMBER_THREADS <#var-BB_NUMBER_THREADS>`__ + :term:`CONF_VERSION` + :term:`BB_NUMBER_THREADS` `BB_NUMBER_PARSE_THREADS <&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS>`__ - `PARALLEL_MAKE <#var-PARALLEL_MAKE>`__ - `PRSERV_HOST <#var-PRSERV_HOST>`__ - `SSTATE_MIRRORS <#var-SSTATE_MIRRORS>`__ `DL_DIR <#var-DL_DIR>`__ - `SSTATE_DIR <#var-SSTATE_DIR>`__ `TMPDIR <#var-TMPDIR>`__ - `BB_SERVER_TIMEOUT <#var-BB_SERVER_TIMEOUT>`__ + :term:`PARALLEL_MAKE` + :term:`PRSERV_HOST` + :term:`SSTATE_MIRRORS` :term:`DL_DIR` + :term:`SSTATE_DIR` :term:`TMPDIR` + :term:`BB_SERVER_TIMEOUT` For additional information on how to customize the extensible SDK's configuration, see the "`Configuring the Extensible @@ -5851,7 +5851,7 @@ system and gives an overview of their function and contents. ```populate-sdk-ext`` <#ref-classes-populate-sdk-*>`__ class. This list overrides the variables specified using the - ```SDK_LOCAL_CONF_BLACKLIST`` <#var-SDK_LOCAL_CONF_BLACKLIST>`__ + :term:`SDK_LOCAL_CONF_BLACKLIST` variable as well as any variables identified by automatic blacklisting due to the "/" character being found at the start of the value, which is usually indicative of being a path and thus might not @@ -5865,15 +5865,15 @@ system and gives an overview of their function and contents. SDK_NAME The base name for SDK output files. The name is derived from the - ```DISTRO`` <#var-DISTRO>`__, ```TCLIBC`` <#var-TCLIBC>`__, - ```SDK_ARCH`` <#var-SDK_ARCH>`__, - ```IMAGE_BASENAME`` <#var-IMAGE_BASENAME>`__, and - ```TUNE_PKGARCH`` <#var-TUNE_PKGARCH>`__ variables: SDK_NAME = + :term:`DISTRO`, :term:`TCLIBC`, + :term:`SDK_ARCH`, + :term:`IMAGE_BASENAME`, and + :term:`TUNE_PKGARCH` variables: SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}" SDK_OS Specifies the operating system for which the SDK will be built. The - default value is the value of ```BUILD_OS`` <#var-BUILD_OS>`__. + default value is the value of :term:`BUILD_OS`. SDK_OUTPUT The location used by the OpenEmbedded build system when creating SDK @@ -5908,12 +5908,12 @@ system and gives an overview of their function and contents. If you need to pass an SDK path to a command within a function, you can use ``${SDK_DIR}``, which points to the parent directory used by the OpenEmbedded build system when creating SDK output. See the - ```SDK_DIR`` <#var-SDK_DIR>`__ variable for more information. + :term:`SDK_DIR` variable for more information. SDK_PREFIX The toolchain binary prefix used for ``nativesdk`` recipes. The OpenEmbedded build system uses the ``SDK_PREFIX`` value to set the - ```TARGET_PREFIX`` <#var-TARGET_PREFIX>`__ when building + :term:`TARGET_PREFIX` when building ``nativesdk`` recipes. The default value is "${SDK_SYS}-". SDK_RECRDEP_TASKS @@ -5924,16 +5924,16 @@ system and gives an overview of their function and contents. to the SDK. To specify tasks beyond these four, you need to use the ``SDK_RECRDEP_TASKS`` variable (e.g. you are defining additional tasks that are needed in order to build - ```SDK_TARGETS`` <#var-SDK_TARGETS>`__). + :term:`SDK_TARGETS`). SDK_SYS Specifies the system, including the architecture and the operating system, for which the SDK will be built. The OpenEmbedded build system automatically sets this variable based - on ```SDK_ARCH`` <#var-SDK_ARCH>`__, - ```SDK_VENDOR`` <#var-SDK_VENDOR>`__, and - ```SDK_OS`` <#var-SDK_OS>`__. You do not need to set the ``SDK_SYS`` + on :term:`SDK_ARCH`, + :term:`SDK_VENDOR`, and + :term:`SDK_OS`. You do not need to set the ``SDK_SYS`` variable yourself. SDK_TARGET_MANIFEST @@ -5945,8 +5945,8 @@ system and gives an overview of their function and contents. The ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class defines the manifest file as follows: SDK_TARGET_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest" The location - is derived using the ```SDK_DEPLOY`` <#var-SDK_DEPLOY>`__ and - ```TOOLCHAIN_OUTPUTNAME`` <#var-TOOLCHAIN_OUTPUTNAME>`__ variables. + is derived using the :term:`SDK_DEPLOY` and + :term:`TOOLCHAIN_OUTPUTNAME` variables. SDK_TARGETS A list of targets to install from shared state as part of the @@ -5958,8 +5958,8 @@ system and gives an overview of their function and contents. SDK_TITLE The title to be printed when running the SDK installer. By default, - this title is based on the ```DISTRO_NAME`` <#var-DISTRO_NAME>`__ or - ```DISTRO`` <#var-DISTRO>`__ variable and is set in the + this title is based on the :term:`DISTRO_NAME` or + :term:`DISTRO` variable and is set in the ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class as follows: SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK" For the default distribution "poky", @@ -5986,12 +5986,12 @@ system and gives an overview of their function and contents. "${@d.getVar('DISTRO_VERSION').replace('snapshot-${DATE}','snapshot')}" For additional information, see the - ```DISTRO_VERSION`` <#var-DISTRO_VERSION>`__ and - ```DATE`` <#var-DATE>`__ variables. + :term:`DISTRO_VERSION` and + :term:`DATE` variables. SDKEXTPATH The default installation directory for the Extensible SDK. By - default, this directory is based on the ```DISTRO`` <#var-DISTRO>`__ + default, this directory is based on the :term:`DISTRO` variable and is set in the ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class as follows: SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" For the @@ -6035,7 +6035,7 @@ system and gives an overview of their function and contents. SDKTARGETSYSROOT The full path to the sysroot used for cross-compilation within an SDK as it will be when installed into the default - ```SDKPATH`` <#var-SDKPATH>`__. + :term:`SDKPATH`. SECTION The section in which packages should be categorized. Package @@ -6044,7 +6044,7 @@ system and gives an overview of their function and contents. SELECTED_OPTIMIZATION Specifies the optimization flags passed to the C compiler when building for the target. The flags are passed through the default - value of the ```TARGET_CFLAGS`` <#var-TARGET_CFLAGS>`__ variable. + value of the :term:`TARGET_CFLAGS` variable. The ``SELECTED_OPTIMIZATION`` variable takes the value of ``FULL_OPTIMIZATION`` unless ``DEBUG_BUILD`` = "1". If that is the @@ -6074,7 +6074,7 @@ system and gives an overview of their function and contents. SERIAL_CONSOLES_CHECK Specifies serial consoles, which must be listed in - ```SERIAL_CONSOLES`` <#var-SERIAL_CONSOLES>`__, to check against + :term:`SERIAL_CONSOLES`, to check against ``/proc/console`` before enabling them using getty. This variable allows aliasing in the format: :. If a device was listed as "sclp_line0" in ``/dev/`` and "ttyS0" was listed in @@ -6175,8 +6175,8 @@ system and gives an overview of their function and contents. recipes are fetched regardless of whether or not a recipe is compatible with the configuration. A recipe is considered incompatible with the currently configured machine when either or - both the ```COMPATIBLE_MACHINE`` <#var-COMPATIBLE_MACHINE>`__ - variable and ```COMPATIBLE_HOST`` <#var-COMPATIBLE_HOST>`__ variables + both the :term:`COMPATIBLE_MACHINE` + variable and :term:`COMPATIBLE_HOST` variables specify compatibility with a machine other than that of the current machine or host. @@ -6188,12 +6188,12 @@ system and gives an overview of their function and contents. do not set the variable during a normal build. SOURCE_MIRROR_URL - Defines your own ```PREMIRRORS`` <#var-PREMIRRORS>`__ from which to + Defines your own :term:`PREMIRRORS` from which to first fetch source before attempting to fetch from the upstream - specified in ```SRC_URI`` <#var-SRC_URI>`__. + specified in :term:`SRC_URI`. To use this variable, you must globally inherit the - ```own-mirrors`` <#ref-classes-own-mirrors>`__ class and then provide + :ref:`own-mirrors ` class and then provide the URL to your mirrors. Here is the general syntax: INHERIT += "own-mirrors" SOURCE_MIRROR_URL = "http://example.com/my_source_mirror" @@ -6209,14 +6209,14 @@ system and gives an overview of their function and contents. ``meta/files/common-licenses/``. For the default ``SPDXLICENSEMAP`` mappings, see the ``meta/conf/licenses.conf`` file. - For additional information, see the ```LICENSE`` <#var-LICENSE>`__ + For additional information, see the :term:`LICENSE` variable. SPECIAL_PKGSUFFIX - A list of prefixes for ```PN`` <#var-PN>`__ used by the OpenEmbedded + A list of prefixes for :term:`PN` used by the OpenEmbedded build system to create variants of recipes or packages. The list specifies the prefixes to strip off during certain circumstances such - as the generation of the ```BPN`` <#var-BPN>`__ variable. + as the generation of the :term:`BPN` variable. SPL_BINARY The file type for the Secondary Program Loader (SPL). Some devices @@ -6260,9 +6260,9 @@ system and gives an overview of their function and contents. BitBake User Manual. - *``file://`` -* Fetches files, which are usually files shipped - with the `Metadata <#metadata>`__, from the local machine (e.g. + with the :term:`Metadata`, from the local machine (e.g. `patch <&YOCTO_DOCS_OM_URL;#patching-dev-environment>`__ files). - The path is relative to the ```FILESPATH`` <#var-FILESPATH>`__ + The path is relative to the :term:`FILESPATH` variable. Thus, the build system searches, in order, from the following directories, which are assumed to be a subdirectories of the directory in which the recipe file (``.bb``) or append file @@ -6334,13 +6334,13 @@ system and gives an overview of their function and contents. patch. The default level is 1. - *``patchdir`` -* Specifies the directory in which the patch should - be applied. The default is ``${``\ ```S`` <#var-S>`__\ ``}``. + be applied. The default is ``${``\ :term:`S`\ ``}``. Here are options specific to recipes building code from a revision control system: - *``mindate`` -* Apply the patch only if - ```SRCDATE`` <#var-SRCDATE>`__ is equal to or greater than + :term:`SRCDATE` is equal to or greater than ``mindate``. - *``maxdate`` -* Apply the patch only if ``SRCDATE`` is not later @@ -6364,7 +6364,7 @@ system and gives an overview of their function and contents. an archive. The default action is to unpack the file. - *``destsuffix`` -* Places the file (or extracts its contents) into - the specified subdirectory of ```WORKDIR`` <#var-WORKDIR>`__ when + the specified subdirectory of :term:`WORKDIR` when the Git fetcher is used. - *``subdir`` -* Places the file (or extracts its contents) into the @@ -6398,10 +6398,10 @@ system and gives an overview of their function and contents. SRCPV Returns the version string of the current package. This string is - used to help define the value of ```PV`` <#var-PV>`__. + used to help define the value of :term:`PV`. The ``SRCPV`` variable is defined in the ``meta/conf/bitbake.conf`` - configuration file in the `Source Directory <#source-directory>`__ as + configuration file in the :term:`Source Directory` as follows: SRCPV = "${@bb.fetch2.get_srcrev(d)}" Recipes that need to define ``PV`` do so with the help of the @@ -6433,7 +6433,7 @@ system and gives an overview of their function and contents. SSTATE_MIRROR_ALLOW_NETWORK If set to "1", allows fetches from mirrors that are specified in - ```SSTATE_MIRRORS`` <#var-SSTATE_MIRRORS>`__ to work even when + :term:`SSTATE_MIRRORS` to work even when fetching from the network is disabled by setting ``BB_NO_NETWORK`` to "1". Using the ``SSTATE_MIRROR_ALLOW_NETWORK`` variable is useful if you have set ``SSTATE_MIRRORS`` to point to an internal server for @@ -6443,8 +6443,8 @@ system and gives an overview of their function and contents. SSTATE_MIRRORS Configures the OpenEmbedded build system to search other mirror locations for prebuilt cache data objects before building out the - data. This variable works like fetcher ```MIRRORS`` <#var-MIRRORS>`__ - and ```PREMIRRORS`` <#var-PREMIRRORS>`__ and points to the cache + data. This variable works like fetcher :term:`MIRRORS` + and :term:`PREMIRRORS` and points to the cache locations to check for the shared state (sstate) objects. You can specify a filesystem directory or a remote URL such as HTTP @@ -6456,15 +6456,15 @@ system and gives an overview of their function and contents. a different GCC version for native builds, you must configure ``SSTATE_MIRRORS`` with a regular expression that maps local search paths to server paths. The paths need to take into account - ```NATIVELSBSTRING`` <#var-NATIVELSBSTRING>`__ set by the - ```uninative`` <#ref-classes-uninative>`__ class. For example, the + :term:`NATIVELSBSTRING` set by the + :ref:`uninative ` class. For example, the following maps the local search path ``universal-4.9`` to the server-provided path server_url_sstate_path: SSTATE_MIRRORS ?= file://universal-4.9/(.*) http://server_url_sstate_path/universal-4.8/\1 \\n If a mirror uses the same structure as - ```SSTATE_DIR`` <#var-SSTATE_DIR>`__, you need to add "PATH" at the + :term:`SSTATE_DIR`, you need to add "PATH" at the end as shown in the examples below. The build system substitutes the correct path within the directory structure. SSTATE_MIRRORS ?= "\\ file://.\* @@ -6484,11 +6484,11 @@ system and gives an overview of their function and contents. by the ``SSTATE_SCAN_FILES`` variable. Typically, recipes add files they want to be scanned to the value of ``SSTATE_SCAN_FILES`` rather than the variable being comprehensively set. The - ```sstate`` <#ref-classes-sstate>`__ class specifies the default list + :ref:`sstate ` class specifies the default list of files. For details on the process, see the - ```staging`` <#ref-classes-staging>`__ class. + :ref:`staging ` class. STAGING_BASE_LIBDIR_NATIVE Specifies the path to the ``/lib`` subdirectory of the sysroot @@ -6497,12 +6497,12 @@ system and gives an overview of their function and contents. STAGING_BASELIBDIR Specifies the path to the ``/lib`` subdirectory of the sysroot directory for the target for which the current recipe is being built - (```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__). + (:term:`STAGING_DIR_HOST`). STAGING_BINDIR Specifies the path to the ``/usr/bin`` subdirectory of the sysroot directory for the target for which the current recipe is being built - (```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__). + (:term:`STAGING_DIR_HOST`). STAGING_BINDIR_CROSS Specifies the path to the directory containing binary configuration @@ -6528,7 +6528,7 @@ system and gives an overview of their function and contents. STAGING_DATADIR Specifies the path to the ``/usr/share`` subdirectory of the sysroot directory for the target for which the current recipe is being built - (```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__). + (:term:`STAGING_DIR_HOST`). STAGING_DATADIR_NATIVE Specifies the path to the ``/usr/share`` subdirectory of the sysroot @@ -6539,14 +6539,14 @@ system and gives an overview of their function and contents. during packaging. For information on how staging for recipe-specific sysroots occurs, - see the ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ + see the :ref:`ref-tasks-populate_sysroot` task, the "`Sharing Files Between Recipes <&YOCTO_DOCS_DEV_URL;#new-sharing-files-between-recipes>`__" section in the Yocto Project Development Tasks Manual, the "`Configuration, Compilation, and Staging <&YOCTO_DOCS_OM_URL;#configuration-compilation-and-staging-dev-environment>`__" section in the Yocto Project Overview and Concepts Manual, and the - ```SYSROOT_DIRS`` <#var-SYSROOT_DIRS>`__ variable. + :term:`SYSROOT_DIRS` variable. .. note:: @@ -6566,15 +6566,15 @@ system and gives an overview of their function and contents. Specifies the path to the sysroot directory for the system on which the component is built to run (the system that hosts the component). For most recipes, this sysroot is the one in which that recipe's - ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task copies + :ref:`ref-tasks-populate_sysroot` task copies files. Exceptions include ``-native`` recipes, where the ``do_populate_sysroot`` task instead uses - ```STAGING_DIR_NATIVE`` <#var-STAGING_DIR_NATIVE>`__. Depending on + :term:`STAGING_DIR_NATIVE`. Depending on the type of recipe and the build target, ``STAGING_DIR_HOST`` can have the following values: - For recipes building for the target machine, the value is - "${`STAGING_DIR <#var-STAGING_DIR>`__}/${`MACHINE <#var-MACHINE>`__}". + "${:term:`STAGING_DIR`}/${:term:`MACHINE`}". - For native recipes building for the build host, the value is empty given the assumption that when building for the build host, the @@ -6586,16 +6586,16 @@ system and gives an overview of their function and contents. as ``/usr``. Rather, these recipes are installed into ``STAGING_DIR_NATIVE``. When compiling ``-native`` recipes, standard build environment variables such as - ```CPPFLAGS`` <#var-CPPFLAGS>`__ and - ```CFLAGS`` <#var-CFLAGS>`__ are set up so that both host paths + :term:`CPPFLAGS` and + :term:`CFLAGS` are set up so that both host paths and ``STAGING_DIR_NATIVE`` are searched for libraries and headers using, for example, GCC's ``-isystem`` option. Thus, the emphasis is that the ``STAGING_DIR*`` variables should be viewed as input variables by tasks such as - ```do_configure`` <#ref-tasks-configure>`__, - ```do_compile`` <#ref-tasks-compile>`__, and - ```do_install`` <#ref-tasks-install>`__. Having the real system + :ref:`ref-tasks-configure`, + :ref:`ref-tasks-compile`, and + :ref:`ref-tasks-install`. Having the real system root correspond to ``STAGING_DIR_HOST`` makes conceptual sense for ``-native`` recipes, as they make use of host headers and libraries. @@ -6608,7 +6608,7 @@ system and gives an overview of their function and contents. Specifies the path to the sysroot used for the system for which the component generates code. For components that do not generate code, which is the majority, ``STAGING_DIR_TARGET`` is set to match - ```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__. + :term:`STAGING_DIR_HOST`. Some recipes build binaries that can run on the target system but those binaries in turn generate code for another different system @@ -6627,12 +6627,12 @@ system and gives an overview of their function and contents. STAGING_EXECPREFIXDIR Specifies the path to the ``/usr`` subdirectory of the sysroot directory for the target for which the current recipe is being built - (```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__). + (:term:`STAGING_DIR_HOST`). STAGING_INCDIR Specifies the path to the ``/usr/include`` subdirectory of the sysroot directory for the target for which the current recipe being - built (```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__). + built (:term:`STAGING_DIR_HOST`). STAGING_INCDIR_NATIVE Specifies the path to the ``/usr/include`` subdirectory of the @@ -6652,7 +6652,7 @@ system and gives an overview of their function and contents. STAGING_LIBDIR Specifies the path to the ``/usr/lib`` subdirectory of the sysroot directory for the target for which the current recipe is being built - (```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__). + (:term:`STAGING_DIR_HOST`). STAGING_LIBDIR_NATIVE Specifies the path to the ``/usr/lib`` subdirectory of the sysroot @@ -6671,10 +6671,10 @@ system and gives an overview of their function and contents. Tasks <&YOCTO_DOCS_OM_URL;#stamp-files-and-the-rerunning-of-tasks>`__" section in the Yocto Project Overview and Concepts Manual. - See ```STAMPS_DIR`` <#var-STAMPS_DIR>`__, - ```MULTIMACH_TARGET_SYS`` <#var-MULTIMACH_TARGET_SYS>`__, - ```PN`` <#var-PN>`__, ```EXTENDPE`` <#var-EXTENDPE>`__, - ```PV`` <#var-PV>`__, and ```PR`` <#var-PR>`__ for related variable + See :term:`STAMPS_DIR`, + :term:`MULTIMACH_TARGET_SYS`, + :term:`PN`, :term:`EXTENDPE`, + :term:`PV`, and :term:`PR` for related variable information. STAMPS_DIR @@ -6689,7 +6689,7 @@ system and gives an overview of their function and contents. The short (72 characters or less) summary of the binary package for packaging systems such as ``opkg``, ``rpm``, or ``dpkg``. By default, ``SUMMARY`` is used to define the - ```DESCRIPTION`` <#var-DESCRIPTION>`__ variable if ``DESCRIPTION`` is + :term:`DESCRIPTION` variable if ``DESCRIPTION`` is not set in the recipe. SVNDIR @@ -6702,7 +6702,7 @@ system and gives an overview of their function and contents. follows where "X" is the console number you want to use: SYSLINUX_DEFAULT_CONSOLE = "console=ttyX" - The ```syslinux`` <#ref-classes-syslinux>`__ class initially sets + The :ref:`syslinux ` class initially sets this variable to null but then checks for a value later. SYSLINUX_OPTS @@ -6710,14 +6710,14 @@ system and gives an overview of their function and contents. this variable in your recipe. If you want to list multiple options, separate the options with a semicolon character (``;``). - The ```syslinux`` <#ref-classes-syslinux>`__ class uses this variable + The :ref:`syslinux ` class uses this variable to create a set of options. SYSLINUX_SERIAL Specifies the alternate serial port or turns it off. To turn off serial, set this variable to an empty string in your recipe. The variable's default value is set in the - ```syslinux`` <#ref-classes-syslinux>`__ class as follows: + :ref:`syslinux ` class as follows: SYSLINUX_SERIAL ?= "0 115200" The class checks for and uses the variable as needed. @@ -6726,36 +6726,36 @@ system and gives an overview of their function and contents. An ``.LSS`` file used as the background for the VGA boot menu when you use the boot menu. You need to set this variable in your recipe. - The ```syslinux`` <#ref-classes-syslinux>`__ class checks for this + The :ref:`syslinux ` class checks for this variable and if found, the OpenEmbedded build system installs the splash screen. SYSLINUX_SERIAL_TTY Specifies the alternate console=tty... kernel boot argument. The variable's default value is set in the - ```syslinux`` <#ref-classes-syslinux>`__ class as follows: + :ref:`syslinux ` class as follows: SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200" The class checks for and uses the variable as needed. SYSROOT_DESTDIR Points to the temporary directory under the work directory (default - "``${``\ ```WORKDIR`` <#var-WORKDIR>`__\ ``}/sysroot-destdir``") + "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``") where the files populated into the sysroot are assembled during the - ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task. + :ref:`ref-tasks-populate_sysroot` task. SYSROOT_DIRS Directories that are staged into the sysroot by the - ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task. By + :ref:`ref-tasks-populate_sysroot` task. By default, the following directories are staged: SYSROOT_DIRS = " \\ ${includedir} \\ ${libdir} \\ ${base_libdir} \\ ${nonarch_base_libdir} \\ ${datadir} \\ " SYSROOT_DIRS_BLACKLIST Directories that are not staged into the sysroot by the - ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task. You + :ref:`ref-tasks-populate_sysroot` task. You can use this variable to exclude certain subdirectories of - directories listed in ```SYSROOT_DIRS`` <#var-SYSROOT_DIRS>`__ from + directories listed in :term:`SYSROOT_DIRS` from staging. By default, the following directories are not staged: SYSROOT_DIRS_BLACKLIST = " \\ ${mandir} \\ ${docdir} \\ ${infodir} \\ ${datadir}/locale \\ ${datadir}/applications \\ ${datadir}/fonts \\ @@ -6763,9 +6763,9 @@ system and gives an overview of their function and contents. SYSROOT_DIRS_NATIVE Extra directories staged into the sysroot by the - ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task for + :ref:`ref-tasks-populate_sysroot` task for ``-native`` recipes, in addition to those specified in - ```SYSROOT_DIRS`` <#var-SYSROOT_DIRS>`__. By default, the following + :term:`SYSROOT_DIRS`. By default, the following extra directories are staged: SYSROOT_DIRS_NATIVE = " \\ ${bindir} \\ ${sbindir} \\ ${base_bindir} \\ ${base_sbindir} \\ ${libexecdir} \\ ${sysconfdir} \\ ${localstatedir} \\ " @@ -6785,50 +6785,50 @@ system and gives an overview of their function and contents. processing on the staged files, or to stage additional files. SYSTEMD_AUTO_ENABLE - When inheriting the ```systemd`` <#ref-classes-systemd>`__ class, + When inheriting the :ref:`systemd ` class, this variable specifies whether the specified service in - ```SYSTEMD_SERVICE`` <#var-SYSTEMD_SERVICE>`__ should start + :term:`SYSTEMD_SERVICE` should start automatically or not. By default, the service is enabled to automatically start at boot time. The default setting is in the - ```systemd`` <#ref-classes-systemd>`__ class as follows: + :ref:`systemd ` class as follows: SYSTEMD_AUTO_ENABLE ??= "enable" You can disable the service by setting the variable to "disable". SYSTEMD_BOOT_CFG - When ```EFI_PROVIDER`` <#var-EFI_PROVIDER>`__ is set to + When :term:`EFI_PROVIDER` is set to "systemd-boot", the ``SYSTEMD_BOOT_CFG`` variable specifies the configuration file that should be used. By default, the - ```systemd-boot`` <#ref-classes-systemd-boot>`__ class sets the + :ref:`systemd-boot ` class sets the ``SYSTEMD_BOOT_CFG`` as follows: SYSTEMD_BOOT_CFG ?= - "${`S <#var-S>`__}/loader.conf" + "${:term:`S`}/loader.conf" For information on Systemd-boot, see the `Systemd-boot documentation `__. SYSTEMD_BOOT_ENTRIES - When ```EFI_PROVIDER`` <#var-EFI_PROVIDER>`__ is set to + When :term:`EFI_PROVIDER` is set to "systemd-boot", the ``SYSTEMD_BOOT_ENTRIES`` variable specifies a list of entry files (``*.conf``) to install that contain one boot entry per file. By default, the - ```systemd-boot`` <#ref-classes-systemd-boot>`__ class sets the + :ref:`systemd-boot ` class sets the ``SYSTEMD_BOOT_ENTRIES`` as follows: SYSTEMD_BOOT_ENTRIES ?= "" For information on Systemd-boot, see the `Systemd-boot documentation `__. SYSTEMD_BOOT_TIMEOUT - When ```EFI_PROVIDER`` <#var-EFI_PROVIDER>`__ is set to + When :term:`EFI_PROVIDER` is set to "systemd-boot", the ``SYSTEMD_BOOT_TIMEOUT`` variable specifies the boot menu timeout in seconds. By default, the - ```systemd-boot`` <#ref-classes-systemd-boot>`__ class sets the + :ref:`systemd-boot ` class sets the ``SYSTEMD_BOOT_TIMEOUT`` as follows: SYSTEMD_BOOT_TIMEOUT ?= "10" For information on Systemd-boot, see the `Systemd-boot documentation `__. SYSTEMD_PACKAGES - When inheriting the ```systemd`` <#ref-classes-systemd>`__ class, + When inheriting the :ref:`systemd ` class, this variable locates the systemd unit files when they are not found in the main recipe's package. By default, the ``SYSTEMD_PACKAGES`` variable is set such that the systemd unit files are assumed to @@ -6839,7 +6839,7 @@ system and gives an overview of their function and contents. the build system can find the systemd unit files. SYSTEMD_SERVICE - When inheriting the ```systemd`` <#ref-classes-systemd>`__ class, + When inheriting the :ref:`systemd ` class, this variable specifies the systemd service name for a package. When you specify this file in your recipe, use a package name @@ -6852,7 +6852,7 @@ system and gives an overview of their function and contents. `SysVinit <&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services>`__, specifies a space-separated list of the virtual terminals that should run a `getty `__ - (allowing login), assuming ```USE_VT`` <#var-USE_VT>`__ is not set to + (allowing login), assuming :term:`USE_VT` is not set to "0". The default value for ``SYSVINIT_ENABLED_GETTYS`` is "1" (i.e. only @@ -6864,12 +6864,12 @@ system and gives an overview of their function and contents. particular recipe. The variable is typically set as follows: T = "${WORKDIR}/temp" - The ```WORKDIR`` <#var-WORKDIR>`__ is the directory into which + The :term:`WORKDIR` is the directory into which BitBake unpacks and builds the recipe. The default ``bitbake.conf`` file sets this variable. The ``T`` variable is not to be confused with the - ```TMPDIR`` <#var-TMPDIR>`__ variable, which points to the root of + :term:`TMPDIR` variable, which points to the root of the directory tree where BitBake places the output of an entire build. @@ -6880,19 +6880,19 @@ system and gives an overview of their function and contents. configurable: arm i586 x86_64 powerpc powerpc64 mips mipsel For additional information on machine architectures, see the - ```TUNE_ARCH`` <#var-TUNE_ARCH>`__ variable. + :term:`TUNE_ARCH` variable. TARGET_AS_ARCH Specifies architecture-specific assembler flags for the target system. ``TARGET_AS_ARCH`` is initialized from - ```TUNE_ASARGS`` <#var-TUNE_ASARGS>`__ by default in the BitBake + :term:`TUNE_ASARGS` by default in the BitBake configuration file (``meta/conf/bitbake.conf``): TARGET_AS_ARCH = "${TUNE_ASARGS}" TARGET_CC_ARCH Specifies architecture-specific C compiler flags for the target system. ``TARGET_CC_ARCH`` is initialized from - ```TUNE_CCARGS`` <#var-TUNE_CCARGS>`__ by default. + :term:`TUNE_CCARGS` by default. .. note:: @@ -6908,17 +6908,17 @@ system and gives an overview of their function and contents. TARGET_CC_KERNEL_ARCH This is a specific kernel compiler flag for a CPU or Application Binary Interface (ABI) tune. The flag is used rarely and only for - cases where a userspace ```TUNE_CCARGS`` <#var-TUNE_CCARGS>`__ is not + cases where a userspace :term:`TUNE_CCARGS` is not compatible with the kernel compilation. The ``TARGET_CC_KERNEL_ARCH`` variable allows the kernel (and associated modules) to use a different configuration. See the ``meta/conf/machine/include/arm/feature-arm-thumb.inc`` file in the - `Source Directory <#source-directory>`__ for an example. + :term:`Source Directory` for an example. TARGET_CFLAGS Specifies the flags to pass to the C compiler when building for the target. When building in the target context, - ```CFLAGS`` <#var-CFLAGS>`__ is set to the value of this variable by + :term:`CFLAGS` is set to the value of this variable by default. Additionally, the SDK's environment setup script sets the ``CFLAGS`` @@ -6928,7 +6928,7 @@ system and gives an overview of their function and contents. TARGET_CPPFLAGS Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the target. When building - in the target context, ```CPPFLAGS`` <#var-CPPFLAGS>`__ is set to the + in the target context, :term:`CPPFLAGS` is set to the value of this variable by default. Additionally, the SDK's environment setup script sets the @@ -6939,7 +6939,7 @@ system and gives an overview of their function and contents. TARGET_CXXFLAGS Specifies the flags to pass to the C++ compiler when building for the target. When building in the target context, - ```CXXFLAGS`` <#var-CXXFLAGS>`__ is set to the value of this variable + :term:`CXXFLAGS` is set to the value of this variable by default. Additionally, the SDK's environment setup script sets the @@ -6956,18 +6956,18 @@ system and gives an overview of their function and contents. TARGET_LD_ARCH Specifies architecture-specific linker flags for the target system. ``TARGET_LD_ARCH`` is initialized from - ```TUNE_LDARGS`` <#var-TUNE_LDARGS>`__ by default in the BitBake + :term:`TUNE_LDARGS` by default in the BitBake configuration file (``meta/conf/bitbake.conf``): TARGET_LD_ARCH = "${TUNE_LDARGS}" TARGET_LDFLAGS Specifies the flags to pass to the linker when building for the target. When building in the target context, - ```LDFLAGS`` <#var-LDFLAGS>`__ is set to the value of this variable + :term:`LDFLAGS` is set to the value of this variable by default. Additionally, the SDK's environment setup script sets the - ```LDFLAGS`` <#var-LDFLAGS>`__ variable in the environment to the + :term:`LDFLAGS` variable in the environment to the ``TARGET_LDFLAGS`` value so that executables built using the SDK also have the flags applied. @@ -6984,7 +6984,7 @@ system and gives an overview of their function and contents. ``TARGET_PREFIX`` is set as follows: - For recipes building for the target machine, the value is - "${`TARGET_SYS <#var-TARGET_SYS>`__}-". + "${:term:`TARGET_SYS`}-". - For native recipes, the build system sets the variable to the value of ``BUILD_PREFIX``. @@ -6998,9 +6998,9 @@ system and gives an overview of their function and contents. current recipe. The OpenEmbedded build system automatically sets this variable based - on ```TARGET_ARCH`` <#var-TARGET_ARCH>`__, - ```TARGET_VENDOR`` <#var-TARGET_VENDOR>`__, and - ```TARGET_OS`` <#var-TARGET_OS>`__ variables. + on :term:`TARGET_ARCH`, + :term:`TARGET_VENDOR`, and + :term:`TARGET_OS` variables. .. note:: @@ -7028,9 +7028,9 @@ system and gives an overview of their function and contents. TCLIBCAPPEND Specifies a suffix to be appended onto the - ```TMPDIR`` <#var-TMPDIR>`__ value. The suffix identifies the + :term:`TMPDIR` value. The suffix identifies the ``libc`` variant for building. When you are building for multiple - variants with the same `Build Directory <#build-directory>`__, this + variants with the same :term:`Build Directory`, this mechanism ensures that output for different ``libc`` variants is kept separate to avoid potential conflicts. @@ -7063,7 +7063,7 @@ system and gives an overview of their function and contents. page on the Yocto Project website and click on the "RELEASE INFORMATION" link for the appropriate release. - The ``TCMODE`` variable is similar to ```TCLIBC`` <#var-TCLIBC>`__, + The ``TCMODE`` variable is similar to :term:`TCLIBC`, which controls the variant of the GNU standard C library (``libc``) used during the build process: ``glibc`` or ``musl``. @@ -7086,7 +7086,7 @@ system and gives an overview of their function and contents. TEST_EXPORT_DIR The location the OpenEmbedded build system uses to export tests when - the ```TEST_EXPORT_ONLY`` <#var-TEST_EXPORT_ONLY>`__ variable is set + the :term:`TEST_EXPORT_ONLY` variable is set to "1". The ``TEST_EXPORT_DIR`` variable defaults to @@ -7121,7 +7121,7 @@ system and gives an overview of their function and contents. TEST_POWERCONTROL_EXTRA_ARGS For automated hardware testing, specifies additional arguments to pass through to the command specified in - ```TEST_POWERCONTROL_CMD`` <#var-TEST_POWERCONTROL_CMD>`__. Setting + :term:`TEST_POWERCONTROL_CMD`. Setting ``TEST_POWERCONTROL_EXTRA_ARGS`` is optional. You can use it if you wish, for example, to separate the machine-specific and non-machine-specific parts of the arguments. @@ -7152,7 +7152,7 @@ system and gives an overview of their function and contents. TEST_SERIALCONTROL_EXTRA_ARGS For automated hardware testing, specifies additional arguments to pass through to the command specified in - ```TEST_SERIALCONTROL_CMD`` <#var-TEST_SERIALCONTROL_CMD>`__. Setting + :term:`TEST_SERIALCONTROL_CMD`. Setting ``TEST_SERIALCONTROL_EXTRA_ARGS`` is optional. You can use it if you wish, for example, to separate the machine-specific and non-machine-specific parts of the command. @@ -7195,7 +7195,7 @@ system and gives an overview of their function and contents. - *"simpleremote":* Runs the tests on target hardware that is already up and running. The hardware can be on the network or it can be a device running an image on QEMU. You must also set - ```TEST_TARGET_IP`` <#var-TEST_TARGET_IP>`__ when you use + :term:`TEST_TARGET_IP` when you use "simpleremote". .. note:: @@ -7211,7 +7211,7 @@ system and gives an overview of their function and contents. TEST_TARGET_IP The IP address of your hardware under test. The ``TEST_TARGET_IP`` - variable has no effect when ```TEST_TARGET`` <#var-TEST_TARGET>`__ is + variable has no effect when :term:`TEST_TARGET` is set to "qemu". When you specify the IP address, you can also include a port. Here is @@ -7263,14 +7263,14 @@ system and gives an overview of their function and contents. These tests are written in Python making use of the ``unittest`` module, and the majority of them run commands on the target system over ``ssh``. You can set this variable to "1" in your ``local.conf`` - file in the `Build Directory <#build-directory>`__ to have the + file in the :term:`Build Directory` to have the OpenEmbedded build system automatically run these tests after an image successfully builds: TESTIMAGE_AUTO = "1" For more information on enabling, running, and writing these tests, see the "`Performing Automated Runtime Testing <&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing>`__" section in the Yocto Project Development Tasks Manual and the - "```testimage*.bbclass`` <#ref-classes-testimage*>`__" section. + ":ref:`testimage*.bbclass `" section. THISDIR The directory in which the file BitBake is currently parsing is @@ -7285,7 +7285,7 @@ system and gives an overview of their function and contents. This variable is the base directory the OpenEmbedded build system uses for all build output and intermediate files (other than the shared state cache). By default, the ``TMPDIR`` variable points to - ``tmp`` within the `Build Directory <#build-directory>`__. + ``tmp`` within the :term:`Build Directory`. If you want to establish this directory in a location other than the default, you can uncomment and edit the following statement in the @@ -7304,7 +7304,7 @@ system and gives an overview of their function and contents. This variable lists packages the OpenEmbedded build system uses when building an SDK, which contains a cross-development environment. The packages specified by this variable are part of the toolchain set - that runs on the ```SDKMACHINE`` <#var-SDKMACHINE>`__, and each + that runs on the :term:`SDKMACHINE`, and each package should usually have the prefix ``nativesdk-``. For example, consider the following command when building an SDK: $ bitbake -c populate_sdk imagename In this case, a default list of packages is @@ -7328,8 +7328,8 @@ system and gives an overview of their function and contents. ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class sets the ``TOOLCHAIN_OUTPUTNAME`` variable as follows: TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}" See - the ```SDK_NAME`` <#var-SDK_NAME>`__ and - ```SDK_VERSION`` <#var-SDK_VERSION>`__ variables for additional + the :term:`SDK_NAME` and + :term:`SDK_VERSION` variables for additional information. TOOLCHAIN_TARGET_TASK @@ -7352,12 +7352,12 @@ system and gives an overview of their function and contents. Development Kit (eSDK) <&YOCTO_DOCS_SDK_URL;>`__ manual. TOPDIR - The top-level `Build Directory <#build-directory>`__. BitBake + The top-level :term:`Build Directory`. BitBake automatically sets this variable when you initialize your build environment using ````` <#structure-core-script>`__. TRANSLATED_TARGET_ARCH - A sanitized version of ```TARGET_ARCH`` <#var-TARGET_ARCH>`__. This + A sanitized version of :term:`TARGET_ARCH`. This variable is used where the architecture is needed in a value where underscores are not allowed, for example within package filenames. In this case, dash characters replace any underscore characters used in @@ -7379,7 +7379,7 @@ system and gives an overview of their function and contents. ``TUNE_ARCH`` specific to the ``mips`` architecture. ``TUNE_ARCH`` is tied closely to - ```TARGET_ARCH`` <#var-TARGET_ARCH>`__, which defines the target + :term:`TARGET_ARCH`, which defines the target machine's architecture. The BitBake configuration file (``meta/conf/bitbake.conf``) sets ``TARGET_ARCH`` as follows: TARGET_ARCH = "${TUNE_ARCH}" @@ -7393,7 +7393,7 @@ system and gives an overview of their function and contents. system. The set of flags is based on the selected tune features. ``TUNE_ASARGS`` is set using the tune include files, which are typically under ``meta/conf/machine/include/`` and are influenced - through ```TUNE_FEATURES`` <#var-TUNE_FEATURES>`__. For example, the + through :term:`TUNE_FEATURES`. For example, the ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags for the x86 architecture as follows: TUNE_ASARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-x32", "", d)}" @@ -7409,7 +7409,7 @@ system and gives an overview of their function and contents. system. The set of flags is based on the selected tune features. ``TUNE_CCARGS`` is set using the tune include files, which are typically under ``meta/conf/machine/include/`` and are influenced - through ```TUNE_FEATURES`` <#var-TUNE_FEATURES>`__. + through :term:`TUNE_FEATURES`. .. note:: @@ -7422,7 +7422,7 @@ system and gives an overview of their function and contents. The set of flags is based on the selected tune features. ``TUNE_LDARGS`` is set using the tune include files, which are typically under ``meta/conf/machine/include/`` and are influenced - through ```TUNE_FEATURES`` <#var-TUNE_FEATURES>`__. For example, the + through :term:`TUNE_FEATURES`. For example, the ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags for the x86 architecture as follows: TUNE_LDARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", @@ -7446,7 +7446,7 @@ system and gives an overview of their function and contents. The BitBake configuration file (``meta/conf/bitbake.conf``) defines ``TUNE_FEATURES`` as follows: TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}" See the - ```DEFAULTTUNE`` <#var-DEFAULTTUNE>`__ variable for more information. + :term:`DEFAULTTUNE` variable for more information. TUNE_PKGARCH The package architecture understood by the packaging system to define @@ -7463,34 +7463,34 @@ system and gives an overview of their function and contents. An underlying Application Binary Interface (ABI) used by a particular tuning in a given toolchain layer. Providers that use prebuilt libraries can use the ``TUNEABI``, - ```TUNEABI_OVERRIDE`` <#var-TUNEABI_OVERRIDE>`__, and - ```TUNEABI_WHITELIST`` <#var-TUNEABI_WHITELIST>`__ variables to check + :term:`TUNEABI_OVERRIDE`, and + :term:`TUNEABI_WHITELIST` variables to check compatibility of tunings against their selection of libraries. If ``TUNEABI`` is undefined, then every tuning is allowed. See the - ```sanity`` <#ref-classes-sanity>`__ class to see how the variable is + :ref:`sanity ` class to see how the variable is used. TUNEABI_OVERRIDE If set, the OpenEmbedded system ignores the - ```TUNEABI_WHITELIST`` <#var-TUNEABI_WHITELIST>`__ variable. + :term:`TUNEABI_WHITELIST` variable. Providers that use prebuilt libraries can use the ``TUNEABI_OVERRIDE``, ``TUNEABI_WHITELIST``, and - ```TUNEABI`` <#var-TUNEABI>`__ variables to check compatibility of a + :term:`TUNEABI` variables to check compatibility of a tuning against their selection of libraries. - See the ```sanity`` <#ref-classes-sanity>`__ class to see how the + See the :ref:`sanity ` class to see how the variable is used. TUNEABI_WHITELIST - A whitelist of permissible ```TUNEABI`` <#var-TUNEABI>`__ values. If + A whitelist of permissible :term:`TUNEABI` values. If ``TUNEABI_WHITELIST`` is not set, all tunes are allowed. Providers that use prebuilt libraries can use the ``TUNEABI_WHITELIST``, - ```TUNEABI_OVERRIDE`` <#var-TUNEABI_OVERRIDE>`__, and ``TUNEABI`` + :term:`TUNEABI_OVERRIDE`, and ``TUNEABI`` variables to check compatibility of a tuning against their selection of libraries. - See the ```sanity`` <#ref-classes-sanity>`__ class to see how the + See the :ref:`sanity ` class to see how the variable is used. TUNECONFLICTS[feature] @@ -7498,7 +7498,7 @@ system and gives an overview of their function and contents. that conflict with feature. Known tuning conflicts are specified in the machine include files in - the `Source Directory <#source-directory>`__. Here is an example from + the :term:`Source Directory`. Here is an example from the ``meta/conf/machine/include/mips/arch-mips.inc`` include file that lists the "o32" and "n64" features as conflicting with the "n32" feature: TUNECONFLICTS[n32] = "o32 n64" @@ -7514,8 +7514,8 @@ system and gives an overview of their function and contents. Directory <#source-directory>`__ for these features. UBOOT_CONFIG - Configures the ```UBOOT_MACHINE`` <#var-UBOOT_MACHINE>`__ and can - also define ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ for individual + Configures the :term:`UBOOT_MACHINE` and can + also define :term:`IMAGE_FSTYPES` for individual cases. Following is an example from the ``meta-fsl-arm`` layer. UBOOT_CONFIG @@ -7611,10 +7611,10 @@ system and gives an overview of their function and contents. UNKNOWN_CONFIGURE_WHITELIST Specifies a list of options that, if reported by the configure script as being invalid, should not generate a warning during the - ```do_configure`` <#ref-tasks-configure>`__ task. Normally, invalid + :ref:`ref-tasks-configure` task. Normally, invalid configure options are simply not passed to the configure script (e.g. - should be removed from ```EXTRA_OECONF`` <#var-EXTRA_OECONF>`__ or - ```PACKAGECONFIG_CONFARGS`` <#var-PACKAGECONFIG_CONFARGS>`__). + should be removed from :term:`EXTRA_OECONF` or + :term:`PACKAGECONFIG_CONFARGS`). However, common options, for example, exist that are passed to all configure scripts at a class level that might not be valid for some configure scripts. It follows that no benefit exists in seeing a @@ -7623,12 +7623,12 @@ system and gives an overview of their function and contents. The configure arguments check that uses ``UNKNOWN_CONFIGURE_WHITELIST`` is part of the - ```insane`` <#ref-classes-insane>`__ class and is only enabled if the - recipe inherits the ```autotools`` <#ref-classes-autotools>`__ class. + :ref:`insane ` class and is only enabled if the + recipe inherits the :ref:`autotools ` class. UPDATERCPN For recipes inheriting the - ```update-rc.d`` <#ref-classes-update-rc.d>`__ class, ``UPDATERCPN`` + :ref:`update-rc.d ` class, ``UPDATERCPN`` specifies the package that contains the initscript that is enabled. The default value is "${PN}". Given that almost all recipes that @@ -7651,7 +7651,7 @@ system and gives an overview of their function and contents. Use the ``UPSTREAM_CHECK_REGEX`` variable to specify a different regular expression instead of the default one when the package checking system is parsing the page found using - ```UPSTREAM_CHECK_URI`` <#var-UPSTREAM_CHECK_URI>`__. + :term:`UPSTREAM_CHECK_URI`. UPSTREAM_CHECK_REGEX = "package_regex" UPSTREAM_CHECK_URI @@ -7703,8 +7703,8 @@ system and gives an overview of their function and contents. If set to ``error``, forces the OpenEmbedded build system to produce an error if the user identification (``uid``) and group identification (``gid``) values are not defined in any of the files - listed in ```USERADD_UID_TABLES`` <#var-USERADD_UID_TABLES>`__ and - ```USERADD_GID_TABLES`` <#var-USERADD_GID_TABLES>`__. If set to + listed in :term:`USERADD_UID_TABLES` and + :term:`USERADD_GID_TABLES`. If set to ``warn``, a warning will be issued instead. The default behavior for the build system is to dynamically apply @@ -7715,9 +7715,9 @@ system and gives an overview of their function and contents. file as follows: USERADD_ERROR_DYNAMIC = "error" Overriding the default behavior implies you are going to also take steps to set static ``uid`` and ``gid`` values through use of the - ```USERADDEXTENSION`` <#var-USERADDEXTENSION>`__, - ```USERADD_UID_TABLES`` <#var-USERADD_UID_TABLES>`__, and - ```USERADD_GID_TABLES`` <#var-USERADD_GID_TABLES>`__ variables. + :term:`USERADDEXTENSION`, + :term:`USERADD_UID_TABLES`, and + :term:`USERADD_GID_TABLES` variables. .. note:: @@ -7745,7 +7745,7 @@ system and gives an overview of their function and contents. adds a group to the system during package installation. When applying static group identification (``gid``) values, the - OpenEmbedded build system looks in ```BBPATH`` <#var-BBPATH>`__ for a + OpenEmbedded build system looks in :term:`BBPATH` for a ``files/group`` file and then applies those ``uid`` values. Set the variable as follows in your ``local.conf`` file: USERADD_GID_TABLES = "files/group" @@ -7760,7 +7760,7 @@ system and gives an overview of their function and contents. values. USERADD_PACKAGES - When inheriting the ```useradd`` <#ref-classes-useradd>`__ class, + When inheriting the :ref:`useradd ` class, this variable specifies the individual packages within the recipe that require users and/or groups to be added. @@ -7781,7 +7781,7 @@ system and gives an overview of their function and contents. variables. USERADD_PARAM - When inheriting the ```useradd`` <#ref-classes-useradd>`__ class, + When inheriting the :ref:`useradd ` class, this variable specifies for a package what parameters should pass to the ``useradd`` command if you add a user to the system when the package is installed. @@ -7798,7 +7798,7 @@ system and gives an overview of their function and contents. adds a user to the system during package installation. When applying static user identification (``uid``) values, the - OpenEmbedded build system looks in ```BBPATH`` <#var-BBPATH>`__ for a + OpenEmbedded build system looks in :term:`BBPATH` for a ``files/passwd`` file and then applies those ``uid`` values. Set the variable as follows in your ``local.conf`` file: USERADD_UID_TABLES = "files/passwd" @@ -7815,7 +7815,7 @@ system and gives an overview of their function and contents. USERADDEXTENSION When set to "useradd-staticids", causes the OpenEmbedded build system to base all user and group additions on a static ``passwd`` and - ``group`` files found in ```BBPATH`` <#var-BBPATH>`__. + ``group`` files found in :term:`BBPATH`. To use static user identification (``uid``) and group identification (``gid``) values, set the variable as follows in your ``local.conf`` @@ -7833,10 +7833,10 @@ system and gives an overview of their function and contents. If you use static ``uid`` and ``gid`` information, you must also specify the ``files/passwd`` and ``files/group`` files by setting the - ```USERADD_UID_TABLES`` <#var-USERADD_UID_TABLES>`__ and - ```USERADD_GID_TABLES`` <#var-USERADD_GID_TABLES>`__ variables. + :term:`USERADD_UID_TABLES` and + :term:`USERADD_GID_TABLES` variables. Additionally, you should also set the - ```USERADD_ERROR_DYNAMIC`` <#var-USERADD_ERROR_DYNAMIC>`__ variable. + :term:`USERADD_ERROR_DYNAMIC` variable. VOLATILE_LOG_DIR Specifies the persistence of the target's ``/var/log`` directory, @@ -7851,18 +7851,18 @@ system and gives an overview of their function and contents. warnings by the OpenEmbedded build system. You set this variable in your distribution configuration file. For a list of the checks you can control with this variable, see the - "```insane.bbclass`` <#ref-classes-insane>`__" section. + ":ref:`insane.bbclass `" section. WKS_FILE_DEPENDS When placed in the recipe that builds your image, this variable lists build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only applicable when Wic images are active (i.e. when - ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ contains entries related + :term:`IMAGE_FSTYPES` contains entries related to Wic). If your recipe does not create Wic images, the variable has no effect. The ``WKS_FILE_DEPENDS`` variable is similar to the - ```DEPENDS`` <#var-DEPENDS>`__ variable. When you use the variable in + :term:`DEPENDS` variable. When you use the variable in your recipe that builds the Wic image, dependencies you list in the ``WIC_FILE_DEPENDS`` variable are added to the ``DEPENDS`` variable. @@ -7886,7 +7886,7 @@ system and gives an overview of their function and contents. WORKDIR The pathname of the work directory in which the OpenEmbedded build system builds a recipe. This directory is located within the - ```TMPDIR`` <#var-TMPDIR>`__ directory structure and is specific to + :term:`TMPDIR` directory structure and is specific to the recipe being built and the system for which it is being built. The ``WORKDIR`` directory is defined as follows: @@ -7922,7 +7922,7 @@ system and gives an overview of their function and contents. server and drivers for the current machine, assuming your image directly includes ``packagegroup-core-x11-xserver`` or, perhaps indirectly, includes "x11-base" in - ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__. + :term:`IMAGE_FEATURES`. The default value of ``XSERVER``, if not specified in the machine configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev". diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 0a8811d95d..50f2afae03 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst @@ -79,7 +79,7 @@ instructions: mailing list about OpenEmbedded. - ` <&OE_LISTS_URL;/listinfo/bitbake-devel>`__ - Discussion mailing - list about the `BitBake <#bitbake-term>`__ build tool. + list about the :term:`BitBake` build tool. - ` <&YOCTO_LISTS_URL;/listinfo/poky>`__ - Discussion mailing list about `Poky <#poky>`__. @@ -179,7 +179,7 @@ Here is a list of resources you might find helpful: - `Toaster User Manual <&YOCTO_DOCS_TOAST_URL;>`__\ *:* This manual introduces and describes how to set up and use Toaster. Toaster is an Application Programming Interface (API) and web-based interface to - the `OpenEmbedded Build System <#build-system-term>`__, which uses + the :term:`OpenEmbedded Build System`, which uses BitBake, that reports build information. - `FAQ <&YOCTO_WIKI_URL;/wiki/FAQ>`__\ *:* A list of commonly asked -- cgit v1.2.3-54-g00ecf