summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/ref-variables.rst')
-rw-r--r--documentation/ref-manual/ref-variables.rst74
1 files changed, 37 insertions, 37 deletions
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 56aeb583ac..b24e1fa39e 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -746,7 +746,7 @@ system and gives an overview of their function and contents.
746 746
747 For information on how to use ``BBMULTICONFIG`` in an environment 747 For information on how to use ``BBMULTICONFIG`` in an environment
748 that supports building targets with multiple configurations, see the 748 that supports building targets with multiple configurations, see the
749 ":ref:`dev-building-images-for-multiple-targets-using-multiple-configurations`" 749 ":ref:`dev-manual/dev-manual-common-tasks:building images for multiple targets using multiple configurations`"
750 section in the Yocto Project Development Tasks Manual. 750 section in the Yocto Project Development Tasks Manual.
751 751
752 :term:`BBPATH` 752 :term:`BBPATH`
@@ -1299,7 +1299,7 @@ system and gives an overview of their function and contents.
1299 will be the aggregate of all of them. 1299 will be the aggregate of all of them.
1300 1300
1301 For information on creating an initramfs, see the 1301 For information on creating an initramfs, see the
1302 ":ref:`building-an-initramfs-image`" section 1302 ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section
1303 in the Yocto Project Development Tasks Manual. 1303 in the Yocto Project Development Tasks Manual.
1304 1304
1305 :term:`CONFIG_SITE` 1305 :term:`CONFIG_SITE`
@@ -1672,9 +1672,9 @@ system and gives an overview of their function and contents.
1672 For more information on the structure of the Build Directory, see 1672 For more information on the structure of the Build Directory, see
1673 ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section. 1673 ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section.
1674 For more detail on the contents of the ``deploy`` directory, see the 1674 For more detail on the contents of the ``deploy`` directory, see the
1675 ":ref:`Images <images-dev-environment>`", ":ref:`Package 1675 ":ref:`overview-manual/overview-manual-concepts:images`",
1676 Feeds <package-feeds-dev-environment>`", and 1676 ":ref:`overview-manual/overview-manual-concepts:package feeds`", and
1677 ":ref:`sdk-dev-environment`" sections all in the 1677 ":ref:`overview-manual/overview-manual-concepts:application development sdk`" sections all in the
1678 Yocto Project Overview and Concepts Manual. 1678 Yocto Project Overview and Concepts Manual.
1679 1679
1680 :term:`DEPLOY_DIR_DEB` 1680 :term:`DEPLOY_DIR_DEB`
@@ -1695,8 +1695,8 @@ system and gives an overview of their function and contents.
1695 ``DEPLOY_DIR_DEB`` variable to make sure the 1695 ``DEPLOY_DIR_DEB`` variable to make sure the
1696 :ref:`ref-tasks-package_write_deb` task 1696 :ref:`ref-tasks-package_write_deb` task
1697 writes Debian packages into the appropriate folder. For more 1697 writes Debian packages into the appropriate folder. For more
1698 information on how packaging works, see the ":ref:`Package 1698 information on how packaging works, see the
1699 Feeds <package-feeds-dev-environment>`" section 1699 ":ref:`overview-manual/overview-manual-concepts:package feeds`" section
1700 in the Yocto Project Overview and Concepts Manual. 1700 in the Yocto Project Overview and Concepts Manual.
1701 1701
1702 :term:`DEPLOY_DIR_IMAGE` 1702 :term:`DEPLOY_DIR_IMAGE`
@@ -1710,8 +1710,8 @@ system and gives an overview of their function and contents.
1710 For more information on the structure of the Build Directory, see 1710 For more information on the structure of the Build Directory, see
1711 ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section. 1711 ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section.
1712 For more detail on the contents of the ``deploy`` directory, see the 1712 For more detail on the contents of the ``deploy`` directory, see the
1713 ":ref:`Images <images-dev-environment>`" and 1713 ":ref:`overview-manual/overview-manual-concepts:images`" and
1714 ":ref:`sdk-dev-environment`" sections both in 1714 ":ref:`overview-manual/overview-manual-concepts:application development sdk`" sections both in
1715 the Yocto Project Overview and Concepts Manual. 1715 the Yocto Project Overview and Concepts Manual.
1716 1716
1717 :term:`DEPLOY_DIR_IPK` 1717 :term:`DEPLOY_DIR_IPK`
@@ -1731,8 +1731,8 @@ system and gives an overview of their function and contents.
1731 ``DEPLOY_DIR_IPK`` variable to make sure the 1731 ``DEPLOY_DIR_IPK`` variable to make sure the
1732 :ref:`ref-tasks-package_write_ipk` task 1732 :ref:`ref-tasks-package_write_ipk` task
1733 writes IPK packages into the appropriate folder. For more information 1733 writes IPK packages into the appropriate folder. For more information
1734 on how packaging works, see the ":ref:`Package 1734 on how packaging works, see the
1735 Feeds <package-feeds-dev-environment>`" section 1735 ":ref:`overview-manual/overview-manual-concepts:package feeds`" section
1736 in the Yocto Project Overview and Concepts Manual. 1736 in the Yocto Project Overview and Concepts Manual.
1737 1737
1738 :term:`DEPLOY_DIR_RPM` 1738 :term:`DEPLOY_DIR_RPM`
@@ -1752,8 +1752,8 @@ system and gives an overview of their function and contents.
1752 ``DEPLOY_DIR_RPM`` variable to make sure the 1752 ``DEPLOY_DIR_RPM`` variable to make sure the
1753 :ref:`ref-tasks-package_write_rpm` task 1753 :ref:`ref-tasks-package_write_rpm` task
1754 writes RPM packages into the appropriate folder. For more information 1754 writes RPM packages into the appropriate folder. For more information
1755 on how packaging works, see the ":ref:`Package 1755 on how packaging works, see the
1756 Feeds <package-feeds-dev-environment>`" section 1756 ":ref:`overview-manual/overview-manual-concepts:package feeds`" section
1757 in the Yocto Project Overview and Concepts Manual. 1757 in the Yocto Project Overview and Concepts Manual.
1758 1758
1759 :term:`DEPLOY_DIR_TAR` 1759 :term:`DEPLOY_DIR_TAR`
@@ -1773,8 +1773,8 @@ system and gives an overview of their function and contents.
1773 ``DEPLOY_DIR_TAR`` variable to make sure the 1773 ``DEPLOY_DIR_TAR`` variable to make sure the
1774 :ref:`ref-tasks-package_write_tar` task 1774 :ref:`ref-tasks-package_write_tar` task
1775 writes TAR packages into the appropriate folder. For more information 1775 writes TAR packages into the appropriate folder. For more information
1776 on how packaging works, see the ":ref:`Package 1776 on how packaging works, see the
1777 Feeds <package-feeds-dev-environment>`" section 1777 ":ref:`overview-manual/overview-manual-concepts:package feeds`" section
1778 in the Yocto Project Overview and Concepts Manual. 1778 in the Yocto Project Overview and Concepts Manual.
1779 1779
1780 :term:`DEPLOYDIR` 1780 :term:`DEPLOYDIR`
@@ -2194,7 +2194,7 @@ system and gives an overview of their function and contents.
2194 Project, see the ":ref:`ref-features-image`" section. 2194 Project, see the ":ref:`ref-features-image`" section.
2195 2195
2196 For an example that shows how to customize your image by using this 2196 For an example that shows how to customize your image by using this
2197 variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" 2197 variable, see the ":ref:`dev-manual/dev-manual-common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``"
2198 section in the Yocto Project Development Tasks Manual. 2198 section in the Yocto Project Development Tasks Manual.
2199 2199
2200 :term:`EXTRA_IMAGECMD` 2200 :term:`EXTRA_IMAGECMD`
@@ -2509,9 +2509,9 @@ system and gives an overview of their function and contents.
2509 build system uses files from ``files/defconfig``. 2509 build system uses files from ``files/defconfig``.
2510 2510
2511 You can find out more about the patching process in the 2511 You can find out more about the patching process in the
2512 ":ref:`patching-dev-environment`" section 2512 ":ref:`overview-manual/overview-manual-concepts:patching`" section
2513 in the Yocto Project Overview and Concepts Manual and the 2513 in the Yocto Project Overview and Concepts Manual and the
2514 ":ref:`new-recipe-patching-code`" section in 2514 ":ref:`dev-manual/dev-manual-common-tasks:patching code`" section in
2515 the Yocto Project Development Tasks Manual. See the 2515 the Yocto Project Development Tasks Manual. See the
2516 :ref:`ref-tasks-patch` task as well. 2516 :ref:`ref-tasks-patch` task as well.
2517 2517
@@ -3000,7 +3000,7 @@ system and gives an overview of their function and contents.
3000 the ":ref:`ref-features-image`" section. 3000 the ":ref:`ref-features-image`" section.
3001 3001
3002 For an example that shows how to customize your image by using this 3002 For an example that shows how to customize your image by using this
3003 variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" 3003 variable, see the ":ref:`dev-manual/dev-manual-common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``"
3004 section in the Yocto Project Development Tasks Manual. 3004 section in the Yocto Project Development Tasks Manual.
3005 3005
3006 :term:`IMAGE_FSTYPES` 3006 :term:`IMAGE_FSTYPES`
@@ -3058,7 +3058,7 @@ system and gives an overview of their function and contents.
3058 allows the initial RAM filesystem (initramfs) recipe to use a 3058 allows the initial RAM filesystem (initramfs) recipe to use a
3059 fixed set of packages and not be affected by ``IMAGE_INSTALL``. 3059 fixed set of packages and not be affected by ``IMAGE_INSTALL``.
3060 For information on creating an initramfs, see the 3060 For information on creating an initramfs, see the
3061 ":ref:`building-an-initramfs-image`" 3061 ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`"
3062 section in the Yocto Project Development Tasks Manual. 3062 section in the Yocto Project Development Tasks Manual.
3063 3063
3064 - Using ``IMAGE_INSTALL`` with the 3064 - Using ``IMAGE_INSTALL`` with the
@@ -3126,7 +3126,7 @@ system and gives an overview of their function and contents.
3126 The location is 3126 The location is
3127 derived using the :term:`DEPLOY_DIR_IMAGE` 3127 derived using the :term:`DEPLOY_DIR_IMAGE`
3128 and :term:`IMAGE_NAME` variables. You can find 3128 and :term:`IMAGE_NAME` variables. You can find
3129 information on how the image is created in the ":ref:`image-generation-dev-environment`" 3129 information on how the image is created in the ":ref:`overview-manual/overview-manual-concepts:image generation`"
3130 section in the Yocto Project Overview and Concepts Manual. 3130 section in the Yocto Project Overview and Concepts Manual.
3131 3131
3132 :term:`IMAGE_NAME` 3132 :term:`IMAGE_NAME`
@@ -3554,7 +3554,7 @@ system and gives an overview of their function and contents.
3554 :term:`INITRAMFS_IMAGE_BUNDLE` 3554 :term:`INITRAMFS_IMAGE_BUNDLE`
3555 variable, which allows the generated image to be bundled inside the 3555 variable, which allows the generated image to be bundled inside the
3556 kernel image. Additionally, for information on creating an initramfs 3556 kernel image. Additionally, for information on creating an initramfs
3557 image, see the ":ref:`building-an-initramfs-image`" section 3557 image, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section
3558 in the Yocto Project Development Tasks Manual. 3558 in the Yocto Project Development Tasks Manual.
3559 3559
3560 :term:`INITRAMFS_IMAGE_BUNDLE` 3560 :term:`INITRAMFS_IMAGE_BUNDLE`
@@ -3602,7 +3602,7 @@ system and gives an overview of their function and contents.
3602 See the 3602 See the
3603 :yocto_git:`local.conf.sample.extended </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>` 3603 :yocto_git:`local.conf.sample.extended </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>`
3604 file for additional information. Also, for information on creating an 3604 file for additional information. Also, for information on creating an
3605 initramfs, see the ":ref:`building-an-initramfs-image`" section 3605 initramfs, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section
3606 in the Yocto Project Development Tasks Manual. 3606 in the Yocto Project Development Tasks Manual.
3607 3607
3608 :term:`INITRAMFS_LINK_NAME` 3608 :term:`INITRAMFS_LINK_NAME`
@@ -4240,7 +4240,7 @@ system and gives an overview of their function and contents.
4240 This variable must be defined for all recipes (unless 4240 This variable must be defined for all recipes (unless
4241 :term:`LICENSE` is set to "CLOSED"). 4241 :term:`LICENSE` is set to "CLOSED").
4242 4242
4243 For more information, see the ":ref:`usingpoky-configuring-lic_files_chksum`" 4243 For more information, see the ":ref:`dev-manual/dev-manual-common-tasks:tracking license changes`"
4244 section in the Yocto Project Development Tasks Manual. 4244 section in the Yocto Project Development Tasks Manual.
4245 4245
4246 :term:`LICENSE` 4246 :term:`LICENSE`
@@ -4890,7 +4890,7 @@ system and gives an overview of their function and contents.
4890 Controls how the OpenEmbedded build system spawns interactive 4890 Controls how the OpenEmbedded build system spawns interactive
4891 terminals on the host development system (e.g. using the BitBake 4891 terminals on the host development system (e.g. using the BitBake
4892 command with the ``-c devshell`` command-line option). For more 4892 command with the ``-c devshell`` command-line option). For more
4893 information, see the ":ref:`platdev-appdev-devshell`" section in 4893 information, see the ":ref:`dev-manual/dev-manual-common-tasks:using a development shell`" section in
4894 the Yocto Project Development Tasks Manual. 4894 the Yocto Project Development Tasks Manual.
4895 4895
4896 You can use the following values for the ``OE_TERMINAL`` variable: 4896 You can use the following values for the ``OE_TERMINAL`` variable:
@@ -4959,7 +4959,7 @@ system and gives an overview of their function and contents.
4959 4959
4960 An easy way to see what overrides apply is to search for ``OVERRIDES`` 4960 An easy way to see what overrides apply is to search for ``OVERRIDES``
4961 in the output of the ``bitbake -e`` command. See the 4961 in the output of the ``bitbake -e`` command. See the
4962 ":ref:`dev-debugging-viewing-variable-values`" section in the Yocto 4962 ":ref:`dev-manual/dev-manual-common-tasks:viewing variable values`" section in the Yocto
4963 Project Development Tasks Manual for more information. 4963 Project Development Tasks Manual for more information.
4964 4964
4965 :term:`P` 4965 :term:`P`
@@ -5079,7 +5079,7 @@ system and gives an overview of their function and contents.
5079 separate ``*-src`` pkg. This is the default behavior. 5079 separate ``*-src`` pkg. This is the default behavior.
5080 5080
5081 You can find out more about debugging using GDB by reading the 5081 You can find out more about debugging using GDB by reading the
5082 ":ref:`platdev-gdb-remotedebug`" section 5082 ":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section
5083 in the Yocto Project Development Tasks Manual. 5083 in the Yocto Project Development Tasks Manual.
5084 5084
5085 :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` 5085 :term:`PACKAGE_EXCLUDE_COMPLEMENTARY`
@@ -5243,7 +5243,7 @@ system and gives an overview of their function and contents.
5243 the :ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>` 5243 the :ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>`
5244 image. When working with an initial RAM filesystem (initramfs) image, 5244 image. When working with an initial RAM filesystem (initramfs) image,
5245 use the ``PACKAGE_INSTALL`` variable. For information on creating an 5245 use the ``PACKAGE_INSTALL`` variable. For information on creating an
5246 initramfs, see the ":ref:`building-an-initramfs-image`" section 5246 initramfs, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section
5247 in the Yocto Project Development Tasks Manual. 5247 in the Yocto Project Development Tasks Manual.
5248 5248
5249 :term:`PACKAGE_INSTALL_ATTEMPTONLY` 5249 :term:`PACKAGE_INSTALL_ATTEMPTONLY`
@@ -5691,7 +5691,7 @@ system and gives an overview of their function and contents.
5691 5691
5692 The OpenEmbedded build system does not need the aid of ``PR`` 5692 The OpenEmbedded build system does not need the aid of ``PR``
5693 to know when to rebuild a recipe. The build system uses the task 5693 to know when to rebuild a recipe. The build system uses the task
5694 :ref:`input checksums <overview-checksums>` along with the 5694 :ref:`input checksums <overview-manual/overview-manual-concepts:checksums (signatures)>` along with the
5695 :ref:`stamp <structure-build-tmp-stamps>` and 5695 :ref:`stamp <structure-build-tmp-stamps>` and
5696 :ref:`overview-manual/overview-manual-concepts:shared state cache` 5696 :ref:`overview-manual/overview-manual-concepts:shared state cache`
5697 mechanisms. 5697 mechanisms.
@@ -5738,7 +5738,7 @@ system and gives an overview of their function and contents.
5738 PREFERRED_PROVIDER_virtual/libgl ?= "mesa" 5738 PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
5739 5739
5740 For more 5740 For more
5741 information, see the ":ref:`metadata-virtual-providers`" 5741 information, see the ":ref:`dev-manual/dev-manual-common-tasks:using virtual providers`"
5742 section in the Yocto Project Development Tasks Manual. 5742 section in the Yocto Project Development Tasks Manual.
5743 5743
5744 .. note:: 5744 .. note::
@@ -7023,7 +7023,7 @@ system and gives an overview of their function and contents.
7023 7023
7024 - ``file://`` - Fetches files, which are usually files shipped 7024 - ``file://`` - Fetches files, which are usually files shipped
7025 with the :term:`Metadata`, from the local machine (e.g. 7025 with the :term:`Metadata`, from the local machine (e.g.
7026 :ref:`patch <patching-dev-environment>` files). 7026 :ref:`patch <overview-manual/overview-manual-concepts:patching>` files).
7027 The path is relative to the :term:`FILESPATH` 7027 The path is relative to the :term:`FILESPATH`
7028 variable. Thus, the build system searches, in order, from the 7028 variable. Thus, the build system searches, in order, from the
7029 following directories, which are assumed to be a subdirectories of 7029 following directories, which are assumed to be a subdirectories of
@@ -7200,7 +7200,7 @@ system and gives an overview of their function and contents.
7200 For information on limitations when inheriting the latest revision 7200 For information on limitations when inheriting the latest revision
7201 of software using ``SRCREV``, see the :term:`AUTOREV` variable 7201 of software using ``SRCREV``, see the :term:`AUTOREV` variable
7202 description and the 7202 description and the
7203 ":ref:`automatically-incrementing-a-binary-package-revision-number`" 7203 ":ref:`dev-manual/dev-manual-common-tasks:automatically incrementing a package version number`"
7204 section, which is in the Yocto Project Development Tasks Manual. 7204 section, which is in the Yocto Project Development Tasks Manual.
7205 7205
7206 :term:`SSTATE_DIR` 7206 :term:`SSTATE_DIR`
@@ -7316,7 +7316,7 @@ system and gives an overview of their function and contents.
7316 see the :ref:`ref-tasks-populate_sysroot` 7316 see the :ref:`ref-tasks-populate_sysroot`
7317 task, the ":ref:`sdk-manual/sdk-extensible:sharing files between recipes`" 7317 task, the ":ref:`sdk-manual/sdk-extensible:sharing files between recipes`"
7318 section in the Yocto Project Development Tasks Manual, the 7318 section in the Yocto Project Development Tasks Manual, the
7319 ":ref:`configuration-compilation-and-staging-dev-environment`" 7319 ":ref:`overview-manual/overview-manual-concepts:configuration, compilation, and staging`"
7320 section in the Yocto Project Overview and Concepts Manual, and the 7320 section in the Yocto Project Overview and Concepts Manual, and the
7321 :term:`SYSROOT_DIRS` variable. 7321 :term:`SYSROOT_DIRS` variable.
7322 7322
@@ -8042,7 +8042,7 @@ system and gives an overview of their function and contents.
8042 You can provide the following arguments with ``TEST_TARGET``: 8042 You can provide the following arguments with ``TEST_TARGET``:
8043 8043
8044 - *"qemu":* Boots a QEMU image and runs the tests. See the 8044 - *"qemu":* Boots a QEMU image and runs the tests. See the
8045 ":ref:`qemu-image-enabling-tests`" section 8045 ":ref:`dev-manual/dev-manual-common-tasks:enabling runtime tests on qemu`" section
8046 in the Yocto Project Development Tasks Manual for more 8046 in the Yocto Project Development Tasks Manual for more
8047 information. 8047 information.
8048 8048
@@ -8058,7 +8058,7 @@ system and gives an overview of their function and contents.
8058 ``meta/lib/oeqa/controllers/simpleremote.py``. 8058 ``meta/lib/oeqa/controllers/simpleremote.py``.
8059 8059
8060 For information on running tests on hardware, see the 8060 For information on running tests on hardware, see the
8061 ":ref:`hardware-image-enabling-tests`" 8061 ":ref:`dev-manual/dev-manual-common-tasks:enabling runtime tests on hardware`"
8062 section in the Yocto Project Development Tasks Manual. 8062 section in the Yocto Project Development Tasks Manual.
8063 8063
8064 :term:`TEST_TARGET_IP` 8064 :term:`TEST_TARGET_IP`
@@ -8554,13 +8554,13 @@ system and gives an overview of their function and contents.
8554 specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a 8554 specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a
8555 statically populated ``/dev`` directory. 8555 statically populated ``/dev`` directory.
8556 8556
8557 See the ":ref:`selecting-dev-manager`" section in 8557 See the ":ref:`dev-manual/dev-manual-common-tasks:selecting a device manager`" section in
8558 the Yocto Project Development Tasks Manual for information on how to 8558 the Yocto Project Development Tasks Manual for information on how to
8559 use this variable. 8559 use this variable.
8560 8560
8561 :term:`USE_VT` 8561 :term:`USE_VT`
8562 When using 8562 When using
8563 :ref:`SysVinit <new-recipe-enabling-system-services>`, 8563 :ref:`SysVinit <dev-manual/dev-manual-common-tasks:enabling system services>`,
8564 determines whether or not to run a 8564 determines whether or not to run a
8565 `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any 8565 `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any
8566 virtual terminals in order to enable logging in through those 8566 virtual terminals in order to enable logging in through those