summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r--documentation/ref-manual/variables.rst63
1 files changed, 28 insertions, 35 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index f8c6e6db1e..dc6eccb314 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -260,9 +260,9 @@ system and gives an overview of their function and contents.
260 https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview 260 https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview
261 261
262 :term:`B` 262 :term:`B`
263 The directory within the :term:`Build Directory` in 263 The directory within the :term:`Build Directory` in which the
264 which the OpenEmbedded build system places generated objects during a 264 OpenEmbedded build system places generated objects during a recipe's
265 recipe's build process. By default, this directory is the same as the 265 build process. By default, this directory is the same as the
266 :term:`S` directory, which is defined as:: 266 :term:`S` directory, which is defined as::
267 267
268 S = "${WORKDIR}/${BP}" 268 S = "${WORKDIR}/${BP}"
@@ -903,12 +903,11 @@ system and gives an overview of their function and contents.
903 The default value is an empty string (""). 903 The default value is an empty string ("").
904 904
905 :term:`BUILDDIR` 905 :term:`BUILDDIR`
906 Points to the location of the :term:`Build Directory`. 906 Points to the location of the :term:`Build Directory`. You can define
907 You can define this directory indirectly through the 907 this directory indirectly through the :ref:`structure-core-script` script
908 :ref:`structure-core-script` script by passing in a Build 908 by passing in a :term:`Build Directory` path when you run the script. If
909 Directory path when you run the script. If you run the script and do 909 you run the script and do not provide a :term:`Build Directory` path, the
910 not provide a Build Directory path, the :term:`BUILDDIR` defaults to 910 :term:`BUILDDIR` defaults to ``build`` in the current directory.
911 ``build`` in the current directory.
912 911
913 :term:`BUILDHISTORY_COMMIT` 912 :term:`BUILDHISTORY_COMMIT`
914 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 913 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
@@ -1712,8 +1711,7 @@ system and gives an overview of their function and contents.
1712 Points to the general area that the OpenEmbedded build system uses to 1711 Points to the general area that the OpenEmbedded build system uses to
1713 place images, packages, SDKs, and other output files that are ready 1712 place images, packages, SDKs, and other output files that are ready
1714 to be used outside of the build system. By default, this directory 1713 to be used outside of the build system. By default, this directory
1715 resides within the :term:`Build Directory` as 1714 resides within the :term:`Build Directory` as ``${TMPDIR}/deploy``.
1716 ``${TMPDIR}/deploy``.
1717 1715
1718 For more information on the structure of the Build Directory, see 1716 For more information on the structure of the Build Directory, see
1719 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. 1717 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section.
@@ -1759,7 +1757,7 @@ system and gives an overview of their function and contents.
1759 with the contents of :term:`IMGDEPLOYDIR` by the :ref:`image 1757 with the contents of :term:`IMGDEPLOYDIR` by the :ref:`image
1760 <ref-classes-image>` class. 1758 <ref-classes-image>` class.
1761 1759
1762 For more information on the structure of the Build Directory, see 1760 For more information on the structure of the :term:`Build Directory`, see
1763 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. 1761 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section.
1764 For more detail on the contents of the ``deploy`` directory, see the 1762 For more detail on the contents of the ``deploy`` directory, see the
1765 ":ref:`overview-manual/concepts:images`" and 1763 ":ref:`overview-manual/concepts:images`" and
@@ -2042,8 +2040,7 @@ system and gives an overview of their function and contents.
2042 You can set this directory by defining the :term:`DL_DIR` variable in the 2040 You can set this directory by defining the :term:`DL_DIR` variable in the
2043 ``conf/local.conf`` file. This directory is self-maintaining and you 2041 ``conf/local.conf`` file. This directory is self-maintaining and you
2044 should not have to touch it. By default, the directory is 2042 should not have to touch it. By default, the directory is
2045 ``downloads`` in the :term:`Build Directory`. 2043 ``downloads`` in the :term:`Build Directory`::
2046 ::
2047 2044
2048 #DL_DIR ?= "${TOPDIR}/downloads" 2045 #DL_DIR ?= "${TOPDIR}/downloads"
2049 2046
@@ -2264,8 +2261,8 @@ system and gives an overview of their function and contents.
2264 class, this variable points to the directory in which the recipe's 2261 class, this variable points to the directory in which the recipe's
2265 source code is built, which is outside of the OpenEmbedded build 2262 source code is built, which is outside of the OpenEmbedded build
2266 system. When set, this variable sets the :term:`B` variable, 2263 system. When set, this variable sets the :term:`B` variable,
2267 which is what the OpenEmbedded build system uses to locate the Build 2264 which is what the OpenEmbedded build system uses to locate the
2268 Directory. 2265 :term:`Build Directory`.
2269 2266
2270 See the ":ref:`ref-classes-externalsrc`" section for details. You 2267 See the ":ref:`ref-classes-externalsrc`" section for details. You
2271 can also find information on how to use this variable in the 2268 can also find information on how to use this variable in the
@@ -2285,9 +2282,8 @@ system and gives an overview of their function and contents.
2285 more than one feature, separate them with a space. 2282 more than one feature, separate them with a space.
2286 2283
2287 Typically, you configure this variable in your ``local.conf`` file, 2284 Typically, you configure this variable in your ``local.conf`` file,
2288 which is found in the :term:`Build Directory`. 2285 which is found in the :term:`Build Directory`. Although you can use this
2289 Although you can use this variable from within a recipe, best 2286 variable from within a recipe, best practices dictate that you do not.
2290 practices dictate that you do not.
2291 2287
2292 .. note:: 2288 .. note::
2293 2289
@@ -2684,10 +2680,9 @@ system and gives an overview of their function and contents.
2684 2680
2685 You define the :term:`FILESYSTEM_PERMS_TABLES` variable in the 2681 You define the :term:`FILESYSTEM_PERMS_TABLES` variable in the
2686 ``conf/local.conf`` file, which is found in the :term:`Build Directory`, 2682 ``conf/local.conf`` file, which is found in the :term:`Build Directory`,
2687 to point to your custom 2683 to point to your custom ``fs-perms.txt``. You can specify more than a
2688 ``fs-perms.txt``. You can specify more than a single file permissions 2684 single file permissions setting table. The paths you specify to these
2689 setting table. The paths you specify to these files must be defined 2685 files must be defined within the :term:`BBPATH` variable.
2690 within the :term:`BBPATH` variable.
2691 2686
2692 For guidance on how to create your own file permissions settings 2687 For guidance on how to create your own file permissions settings
2693 table file, examine the existing ``fs-perms.txt``. 2688 table file, examine the existing ``fs-perms.txt``.
@@ -6747,7 +6742,7 @@ system and gives an overview of their function and contents.
6747 to find the unpacked source. 6742 to find the unpacked source.
6748 6743
6749 As an example, assume a :term:`Source Directory` 6744 As an example, assume a :term:`Source Directory`
6750 top-level folder named ``poky`` and a default Build Directory at 6745 top-level folder named ``poky`` and a default :term:`Build Directory` at
6751 ``poky/build``. In this case, the work directory the build system 6746 ``poky/build``. In this case, the work directory the build system
6752 uses to keep the unpacked recipe for ``db`` is the following:: 6747 uses to keep the unpacked recipe for ``db`` is the following::
6753 6748
@@ -6792,7 +6787,7 @@ system and gives an overview of their function and contents.
6792 6787
6793 :term:`SDK_CUSTOM_TEMPLATECONF` 6788 :term:`SDK_CUSTOM_TEMPLATECONF`
6794 When building the extensible SDK, if :term:`SDK_CUSTOM_TEMPLATECONF` is set to 6789 When building the extensible SDK, if :term:`SDK_CUSTOM_TEMPLATECONF` is set to
6795 "1" and a ``conf/templateconf.cfg`` file exists in the build directory 6790 "1" and a ``conf/templateconf.cfg`` file exists in the :term:`Build Directory`
6796 (:term:`TOPDIR`) then this will be copied into the SDK. 6791 (:term:`TOPDIR`) then this will be copied into the SDK.
6797 6792
6798 :term:`SDK_DEPLOY` 6793 :term:`SDK_DEPLOY`
@@ -7195,8 +7190,7 @@ system and gives an overview of their function and contents.
7195 7190
7196 To enable file removal, set the variable to "1" in your 7191 To enable file removal, set the variable to "1" in your
7197 ``conf/local.conf`` configuration file in your: 7192 ``conf/local.conf`` configuration file in your:
7198 :term:`Build Directory`. 7193 :term:`Build Directory`::
7199 ::
7200 7194
7201 SKIP_FILEDEPS = "1" 7195 SKIP_FILEDEPS = "1"
7202 7196
@@ -8126,12 +8120,11 @@ system and gives an overview of their function and contents.
8126 You can select "glibc", "musl", "newlib", or "baremetal". 8120 You can select "glibc", "musl", "newlib", or "baremetal".
8127 8121
8128 :term:`TCLIBCAPPEND` 8122 :term:`TCLIBCAPPEND`
8129 Specifies a suffix to be appended onto the 8123 Specifies a suffix to be appended onto the :term:`TMPDIR` value. The
8130 :term:`TMPDIR` value. The suffix identifies the 8124 suffix identifies the ``libc`` variant for building. When you are
8131 ``libc`` variant for building. When you are building for multiple 8125 building for multiple variants with the same :term:`Build Directory`,
8132 variants with the same :term:`Build Directory`, this 8126 this mechanism ensures that output for different ``libc`` variants is
8133 mechanism ensures that output for different ``libc`` variants is kept 8127 kept separate to avoid potential conflicts.
8134 separate to avoid potential conflicts.
8135 8128
8136 In the ``defaultsetup.conf`` file, the default value of 8129 In the ``defaultsetup.conf`` file, the default value of
8137 :term:`TCLIBCAPPEND` is "-${TCLIBC}". However, distros such as poky, 8130 :term:`TCLIBCAPPEND` is "-${TCLIBC}". However, distros such as poky,
@@ -8419,7 +8412,7 @@ system and gives an overview of their function and contents.
8419 #TMPDIR = "${TOPDIR}/tmp" 8412 #TMPDIR = "${TOPDIR}/tmp"
8420 8413
8421 An example use for this scenario is to set :term:`TMPDIR` to a local disk, 8414 An example use for this scenario is to set :term:`TMPDIR` to a local disk,
8422 which does not use NFS, while having the Build Directory use NFS. 8415 which does not use NFS, while having the :term:`Build Directory` use NFS.
8423 8416
8424 The filesystem used by :term:`TMPDIR` must have standard filesystem 8417 The filesystem used by :term:`TMPDIR` must have standard filesystem
8425 semantics (i.e. mixed-case files are unique, POSIX file locking, and 8418 semantics (i.e. mixed-case files are unique, POSIX file locking, and
@@ -9105,7 +9098,7 @@ system and gives an overview of their function and contents.
9105 - :term:`PR`: The recipe revision 9098 - :term:`PR`: The recipe revision
9106 9099
9107 As an example, assume a Source Directory top-level folder name 9100 As an example, assume a Source Directory top-level folder name
9108 ``poky``, a default Build Directory at ``poky/build``, and a 9101 ``poky``, a default :term:`Build Directory` at ``poky/build``, and a
9109 ``qemux86-poky-linux`` machine target system. Furthermore, suppose 9102 ``qemux86-poky-linux`` machine target system. Furthermore, suppose
9110 your recipe is named ``foo_1.3.0-r0.bb``. In this case, the work 9103 your recipe is named ``foo_1.3.0-r0.bb``. In this case, the work
9111 directory the build system uses to build the package would be as 9104 directory the build system uses to build the package would be as