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.rst690
1 files changed, 322 insertions, 368 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 5f5fea344e..f2decd713b 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -126,7 +126,7 @@ system and gives an overview of their function and contents.
126 ":ref:`ref-classes-update-alternatives`" section. 126 ":ref:`ref-classes-update-alternatives`" section.
127 127
128 :term:`ANY_OF_DISTRO_FEATURES` 128 :term:`ANY_OF_DISTRO_FEATURES`
129 When inheriting the :ref:`features_check <ref-classes-features_check>` 129 When inheriting the :ref:`ref-classes-features_check`
130 class, this variable identifies a list of distribution features where 130 class, this variable identifies a list of distribution features where
131 at least one must be enabled in the current configuration in order 131 at least one must be enabled in the current configuration in order
132 for the OpenEmbedded build system to build the recipe. In other words, 132 for the OpenEmbedded build system to build the recipe. In other words,
@@ -139,14 +139,14 @@ system and gives an overview of their function and contents.
139 An override list of append strings for each target specified with 139 An override list of append strings for each target specified with
140 :term:`LABELS`. 140 :term:`LABELS`.
141 141
142 See the :ref:`grub-efi <ref-classes-grub-efi>` class for more 142 See the :ref:`ref-classes-grub-efi` class for more
143 information on how this variable is used. 143 information on how this variable is used.
144 144
145 :term:`AR` 145 :term:`AR`
146 The minimal command and arguments used to run ``ar``. 146 The minimal command and arguments used to run ``ar``.
147 147
148 :term:`ARCHIVER_MODE` 148 :term:`ARCHIVER_MODE`
149 When used with the :ref:`archiver <ref-classes-archiver>` class, 149 When used with the :ref:`ref-classes-archiver` class,
150 determines the type of information used to create a released archive. 150 determines the type of information used to create a released archive.
151 You can use this variable to create archives of patched source, 151 You can use this variable to create archives of patched source,
152 original source, configured source, and so forth by employing the 152 original source, configured source, and so forth by employing the
@@ -197,13 +197,13 @@ system and gives an overview of their function and contents.
197 order to send patches and forward bugs. 197 order to send patches and forward bugs.
198 198
199 :term:`AUTO_LIBNAME_PKGS` 199 :term:`AUTO_LIBNAME_PKGS`
200 When the :ref:`debian <ref-classes-debian>` class is inherited, 200 When the :ref:`ref-classes-debian` class is inherited,
201 which is the default behavior, :term:`AUTO_LIBNAME_PKGS` specifies which 201 which is the default behavior, :term:`AUTO_LIBNAME_PKGS` specifies which
202 packages should be checked for libraries and renamed according to 202 packages should be checked for libraries and renamed according to
203 Debian library package naming. 203 Debian library package naming.
204 204
205 The default value is "${PACKAGES}", which causes the 205 The default value is "${PACKAGES}", which causes the
206 :ref:`debian <ref-classes-debian>` class to act on all packages that are 206 :ref:`ref-classes-debian` class to act on all packages that are
207 explicitly generated by the recipe. 207 explicitly generated by the recipe.
208 208
209 :term:`AUTOREV` 209 :term:`AUTOREV`
@@ -215,7 +215,7 @@ system and gives an overview of their function and contents.
215 If you use the previous statement to retrieve the latest version of 215 If you use the previous statement to retrieve the latest version of
216 software, you need to be sure :term:`PV` contains 216 software, you need to be sure :term:`PV` contains
217 ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you have a kernel 217 ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you have a kernel
218 recipe that inherits the :ref:`kernel <ref-classes-kernel>` class and you 218 recipe that inherits the :ref:`ref-classes-kernel` class and you
219 use the previous statement. In this example, ``${SRCPV}`` does not 219 use the previous statement. In this example, ``${SRCPV}`` does not
220 automatically get into :term:`PV`. Consequently, you need to change 220 automatically get into :term:`PV`. Consequently, you need to change
221 :term:`PV` in your recipe so that it does contain ``${SRCPV}``. 221 :term:`PV` in your recipe so that it does contain ``${SRCPV}``.
@@ -227,7 +227,7 @@ system and gives an overview of their function and contents.
227 :term:`AUTO_SYSLINUXMENU` 227 :term:`AUTO_SYSLINUXMENU`
228 Enables creating an automatic menu for the syslinux bootloader. You 228 Enables creating an automatic menu for the syslinux bootloader. You
229 must set this variable in your recipe. The 229 must set this variable in your recipe. The
230 :ref:`syslinux <ref-classes-syslinux>` class checks this variable. 230 :ref:`ref-classes-syslinux` class checks this variable.
231 231
232 :term:`AVAILTUNES` 232 :term:`AVAILTUNES`
233 The list of defined CPU and Application Binary Interface (ABI) 233 The list of defined CPU and Application Binary Interface (ABI)
@@ -701,7 +701,7 @@ system and gives an overview of their function and contents.
701 ``quilt-native``, which is a copy of Quilt built to run on the build 701 ``quilt-native``, which is a copy of Quilt built to run on the build
702 system; "crosses" such as ``gcc-cross``, which is a compiler built to 702 system; "crosses" such as ``gcc-cross``, which is a compiler built to
703 run on the build machine but produces binaries that run on the target 703 run on the build machine but produces binaries that run on the target
704 :term:`MACHINE`; ":ref:`nativesdk <ref-classes-nativesdk>`", which 704 :term:`MACHINE`; ":ref:`ref-classes-nativesdk`", which
705 targets the SDK machine instead of :term:`MACHINE`; and "mulitlibs" in 705 targets the SDK machine instead of :term:`MACHINE`; and "mulitlibs" in
706 the form "``multilib:``\ multilib_name". 706 the form "``multilib:``\ multilib_name".
707 707
@@ -909,13 +909,12 @@ system and gives an overview of their function and contents.
909 See :term:`bitbake:BBTARGETS` in the BitBake manual. 909 See :term:`bitbake:BBTARGETS` in the BitBake manual.
910 910
911 :term:`BINCONFIG` 911 :term:`BINCONFIG`
912 When inheriting the 912 When inheriting the :ref:`ref-classes-binconfig-disabled` class, this
913 :ref:`binconfig-disabled <ref-classes-binconfig-disabled>` class, 913 variable specifies binary configuration scripts to disable in favor of
914 this variable specifies binary configuration scripts to disable in 914 using ``pkg-config`` to query the information. The
915 favor of using ``pkg-config`` to query the information. The 915 :ref:`ref-classes-binconfig-disabled` class will modify the specified
916 :ref:`binconfig-disabled <ref-classes-binconfig-disabled>` class will modify the specified scripts to 916 scripts to return an error so that calls to them can be easily found
917 return an error so that calls to them can be easily found and 917 and replaced.
918 replaced.
919 918
920 To add multiple scripts, separate them by spaces. Here is an example 919 To add multiple scripts, separate them by spaces. Here is an example
921 from the ``libpng`` recipe:: 920 from the ``libpng`` recipe::
@@ -923,7 +922,7 @@ system and gives an overview of their function and contents.
923 BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config" 922 BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config"
924 923
925 :term:`BINCONFIG_GLOB` 924 :term:`BINCONFIG_GLOB`
926 When inheriting the :ref:`binconfig <ref-classes-binconfig>` class, 925 When inheriting the :ref:`ref-classes-binconfig` class,
927 this variable specifies a wildcard for configuration scripts that 926 this variable specifies a wildcard for configuration scripts that
928 need editing. The scripts are edited to correct any paths that have 927 need editing. The scripts are edited to correct any paths that have
929 been set up during compilation so that they are correct for use when 928 been set up during compilation so that they are correct for use when
@@ -1048,8 +1047,7 @@ system and gives an overview of their function and contents.
1048 :term:`BUILD_PREFIX` 1047 :term:`BUILD_PREFIX`
1049 The toolchain binary prefix used for native recipes. The OpenEmbedded 1048 The toolchain binary prefix used for native recipes. The OpenEmbedded
1050 build system uses the :term:`BUILD_PREFIX` value to set the 1049 build system uses the :term:`BUILD_PREFIX` value to set the
1051 :term:`TARGET_PREFIX` when building for 1050 :term:`TARGET_PREFIX` when building for :ref:`ref-classes-native` recipes.
1052 :ref:`native <ref-classes-native>` recipes.
1053 1051
1054 :term:`BUILD_STRIP` 1052 :term:`BUILD_STRIP`
1055 Specifies the command to be used to strip debugging symbols from 1053 Specifies the command to be used to strip debugging symbols from
@@ -1060,7 +1058,7 @@ system and gives an overview of their function and contents.
1060 :term:`BUILD_SYS` 1058 :term:`BUILD_SYS`
1061 Specifies the system, including the architecture and the operating 1059 Specifies the system, including the architecture and the operating
1062 system, to use when building for the build host (i.e. when building 1060 system, to use when building for the build host (i.e. when building
1063 :ref:`native <ref-classes-native>` recipes). 1061 :ref:`ref-classes-native` recipes).
1064 1062
1065 The OpenEmbedded build system automatically sets this variable based 1063 The OpenEmbedded build system automatically sets this variable based
1066 on :term:`BUILD_ARCH`, 1064 on :term:`BUILD_ARCH`,
@@ -1080,22 +1078,22 @@ system and gives an overview of their function and contents.
1080 :term:`BUILDDIR` defaults to ``build`` in the current directory. 1078 :term:`BUILDDIR` defaults to ``build`` in the current directory.
1081 1079
1082 :term:`BUILDHISTORY_COMMIT` 1080 :term:`BUILDHISTORY_COMMIT`
1083 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 1081 When inheriting the :ref:`ref-classes-buildhistory` class, this variable
1084 class, this variable specifies whether or not to commit the build 1082 specifies whether or not to commit the build history output in a local
1085 history output in a local Git repository. If set to "1", this local 1083 Git repository. If set to "1", this local repository will be maintained
1086 repository will be maintained automatically by the :ref:`buildhistory <ref-classes-buildhistory>` 1084 automatically by the :ref:`ref-classes-buildhistory` class and a commit
1087 class and a commit will be created on every build for changes to each 1085 will be created on every build for changes to each top-level subdirectory
1088 top-level subdirectory of the build history output (images, packages, 1086 of the build history output (images, packages, and sdk). If you want to
1089 and sdk). If you want to track changes to build history over time, 1087 track changes to build history over time, you should set this value to
1090 you should set this value to "1". 1088 "1".
1091 1089
1092 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class 1090 By default, the :ref:`ref-classes-buildhistory` class
1093 enables committing the buildhistory output in a local Git repository:: 1091 enables committing the buildhistory output in a local Git repository::
1094 1092
1095 BUILDHISTORY_COMMIT ?= "1" 1093 BUILDHISTORY_COMMIT ?= "1"
1096 1094
1097 :term:`BUILDHISTORY_COMMIT_AUTHOR` 1095 :term:`BUILDHISTORY_COMMIT_AUTHOR`
1098 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 1096 When inheriting the :ref:`ref-classes-buildhistory`
1099 class, this variable specifies the author to use for each Git commit. 1097 class, this variable specifies the author to use for each Git commit.
1100 In order for the :term:`BUILDHISTORY_COMMIT_AUTHOR` variable to work, the 1098 In order for the :term:`BUILDHISTORY_COMMIT_AUTHOR` variable to work, the
1101 :term:`BUILDHISTORY_COMMIT` variable must 1099 :term:`BUILDHISTORY_COMMIT` variable must
@@ -1106,22 +1104,24 @@ system and gives an overview of their function and contents.
1106 email@host". Providing an email address or host that is not valid 1104 email@host". Providing an email address or host that is not valid
1107 does not produce an error. 1105 does not produce an error.
1108 1106
1109 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class sets the variable as follows:: 1107 By default, the :ref:`ref-classes-buildhistory` class sets the variable
1108 as follows::
1110 1109
1111 BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>" 1110 BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>"
1112 1111
1113 :term:`BUILDHISTORY_DIR` 1112 :term:`BUILDHISTORY_DIR`
1114 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 1113 When inheriting the :ref:`ref-classes-buildhistory`
1115 class, this variable specifies the directory in which build history 1114 class, this variable specifies the directory in which build history
1116 information is kept. For more information on how the variable works, 1115 information is kept. For more information on how the variable works,
1117 see the :ref:`ref-classes-buildhistory` class. 1116 see the :ref:`ref-classes-buildhistory` class.
1118 1117
1119 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class sets the directory as follows:: 1118 By default, the :ref:`ref-classes-buildhistory` class sets the directory
1119 as follows::
1120 1120
1121 BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory" 1121 BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory"
1122 1122
1123 :term:`BUILDHISTORY_FEATURES` 1123 :term:`BUILDHISTORY_FEATURES`
1124 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 1124 When inheriting the :ref:`ref-classes-buildhistory`
1125 class, this variable specifies the build history features to be 1125 class, this variable specifies the build history features to be
1126 enabled. For more information on how build history works, see the 1126 enabled. For more information on how build history works, see the
1127 ":ref:`dev-manual/build-quality:maintaining build output quality`" 1127 ":ref:`dev-manual/build-quality:maintaining build output quality`"
@@ -1143,13 +1143,13 @@ system and gives an overview of their function and contents.
1143 This saves one file per task and lists the SHA-256 checksums for 1143 This saves one file per task and lists the SHA-256 checksums for
1144 each file staged (i.e. the output of the task). 1144 each file staged (i.e. the output of the task).
1145 1145
1146 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class enables the following 1146 By default, the :ref:`ref-classes-buildhistory` class enables the
1147 features:: 1147 following features::
1148 1148
1149 BUILDHISTORY_FEATURES ?= "image package sdk" 1149 BUILDHISTORY_FEATURES ?= "image package sdk"
1150 1150
1151 :term:`BUILDHISTORY_IMAGE_FILES` 1151 :term:`BUILDHISTORY_IMAGE_FILES`
1152 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 1152 When inheriting the :ref:`ref-classes-buildhistory`
1153 class, this variable specifies a list of paths to files copied from 1153 class, this variable specifies a list of paths to files copied from
1154 the image contents into the build history directory under an 1154 the image contents into the build history directory under an
1155 "image-files" directory in the directory for the image, so that you 1155 "image-files" directory in the directory for the image, so that you
@@ -1159,39 +1159,39 @@ system and gives an overview of their function and contents.
1159 any file. Specifying an invalid path does not produce an error. 1159 any file. Specifying an invalid path does not produce an error.
1160 Consequently, you can include files that might not always be present. 1160 Consequently, you can include files that might not always be present.
1161 1161
1162 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class provides paths to the 1162 By default, the :ref:`ref-classes-buildhistory` class provides paths to
1163 following files:: 1163 the following files::
1164 1164
1165 BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group" 1165 BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group"
1166 1166
1167 :term:`BUILDHISTORY_PATH_PREFIX_STRIP` 1167 :term:`BUILDHISTORY_PATH_PREFIX_STRIP`
1168 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 1168 When inheriting the :ref:`ref-classes-buildhistory`
1169 class, this variable specifies a common path prefix that should be 1169 class, this variable specifies a common path prefix that should be
1170 stripped off the beginning of paths in the task signature list when the 1170 stripped off the beginning of paths in the task signature list when the
1171 ``task`` feature is active in :term:`BUILDHISTORY_FEATURES`. This can be 1171 ``task`` feature is active in :term:`BUILDHISTORY_FEATURES`. This can be
1172 useful when build history is populated from multiple sources that may not 1172 useful when build history is populated from multiple sources that may not
1173 all use the same top level directory. 1173 all use the same top level directory.
1174 1174
1175 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class sets the variable as follows:: 1175 By default, the :ref:`ref-classes-buildhistory` class sets the variable
1176 as follows::
1176 1177
1177 BUILDHISTORY_PATH_PREFIX_STRIP ?= "" 1178 BUILDHISTORY_PATH_PREFIX_STRIP ?= ""
1178 1179
1179 In this case, no prefixes will be stripped. 1180 In this case, no prefixes will be stripped.
1180 1181
1181 :term:`BUILDHISTORY_PUSH_REPO` 1182 :term:`BUILDHISTORY_PUSH_REPO`
1182 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 1183 When inheriting the :ref:`ref-classes-buildhistory` class, this variable
1183 class, this variable optionally specifies a remote repository to 1184 optionally specifies a remote repository to which build history pushes
1184 which build history pushes Git changes. In order for 1185 Git changes. In order for :term:`BUILDHISTORY_PUSH_REPO` to work,
1185 :term:`BUILDHISTORY_PUSH_REPO` to work, 1186 :term:`BUILDHISTORY_COMMIT` must be set to "1".
1186 :term:`BUILDHISTORY_COMMIT` must be set to
1187 "1".
1188 1187
1189 The repository should correspond to a remote address that specifies a 1188 The repository should correspond to a remote address that specifies a
1190 repository as understood by Git, or alternatively to a remote name 1189 repository as understood by Git, or alternatively to a remote name
1191 that you have set up manually using ``git remote`` within the local 1190 that you have set up manually using ``git remote`` within the local
1192 repository. 1191 repository.
1193 1192
1194 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class sets the variable as follows:: 1193 By default, the :ref:`ref-classes-buildhistory` class sets the variable
1194 as follows::
1195 1195
1196 BUILDHISTORY_PUSH_REPO ?= "" 1196 BUILDHISTORY_PUSH_REPO ?= ""
1197 1197
@@ -1224,8 +1224,7 @@ system and gives an overview of their function and contents.
1224 1224
1225 :term:`BUILDSTATS_BASE` 1225 :term:`BUILDSTATS_BASE`
1226 Points to the location of the directory that holds build statistics 1226 Points to the location of the directory that holds build statistics
1227 when you use and enable the 1227 when you use and enable the :ref:`ref-classes-buildstats` class. The
1228 :ref:`buildstats <ref-classes-buildstats>` class. The
1229 :term:`BUILDSTATS_BASE` directory defaults to 1228 :term:`BUILDSTATS_BASE` directory defaults to
1230 ``${``\ :term:`TMPDIR`\ ``}/buildstats/``. 1229 ``${``\ :term:`TMPDIR`\ ``}/buildstats/``.
1231 1230
@@ -1271,9 +1270,8 @@ system and gives an overview of their function and contents.
1271 An internal variable specifying the special class override that 1270 An internal variable specifying the special class override that
1272 should currently apply (e.g. "class-target", "class-native", and so 1271 should currently apply (e.g. "class-target", "class-native", and so
1273 forth). The classes that use this variable (e.g. 1272 forth). The classes that use this variable (e.g.
1274 :ref:`native <ref-classes-native>`, 1273 :ref:`ref-classes-native`, :ref:`ref-classes-nativesdk`, and so forth)
1275 :ref:`nativesdk <ref-classes-nativesdk>`, and so forth) set the 1274 set the variable to appropriate values.
1276 variable to appropriate values.
1277 1275
1278 .. note:: 1276 .. note::
1279 1277
@@ -1449,8 +1447,7 @@ system and gives an overview of their function and contents.
1449 The minimal arguments for GNU configure. 1447 The minimal arguments for GNU configure.
1450 1448
1451 :term:`CONFLICT_DISTRO_FEATURES` 1449 :term:`CONFLICT_DISTRO_FEATURES`
1452 When inheriting the 1450 When inheriting the :ref:`ref-classes-features_check`
1453 :ref:`features_check <ref-classes-features_check>`
1454 class, this variable identifies distribution features that would be 1451 class, this variable identifies distribution features that would be
1455 in conflict should the recipe be built. In other words, if the 1452 in conflict should the recipe be built. In other words, if the
1456 :term:`CONFLICT_DISTRO_FEATURES` variable lists a feature that also 1453 :term:`CONFLICT_DISTRO_FEATURES` variable lists a feature that also
@@ -1466,8 +1463,8 @@ system and gives an overview of their function and contents.
1466 1463
1467 - Checksums for the image 1464 - Checksums for the image
1468 1465
1469 An example of :term:`CONVERSION_CMD` from :ref:`image-types 1466 An example of :term:`CONVERSION_CMD` from :ref:`ref-classes-image_types`
1470 <ref-classes-image_types>` class is:: 1467 class is::
1471 1468
1472 CONVERSION_CMD:lzo = "lzop -9 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}" 1469 CONVERSION_CMD:lzo = "lzop -9 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"
1473 1470
@@ -1506,10 +1503,9 @@ system and gives an overview of their function and contents.
1506 information on providing license text. 1503 information on providing license text.
1507 1504
1508 :term:`COPYLEFT_LICENSE_EXCLUDE` 1505 :term:`COPYLEFT_LICENSE_EXCLUDE`
1509 A space-separated list of licenses to exclude from the source 1506 A space-separated list of licenses to exclude from the source archived by
1510 archived by the :ref:`archiver <ref-classes-archiver>` class. In 1507 the :ref:`ref-classes-archiver` class. In other words, if a license in a
1511 other words, if a license in a recipe's 1508 recipe's :term:`LICENSE` value is in the value of
1512 :term:`LICENSE` value is in the value of
1513 :term:`COPYLEFT_LICENSE_EXCLUDE`, then its source is not archived by the 1509 :term:`COPYLEFT_LICENSE_EXCLUDE`, then its source is not archived by the
1514 class. 1510 class.
1515 1511
@@ -1520,60 +1516,54 @@ system and gives an overview of their function and contents.
1520 1516
1521 The default value, which is "CLOSED Proprietary", for 1517 The default value, which is "CLOSED Proprietary", for
1522 :term:`COPYLEFT_LICENSE_EXCLUDE` is set by the 1518 :term:`COPYLEFT_LICENSE_EXCLUDE` is set by the
1523 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which 1519 :ref:`ref-classes-copyleft_filter` class, which
1524 is inherited by the :ref:`archiver <ref-classes-archiver>` class. 1520 is inherited by the :ref:`ref-classes-archiver` class.
1525 1521
1526 :term:`COPYLEFT_LICENSE_INCLUDE` 1522 :term:`COPYLEFT_LICENSE_INCLUDE`
1527 A space-separated list of licenses to include in the source archived 1523 A space-separated list of licenses to include in the source archived
1528 by the :ref:`archiver <ref-classes-archiver>` class. In other 1524 by the :ref:`ref-classes-archiver` class. In other
1529 words, if a license in a recipe's :term:`LICENSE` 1525 words, if a license in a recipe's :term:`LICENSE`
1530 value is in the value of :term:`COPYLEFT_LICENSE_INCLUDE`, then its 1526 value is in the value of :term:`COPYLEFT_LICENSE_INCLUDE`, then its
1531 source is archived by the class. 1527 source is archived by the class.
1532 1528
1533 The default value is set by the 1529 The default value is set by the :ref:`ref-classes-copyleft_filter` class,
1534 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which 1530 which is inherited by the :ref:`ref-classes-archiver` class. The default
1535 is inherited by the :ref:`archiver <ref-classes-archiver>` class. The default value includes 1531 value includes "GPL*", "LGPL*", and "AGPL*".
1536 "GPL*", "LGPL*", and "AGPL*".
1537 1532
1538 :term:`COPYLEFT_PN_EXCLUDE` 1533 :term:`COPYLEFT_PN_EXCLUDE`
1539 A list of recipes to exclude in the source archived by the 1534 A list of recipes to exclude in the source archived by the
1540 :ref:`archiver <ref-classes-archiver>` class. The 1535 :ref:`ref-classes-archiver` class. The :term:`COPYLEFT_PN_EXCLUDE`
1541 :term:`COPYLEFT_PN_EXCLUDE` variable overrides the license inclusion and 1536 variable overrides the license inclusion and exclusion caused through the
1542 exclusion caused through the 1537 :term:`COPYLEFT_LICENSE_INCLUDE` and :term:`COPYLEFT_LICENSE_EXCLUDE`
1543 :term:`COPYLEFT_LICENSE_INCLUDE` and
1544 :term:`COPYLEFT_LICENSE_EXCLUDE`
1545 variables, respectively. 1538 variables, respectively.
1546 1539
1547 The default value, which is "" indicating to not explicitly exclude 1540 The default value, which is "" indicating to not explicitly exclude
1548 any recipes by name, for :term:`COPYLEFT_PN_EXCLUDE` is set by the 1541 any recipes by name, for :term:`COPYLEFT_PN_EXCLUDE` is set by the
1549 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which 1542 :ref:`ref-classes-copyleft_filter` class, which is inherited by the
1550 is inherited by the :ref:`archiver <ref-classes-archiver>` class. 1543 :ref:`ref-classes-archiver` class.
1551 1544
1552 :term:`COPYLEFT_PN_INCLUDE` 1545 :term:`COPYLEFT_PN_INCLUDE`
1553 A list of recipes to include in the source archived by the 1546 A list of recipes to include in the source archived by the
1554 :ref:`archiver <ref-classes-archiver>` class. The 1547 :ref:`ref-classes-archiver` class. The :term:`COPYLEFT_PN_INCLUDE`
1555 :term:`COPYLEFT_PN_INCLUDE` variable overrides the license inclusion and 1548 variable overrides the license inclusion and exclusion caused through the
1556 exclusion caused through the 1549 :term:`COPYLEFT_LICENSE_INCLUDE` and :term:`COPYLEFT_LICENSE_EXCLUDE`
1557 :term:`COPYLEFT_LICENSE_INCLUDE` and
1558 :term:`COPYLEFT_LICENSE_EXCLUDE`
1559 variables, respectively. 1550 variables, respectively.
1560 1551
1561 The default value, which is "" indicating to not explicitly include 1552 The default value, which is "" indicating to not explicitly include
1562 any recipes by name, for :term:`COPYLEFT_PN_INCLUDE` is set by the 1553 any recipes by name, for :term:`COPYLEFT_PN_INCLUDE` is set by the
1563 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which 1554 :ref:`ref-classes-copyleft_filter` class, which is inherited by the
1564 is inherited by the :ref:`archiver <ref-classes-archiver>` class. 1555 :ref:`ref-classes-archiver` class.
1565 1556
1566 :term:`COPYLEFT_RECIPE_TYPES` 1557 :term:`COPYLEFT_RECIPE_TYPES`
1567 A space-separated list of recipe types to include in the source 1558 A space-separated list of recipe types to include in the source
1568 archived by the :ref:`archiver <ref-classes-archiver>` class. 1559 archived by the :ref:`archiver <ref-classes-archiver>` class.
1569 Recipe types are ``target``, :ref:`native <ref-classes-native>`, 1560 Recipe types are ``target``, :ref:`ref-classes-native`,
1570 :ref:`nativesdk <ref-classes-nativesdk>`, 1561 :ref:`ref-classes-nativesdk`, :ref:`ref-classes-cross`,
1571 :ref:`cross <ref-classes-cross>`, :ref:`crosssdk <ref-classes-crosssdk>`, 1562 :ref:`ref-classes-crosssdk`, and :ref:`ref-classes-cross-canadian`.
1572 and :ref:`cross-canadian <ref-classes-cross-canadian>`.
1573 1563
1574 The default value, which is "target*", for :term:`COPYLEFT_RECIPE_TYPES` 1564 The default value, which is "target*", for :term:`COPYLEFT_RECIPE_TYPES`
1575 is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>` 1565 is set by the :ref:`ref-classes-copyleft_filter` class, which is
1576 class, which is inherited by the :ref:`archiver <ref-classes-archiver>` class. 1566 inherited by the :ref:`ref-classes-archiver` class.
1577 1567
1578 :term:`CORE_IMAGE_EXTRA_INSTALL` 1568 :term:`CORE_IMAGE_EXTRA_INSTALL`
1579 Specifies the list of packages to be added to the image. You should 1569 Specifies the list of packages to be added to the image. You should
@@ -1647,7 +1637,7 @@ system and gives an overview of their function and contents.
1647 CVE_CHECK_IGNORE += "CVE-2020-15523" 1637 CVE_CHECK_IGNORE += "CVE-2020-15523"
1648 1638
1649 :term:`CVE_CHECK_SHOW_WARNINGS` 1639 :term:`CVE_CHECK_SHOW_WARNINGS`
1650 Specifies whether or not the :ref:`cve-check <ref-classes-cve-check>` 1640 Specifies whether or not the :ref:`ref-classes-cve-check`
1651 class should generate warning messages on the console when unpatched 1641 class should generate warning messages on the console when unpatched
1652 CVEs are found. The default is "1", but you may wish to set it to "0" if 1642 CVEs are found. The default is "1", but you may wish to set it to "0" if
1653 you are already examining/processing the logs after the build has 1643 you are already examining/processing the logs after the build has
@@ -1669,7 +1659,7 @@ system and gives an overview of their function and contents.
1669 against the name in the upstream `NIST CVE database <https://nvd.nist.gov/>`__. 1659 against the name in the upstream `NIST CVE database <https://nvd.nist.gov/>`__.
1670 1660
1671 The default is ${:term:`BPN`} (except for recipes that inherit the 1661 The default is ${:term:`BPN`} (except for recipes that inherit the
1672 :ref:`pypi <ref-classes-pypi>` class where it is set based upon 1662 :ref:`ref-classes-pypi` class where it is set based upon
1673 :term:`PYPI_PACKAGE`). If it does not match the name in the NIST CVE 1663 :term:`PYPI_PACKAGE`). If it does not match the name in the NIST CVE
1674 database or matches with multiple entries in the database, the default 1664 database or matches with multiple entries in the database, the default
1675 value needs to be changed. 1665 value needs to be changed.
@@ -1688,12 +1678,12 @@ system and gives an overview of their function and contents.
1688 :term:`CVE_VERSION` 1678 :term:`CVE_VERSION`
1689 In a recipe, defines the version used to match the recipe version 1679 In a recipe, defines the version used to match the recipe version
1690 against the version in the `NIST CVE database <https://nvd.nist.gov/>`__ 1680 against the version in the `NIST CVE database <https://nvd.nist.gov/>`__
1691 when usign :ref:`cve-check <ref-classes-cve-check>`. 1681 when usign :ref:`ref-classes-cve-check`.
1692 1682
1693 The default is ${:term:`PV`} but if recipes use custom version numbers 1683 The default is ${:term:`PV`} but if recipes use custom version numbers
1694 which do not map to upstream software component release versions and the versions 1684 which do not map to upstream software component release versions and the versions
1695 used in the CVE database, then this variable can be used to set the 1685 used in the CVE database, then this variable can be used to set the
1696 version number for :ref:`cve-check <ref-classes-cve-check>`. Example:: 1686 version number for :ref:`ref-classes-cve-check`. Example::
1697 1687
1698 CVE_VERSION = "2.39" 1688 CVE_VERSION = "2.39"
1699 1689
@@ -1743,7 +1733,7 @@ system and gives an overview of their function and contents.
1743 suitable for timestamps. 1733 suitable for timestamps.
1744 1734
1745 :term:`DEBIAN_NOAUTONAME` 1735 :term:`DEBIAN_NOAUTONAME`
1746 When the :ref:`debian <ref-classes-debian>` class is inherited, 1736 When the :ref:`ref-classes-debian` class is inherited,
1747 which is the default behavior, :term:`DEBIAN_NOAUTONAME` specifies a 1737 which is the default behavior, :term:`DEBIAN_NOAUTONAME` specifies a
1748 particular package should not be renamed according to Debian library 1738 particular package should not be renamed according to Debian library
1749 package naming. You must use the package name as an override when you 1739 package naming. You must use the package name as an override when you
@@ -1752,7 +1742,7 @@ system and gives an overview of their function and contents.
1752 DEBIAN_NOAUTONAME:fontconfig-utils = "1" 1742 DEBIAN_NOAUTONAME:fontconfig-utils = "1"
1753 1743
1754 :term:`DEBIANNAME` 1744 :term:`DEBIANNAME`
1755 When the :ref:`debian <ref-classes-debian>` class is inherited, 1745 When the :ref:`ref-classes-debian` class is inherited,
1756 which is the default behavior, :term:`DEBIANNAME` allows you to override 1746 which is the default behavior, :term:`DEBIANNAME` allows you to override
1757 the library name for an individual package. Overriding the library 1747 the library name for an individual package. Overriding the library
1758 name in these cases is rare. You must use the package name as an 1748 name in these cases is rare. You must use the package name as an
@@ -1832,7 +1822,7 @@ system and gives an overview of their function and contents.
1832 the :ref:`ref-tasks-populate_sysroot` task of 1822 the :ref:`ref-tasks-populate_sysroot` task of
1833 each recipe listed in :term:`DEPENDS`, through a 1823 each recipe listed in :term:`DEPENDS`, through a
1834 ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` 1824 ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
1835 declaration in the :ref:`base <ref-classes-base>` class. 1825 declaration in the :ref:`ref-classes-base` class.
1836 1826
1837 .. note:: 1827 .. note::
1838 1828
@@ -1848,7 +1838,7 @@ system and gives an overview of their function and contents.
1848 DEPENDS = "codegen-native" 1838 DEPENDS = "codegen-native"
1849 1839
1850 For more 1840 For more
1851 information, see the :ref:`native <ref-classes-native>` class and 1841 information, see the :ref:`ref-classes-native` class and
1852 the :term:`EXTRANATIVEPATH` variable. 1842 the :term:`EXTRANATIVEPATH` variable.
1853 1843
1854 .. note:: 1844 .. note::
@@ -1903,7 +1893,7 @@ system and gives an overview of their function and contents.
1903 Points to the area that the OpenEmbedded build system uses to place 1893 Points to the area that the OpenEmbedded build system uses to place
1904 Debian packages that are ready to be used outside of the build 1894 Debian packages that are ready to be used outside of the build
1905 system. This variable applies only when :term:`PACKAGE_CLASSES` contains 1895 system. This variable applies only when :term:`PACKAGE_CLASSES` contains
1906 ":ref:`package_deb <ref-classes-package_deb>`". 1896 ":ref:`ref-classes-package_deb`".
1907 1897
1908 The BitBake configuration file initially defines the 1898 The BitBake configuration file initially defines the
1909 :term:`DEPLOY_DIR_DEB` variable as a sub-folder of 1899 :term:`DEPLOY_DIR_DEB` variable as a sub-folder of
@@ -1911,7 +1901,7 @@ system and gives an overview of their function and contents.
1911 1901
1912 DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb" 1902 DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb"
1913 1903
1914 The :ref:`package_deb <ref-classes-package_deb>` class uses the 1904 The :ref:`ref-classes-package_deb` class uses the
1915 :term:`DEPLOY_DIR_DEB` variable to make sure the 1905 :term:`DEPLOY_DIR_DEB` variable to make sure the
1916 :ref:`ref-tasks-package_write_deb` task 1906 :ref:`ref-tasks-package_write_deb` task
1917 writes Debian packages into the appropriate folder. For more 1907 writes Debian packages into the appropriate folder. For more
@@ -1930,9 +1920,8 @@ system and gives an overview of their function and contents.
1930 It must not be used directly in recipes when deploying files. Instead, 1920 It must not be used directly in recipes when deploying files. Instead,
1931 it's only useful when a recipe needs to "read" a file already deployed 1921 it's only useful when a recipe needs to "read" a file already deployed
1932 by a dependency. So, it should be filled with the contents of 1922 by a dependency. So, it should be filled with the contents of
1933 :term:`DEPLOYDIR` by the :ref:`deploy <ref-classes-deploy>` class or 1923 :term:`DEPLOYDIR` by the :ref:`ref-classes-deploy` class or with the
1934 with the contents of :term:`IMGDEPLOYDIR` by the :ref:`image 1924 contents of :term:`IMGDEPLOYDIR` by the :ref:`ref-classes-image` class.
1935 <ref-classes-image>` class.
1936 1925
1937 For more information on the structure of the :term:`Build Directory`, see 1926 For more information on the structure of the :term:`Build Directory`, see
1938 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. 1927 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section.
@@ -1945,16 +1934,15 @@ system and gives an overview of their function and contents.
1945 Points to the area that the OpenEmbedded build system uses to place 1934 Points to the area that the OpenEmbedded build system uses to place
1946 IPK packages that are ready to be used outside of the build system. 1935 IPK packages that are ready to be used outside of the build system.
1947 This variable applies only when :term:`PACKAGE_CLASSES` contains 1936 This variable applies only when :term:`PACKAGE_CLASSES` contains
1948 ":ref:`package_ipk <ref-classes-package_ipk>`". 1937 ":ref:`ref-classes-package_ipk`".
1949 1938
1950 The BitBake configuration file initially defines this variable as a 1939 The BitBake configuration file initially defines this variable as a
1951 sub-folder of :term:`DEPLOY_DIR`:: 1940 sub-folder of :term:`DEPLOY_DIR`::
1952 1941
1953 DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk" 1942 DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk"
1954 1943
1955 The :ref:`package_ipk <ref-classes-package_ipk>` class uses the 1944 The :ref:`ref-classes-package_ipk` class uses the :term:`DEPLOY_DIR_IPK`
1956 :term:`DEPLOY_DIR_IPK` variable to make sure the 1945 variable to make sure the :ref:`ref-tasks-package_write_ipk` task
1957 :ref:`ref-tasks-package_write_ipk` task
1958 writes IPK packages into the appropriate folder. For more information 1946 writes IPK packages into the appropriate folder. For more information
1959 on how packaging works, see the 1947 on how packaging works, see the
1960 ":ref:`overview-manual/concepts:package feeds`" section 1948 ":ref:`overview-manual/concepts:package feeds`" section
@@ -1964,14 +1952,14 @@ system and gives an overview of their function and contents.
1964 Points to the area that the OpenEmbedded build system uses to place 1952 Points to the area that the OpenEmbedded build system uses to place
1965 RPM packages that are ready to be used outside of the build system. 1953 RPM packages that are ready to be used outside of the build system.
1966 This variable applies only when :term:`PACKAGE_CLASSES` contains 1954 This variable applies only when :term:`PACKAGE_CLASSES` contains
1967 ":ref:`package_rpm <ref-classes-package_rpm>`". 1955 ":ref:`ref-classes-package_rpm`".
1968 1956
1969 The BitBake configuration file initially defines this variable as a 1957 The BitBake configuration file initially defines this variable as a
1970 sub-folder of :term:`DEPLOY_DIR`:: 1958 sub-folder of :term:`DEPLOY_DIR`::
1971 1959
1972 DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm" 1960 DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm"
1973 1961
1974 The :ref:`package_rpm <ref-classes-package_rpm>` class uses the 1962 The :ref:`ref-classes-package_rpm` class uses the
1975 :term:`DEPLOY_DIR_RPM` variable to make sure the 1963 :term:`DEPLOY_DIR_RPM` variable to make sure the
1976 :ref:`ref-tasks-package_write_rpm` task 1964 :ref:`ref-tasks-package_write_rpm` task
1977 writes RPM packages into the appropriate folder. For more information 1965 writes RPM packages into the appropriate folder. For more information
@@ -1983,14 +1971,14 @@ system and gives an overview of their function and contents.
1983 Points to the area that the OpenEmbedded build system uses to place 1971 Points to the area that the OpenEmbedded build system uses to place
1984 tarballs that are ready to be used outside of the build system. This 1972 tarballs that are ready to be used outside of the build system. This
1985 variable applies only when :term:`PACKAGE_CLASSES` contains 1973 variable applies only when :term:`PACKAGE_CLASSES` contains
1986 ":ref:`package_tar <ref-classes-package_tar>`". 1974 ":ref:`ref-classes-package_tar`".
1987 1975
1988 The BitBake configuration file initially defines this variable as a 1976 The BitBake configuration file initially defines this variable as a
1989 sub-folder of :term:`DEPLOY_DIR`:: 1977 sub-folder of :term:`DEPLOY_DIR`::
1990 1978
1991 DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar" 1979 DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar"
1992 1980
1993 The :ref:`package_tar <ref-classes-package_tar>` class uses the 1981 The :ref:`ref-classes-package_tar` class uses the
1994 :term:`DEPLOY_DIR_TAR` variable to make sure the 1982 :term:`DEPLOY_DIR_TAR` variable to make sure the
1995 :ref:`ref-tasks-package_write_tar` task 1983 :ref:`ref-tasks-package_write_tar` task
1996 writes TAR packages into the appropriate folder. For more information 1984 writes TAR packages into the appropriate folder. For more information
@@ -1999,13 +1987,13 @@ system and gives an overview of their function and contents.
1999 in the Yocto Project Overview and Concepts Manual. 1987 in the Yocto Project Overview and Concepts Manual.
2000 1988
2001 :term:`DEPLOYDIR` 1989 :term:`DEPLOYDIR`
2002 When inheriting the :ref:`deploy <ref-classes-deploy>` class, the 1990 When inheriting the :ref:`ref-classes-deploy` class, the
2003 :term:`DEPLOYDIR` points to a temporary work area for deployed files that 1991 :term:`DEPLOYDIR` points to a temporary work area for deployed files that
2004 is set in the :ref:`deploy <ref-classes-deploy>` class as follows:: 1992 is set in the :ref:`ref-classes-deploy` class as follows::
2005 1993
2006 DEPLOYDIR = "${WORKDIR}/deploy-${PN}" 1994 DEPLOYDIR = "${WORKDIR}/deploy-${PN}"
2007 1995
2008 Recipes inheriting the :ref:`deploy <ref-classes-deploy>` class should copy files to be 1996 Recipes inheriting the :ref:`ref-classes-deploy` class should copy files to be
2009 deployed into :term:`DEPLOYDIR`, and the class will take care of copying 1997 deployed into :term:`DEPLOYDIR`, and the class will take care of copying
2010 them into :term:`DEPLOY_DIR_IMAGE` 1998 them into :term:`DEPLOY_DIR_IMAGE`
2011 afterwards. 1999 afterwards.
@@ -2141,10 +2129,9 @@ system and gives an overview of their function and contents.
2141 :term:`DISTRO_FEATURES_FILTER_NATIVESDK` 2129 :term:`DISTRO_FEATURES_FILTER_NATIVESDK`
2142 Specifies a list of features that if present in the target 2130 Specifies a list of features that if present in the target
2143 :term:`DISTRO_FEATURES` value should be included in 2131 :term:`DISTRO_FEATURES` value should be included in
2144 :term:`DISTRO_FEATURES` when building 2132 :term:`DISTRO_FEATURES` when building :ref:`ref-classes-nativesdk`
2145 :ref:`nativesdk <ref-classes-nativesdk>` recipes. This variable is used 2133 recipes. This variable is used in addition to the features filtered using
2146 in addition to the features filtered using the 2134 the :term:`DISTRO_FEATURES_NATIVESDK` variable.
2147 :term:`DISTRO_FEATURES_NATIVESDK` variable.
2148 2135
2149 :term:`DISTRO_FEATURES_NATIVE` 2136 :term:`DISTRO_FEATURES_NATIVE`
2150 Specifies a list of features that should be included in 2137 Specifies a list of features that should be included in
@@ -2157,7 +2144,7 @@ system and gives an overview of their function and contents.
2157 :term:`DISTRO_FEATURES_NATIVESDK` 2144 :term:`DISTRO_FEATURES_NATIVESDK`
2158 Specifies a list of features that should be included in 2145 Specifies a list of features that should be included in
2159 :term:`DISTRO_FEATURES` when building 2146 :term:`DISTRO_FEATURES` when building
2160 :ref:`nativesdk <ref-classes-nativesdk>` recipes. This variable is used 2147 :ref:`ref-classes-nativesdk` recipes. This variable is used
2161 in addition to the features filtered using the 2148 in addition to the features filtered using the
2162 :term:`DISTRO_FEATURES_FILTER_NATIVESDK` variable. 2149 :term:`DISTRO_FEATURES_FILTER_NATIVESDK` variable.
2163 2150
@@ -2240,7 +2227,7 @@ system and gives an overview of their function and contents.
2240 Wiki page. 2227 Wiki page.
2241 2228
2242 :term:`DOC_COMPRESS` 2229 :term:`DOC_COMPRESS`
2243 When inheriting the :ref:`compress_doc <ref-classes-compress_doc>` 2230 When inheriting the :ref:`ref-classes-compress_doc`
2244 class, this variable sets the compression policy used when the 2231 class, this variable sets the compression policy used when the
2245 OpenEmbedded build system compresses man pages and info pages. By 2232 OpenEmbedded build system compresses man pages and info pages. By
2246 default, the compression method used is gz (gzip). Other policies 2233 default, the compression method used is gz (gzip). Other policies
@@ -2255,9 +2242,8 @@ system and gives an overview of their function and contents.
2255 :term:`EFI_PROVIDER` variable specifies the EFI bootloader to use. The 2242 :term:`EFI_PROVIDER` variable specifies the EFI bootloader to use. The
2256 default is "grub-efi", but "systemd-boot" can be used instead. 2243 default is "grub-efi", but "systemd-boot" can be used instead.
2257 2244
2258 See the :ref:`systemd-boot <ref-classes-systemd-boot>` and 2245 See the :ref:`ref-classes-systemd-boot` and :ref:`ref-classes-image-live`
2259 :ref:`image-live <ref-classes-image-live>` classes for more 2246 classes for more information.
2260 information.
2261 2247
2262 :term:`ENABLE_BINARY_LOCALE_GENERATION` 2248 :term:`ENABLE_BINARY_LOCALE_GENERATION`
2263 Variable that controls which locales for ``glibc`` are generated 2249 Variable that controls which locales for ``glibc`` are generated
@@ -2265,11 +2251,10 @@ system and gives an overview of their function and contents.
2265 less). 2251 less).
2266 2252
2267 :term:`ERR_REPORT_DIR` 2253 :term:`ERR_REPORT_DIR`
2268 When used with the :ref:`report-error <ref-classes-report-error>` 2254 When used with the :ref:`ref-classes-report-error` class, specifies the
2269 class, specifies the path used for storing the debug files created by 2255 path used for storing the debug files created by the :ref:`error reporting
2270 the :ref:`error reporting 2256 tool <dev-manual/error-reporting-tool:using the error reporting tool>`,
2271 tool <dev-manual/error-reporting-tool:using the error reporting tool>`, which 2257 which allows you to submit build errors you encounter to a central
2272 allows you to submit build errors you encounter to a central
2273 database. By default, the value of this variable is 2258 database. By default, the value of this variable is
2274 ``${``\ :term:`LOG_DIR`\ ``}/error-report``. 2259 ``${``\ :term:`LOG_DIR`\ ``}/error-report``.
2275 2260
@@ -2413,8 +2398,7 @@ system and gives an overview of their function and contents.
2413 When kernel tools are available in the tree, they are preferred over 2398 When kernel tools are available in the tree, they are preferred over
2414 any externally installed tools. Setting the :term:`EXTERNAL_KERNEL_TOOLS` 2399 any externally installed tools. Setting the :term:`EXTERNAL_KERNEL_TOOLS`
2415 variable tells the OpenEmbedded build system to prefer the installed 2400 variable tells the OpenEmbedded build system to prefer the installed
2416 external tools. See the 2401 external tools. See the :ref:`ref-classes-kernel-yocto` class in
2417 :ref:`kernel-yocto <ref-classes-kernel-yocto>` class in
2418 ``meta/classes-recipe`` to see how the variable is used. 2402 ``meta/classes-recipe`` to see how the variable is used.
2419 2403
2420 :term:`EXTERNAL_TOOLCHAIN` 2404 :term:`EXTERNAL_TOOLCHAIN`
@@ -2424,7 +2408,7 @@ system and gives an overview of their function and contents.
2424 installed. 2408 installed.
2425 2409
2426 :term:`EXTERNALSRC` 2410 :term:`EXTERNALSRC`
2427 When inheriting the :ref:`externalsrc <ref-classes-externalsrc>` 2411 When inheriting the :ref:`ref-classes-externalsrc`
2428 class, this variable points to the source tree, which is outside of 2412 class, this variable points to the source tree, which is outside of
2429 the OpenEmbedded build system. When set, this variable sets the 2413 the OpenEmbedded build system. When set, this variable sets the
2430 :term:`S` variable, which is what the OpenEmbedded build 2414 :term:`S` variable, which is what the OpenEmbedded build
@@ -2436,7 +2420,7 @@ system and gives an overview of their function and contents.
2436 section in the Yocto Project Development Tasks Manual. 2420 section in the Yocto Project Development Tasks Manual.
2437 2421
2438 :term:`EXTERNALSRC_BUILD` 2422 :term:`EXTERNALSRC_BUILD`
2439 When inheriting the :ref:`externalsrc <ref-classes-externalsrc>` 2423 When inheriting the :ref:`ref-classes-externalsrc`
2440 class, this variable points to the directory in which the recipe's 2424 class, this variable points to the directory in which the recipe's
2441 source code is built, which is outside of the OpenEmbedded build 2425 source code is built, which is outside of the OpenEmbedded build
2442 system. When set, this variable sets the :term:`B` variable, 2426 system. When set, this variable sets the :term:`B` variable,
@@ -2449,7 +2433,7 @@ system and gives an overview of their function and contents.
2449 section in the Yocto Project Development Tasks Manual. 2433 section in the Yocto Project Development Tasks Manual.
2450 2434
2451 :term:`EXTRA_AUTORECONF` 2435 :term:`EXTRA_AUTORECONF`
2452 For recipes inheriting the :ref:`autotools <ref-classes-autotools>` 2436 For recipes inheriting the :ref:`ref-classes-autotools`
2453 class, you can use :term:`EXTRA_AUTORECONF` to specify extra options to 2437 class, you can use :term:`EXTRA_AUTORECONF` to specify extra options to
2454 pass to the ``autoreconf`` command that is executed during the 2438 pass to the ``autoreconf`` command that is executed during the
2455 :ref:`ref-tasks-configure` task. 2439 :ref:`ref-tasks-configure` task.
@@ -2522,7 +2506,7 @@ system and gives an overview of their function and contents.
2522 2506
2523 :term:`EXTRA_OECMAKE` 2507 :term:`EXTRA_OECMAKE`
2524 Additional `CMake <https://cmake.org/overview/>`__ options. See the 2508 Additional `CMake <https://cmake.org/overview/>`__ options. See the
2525 :ref:`cmake <ref-classes-cmake>` class for additional information. 2509 :ref:`ref-classes-cmake` class for additional information.
2526 2510
2527 :term:`EXTRA_OECONF` 2511 :term:`EXTRA_OECONF`
2528 Additional ``configure`` script options. See 2512 Additional ``configure`` script options. See
@@ -2540,21 +2524,22 @@ system and gives an overview of their function and contents.
2540 :term:`EXTRA_OEMAKE` to pass the required flags. 2524 :term:`EXTRA_OEMAKE` to pass the required flags.
2541 2525
2542 :term:`EXTRA_OESCONS` 2526 :term:`EXTRA_OESCONS`
2543 When inheriting the :ref:`scons <ref-classes-scons>` class, this 2527 When inheriting the :ref:`ref-classes-scons` class, this
2544 variable specifies additional configuration options you want to pass 2528 variable specifies additional configuration options you want to pass
2545 to the ``scons`` command line. 2529 to the ``scons`` command line.
2546 2530
2547 :term:`EXTRA_USERS_PARAMS` 2531 :term:`EXTRA_USERS_PARAMS`
2548 When inheriting the :ref:`extrausers <ref-classes-extrausers>` 2532 When inheriting the :ref:`ref-classes-extrausers`
2549 class, this variable provides image level user and group operations. 2533 class, this variable provides image level user and group operations.
2550 This is a more global method of providing user and group 2534 This is a more global method of providing user and group
2551 configuration as compared to using the 2535 configuration as compared to using the
2552 :ref:`useradd <ref-classes-useradd>` class, which ties user and 2536 :ref:`ref-classes-useradd` class, which ties user and
2553 group configurations to a specific recipe. 2537 group configurations to a specific recipe.
2554 2538
2555 The set list of commands you can configure using the 2539 The set list of commands you can configure using the
2556 :term:`EXTRA_USERS_PARAMS` is shown in the :ref:`extrausers <ref-classes-extrausers>` class. These 2540 :term:`EXTRA_USERS_PARAMS` is shown in the
2557 commands map to the normal Unix commands of the same names:: 2541 :ref:`ref-classes-extrausers` class. These commands map to the normal
2542 Unix commands of the same names::
2558 2543
2559 # EXTRA_USERS_PARAMS = "\ 2544 # EXTRA_USERS_PARAMS = "\
2560 # useradd -p '' tester; \ 2545 # useradd -p '' tester; \
@@ -2892,7 +2877,7 @@ system and gives an overview of their function and contents.
2892 2877
2893 :term:`FIT_DESC` 2878 :term:`FIT_DESC`
2894 Specifies the description string encoded into a fitImage. The default 2879 Specifies the description string encoded into a fitImage. The default
2895 value is set by the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` 2880 value is set by the :ref:`ref-classes-kernel-fitimage`
2896 class as follows:: 2881 class as follows::
2897 2882
2898 FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}" 2883 FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}"
@@ -2938,7 +2923,7 @@ system and gives an overview of their function and contents.
2938 The default value is "pkcs-1.5". 2923 The default value is "pkcs-1.5".
2939 2924
2940 :term:`FIT_SIGN_INDIVIDUAL` 2925 :term:`FIT_SIGN_INDIVIDUAL`
2941 If set to "1", then the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` 2926 If set to "1", then the :ref:`ref-classes-kernel-fitimage`
2942 class will sign the kernel, dtb and ramdisk images individually in addition 2927 class will sign the kernel, dtb and ramdisk images individually in addition
2943 to signing the fitImage itself. This could be useful if you are 2928 to signing the fitImage itself. This could be useful if you are
2944 intending to verify signatures in another context than booting via 2929 intending to verify signatures in another context than booting via
@@ -2949,14 +2934,14 @@ system and gives an overview of their function and contents.
2949 value is "2048". 2934 value is "2048".
2950 2935
2951 :term:`FONT_EXTRA_RDEPENDS` 2936 :term:`FONT_EXTRA_RDEPENDS`
2952 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, 2937 When inheriting the :ref:`ref-classes-fontcache` class,
2953 this variable specifies the runtime dependencies for font packages. 2938 this variable specifies the runtime dependencies for font packages.
2954 By default, the :term:`FONT_EXTRA_RDEPENDS` is set to "fontconfig-utils". 2939 By default, the :term:`FONT_EXTRA_RDEPENDS` is set to "fontconfig-utils".
2955 2940
2956 :term:`FONT_PACKAGES` 2941 :term:`FONT_PACKAGES`
2957 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, 2942 When inheriting the :ref:`ref-classes-fontcache` class, this variable
2958 this variable identifies packages containing font files that need to 2943 identifies packages containing font files that need to be cached by
2959 be cached by Fontconfig. By default, the :ref:`fontcache <ref-classes-fontcache>` class assumes 2944 Fontconfig. By default, the :ref:`ref-classes-fontcache` class assumes
2960 that fonts are in the recipe's main package (i.e. 2945 that fonts are in the recipe's main package (i.e.
2961 ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you 2946 ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you
2962 need are in a package other than that main package. 2947 need are in a package other than that main package.
@@ -3007,7 +2992,7 @@ system and gives an overview of their function and contents.
3007 when it is cloned. 2992 when it is cloned.
3008 2993
3009 :term:`GITHUB_BASE_URI` 2994 :term:`GITHUB_BASE_URI`
3010 When inheriting the :ref:`github-releases <ref-classes-github-releases>` 2995 When inheriting the :ref:`ref-classes-github-releases`
3011 class, specifies the base URL for fetching releases for the github 2996 class, specifies the base URL for fetching releases for the github
3012 project you wish to fetch sources from. The default value is as follows:: 2997 project you wish to fetch sources from. The default value is as follows::
3013 2998
@@ -3028,7 +3013,7 @@ system and gives an overview of their function and contents.
3028 GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8" 3013 GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8"
3029 3014
3030 :term:`GROUPADD_PARAM` 3015 :term:`GROUPADD_PARAM`
3031 When inheriting the :ref:`useradd <ref-classes-useradd>` class, 3016 When inheriting the :ref:`ref-classes-useradd` class,
3032 this variable specifies for a package what parameters should be 3017 this variable specifies for a package what parameters should be
3033 passed to the ``groupadd`` command if you wish to add a group to the 3018 passed to the ``groupadd`` command if you wish to add a group to the
3034 system when the package is installed. 3019 system when the package is installed.
@@ -3041,7 +3026,7 @@ system and gives an overview of their function and contents.
3041 ``groupadd``, see https://linux.die.net/man/8/groupadd. 3026 ``groupadd``, see https://linux.die.net/man/8/groupadd.
3042 3027
3043 :term:`GROUPMEMS_PARAM` 3028 :term:`GROUPMEMS_PARAM`
3044 When inheriting the :ref:`useradd <ref-classes-useradd>` class, 3029 When inheriting the :ref:`ref-classes-useradd` class,
3045 this variable specifies for a package what parameters should be 3030 this variable specifies for a package what parameters should be
3046 passed to the ``groupmems`` command if you wish to modify the members 3031 passed to the ``groupmems`` command if you wish to modify the members
3047 of a group when the package is installed. 3032 of a group when the package is installed.
@@ -3055,7 +3040,7 @@ system and gives an overview of their function and contents.
3055 ``local.conf`` or distribution configuration file to enable graphics 3040 ``local.conf`` or distribution configuration file to enable graphics
3056 and serial in the menu. 3041 and serial in the menu.
3057 3042
3058 See the :ref:`grub-efi <ref-classes-grub-efi>` class for more 3043 See the :ref:`ref-classes-grub-efi` class for more
3059 information on how this variable is used. 3044 information on how this variable is used.
3060 3045
3061 :term:`GRUB_OPTS` 3046 :term:`GRUB_OPTS`
@@ -3064,7 +3049,7 @@ system and gives an overview of their function and contents.
3064 multiple options. 3049 multiple options.
3065 3050
3066 The :term:`GRUB_OPTS` variable is optional. See the 3051 The :term:`GRUB_OPTS` variable is optional. See the
3067 :ref:`grub-efi <ref-classes-grub-efi>` class for more information 3052 :ref:`ref-classes-grub-efi` class for more information
3068 on how this variable is used. 3053 on how this variable is used.
3069 3054
3070 :term:`GRUB_TIMEOUT` 3055 :term:`GRUB_TIMEOUT`
@@ -3072,12 +3057,11 @@ system and gives an overview of their function and contents.
3072 GNU GRand Unified Bootloader (GRUB). 3057 GNU GRand Unified Bootloader (GRUB).
3073 3058
3074 The :term:`GRUB_TIMEOUT` variable is optional. See the 3059 The :term:`GRUB_TIMEOUT` variable is optional. See the
3075 :ref:`grub-efi <ref-classes-grub-efi>` class for more information 3060 :ref:`ref-classes-grub-efi` class for more information
3076 on how this variable is used. 3061 on how this variable is used.
3077 3062
3078 :term:`GTKIMMODULES_PACKAGES` 3063 :term:`GTKIMMODULES_PACKAGES`
3079 When inheriting the 3064 When inheriting the :ref:`ref-classes-gtk-immodules-cache` class,
3080 :ref:`gtk-immodules-cache <ref-classes-gtk-immodules-cache>` class,
3081 this variable specifies the packages that contain the GTK+ input 3065 this variable specifies the packages that contain the GTK+ input
3082 method modules being installed when the modules are in packages other 3066 method modules being installed when the modules are in packages other
3083 than the main package. 3067 than the main package.
@@ -3180,7 +3164,7 @@ system and gives an overview of their function and contents.
3180 :term:`ICECC_CLASS_DISABLE` 3164 :term:`ICECC_CLASS_DISABLE`
3181 Identifies user classes that you do not want the Icecream distributed 3165 Identifies user classes that you do not want the Icecream distributed
3182 compile support to consider. This variable is used by the 3166 compile support to consider. This variable is used by the
3183 :ref:`icecc <ref-classes-icecc>` class. You set this variable in 3167 :ref:`ref-classes-icecc` class. You set this variable in
3184 your ``local.conf`` file. 3168 your ``local.conf`` file.
3185 3169
3186 When you list classes using this variable, the recipes inheriting 3170 When you list classes using this variable, the recipes inheriting
@@ -3204,7 +3188,7 @@ system and gives an overview of their function and contents.
3204 3188
3205 :term:`ICECC_ENV_EXEC` 3189 :term:`ICECC_ENV_EXEC`
3206 Points to the ``icecc-create-env`` script that you provide. This 3190 Points to the ``icecc-create-env`` script that you provide. This
3207 variable is used by the :ref:`icecc <ref-classes-icecc>` class. You 3191 variable is used by the :ref:`ref-classes-icecc` class. You
3208 set this variable in your ``local.conf`` file. 3192 set this variable in your ``local.conf`` file.
3209 3193
3210 If you do not point to a script that you provide, the OpenEmbedded 3194 If you do not point to a script that you provide, the OpenEmbedded
@@ -3241,13 +3225,13 @@ system and gives an overview of their function and contents.
3241 :term:`ICECC_PATH` 3225 :term:`ICECC_PATH`
3242 The location of the ``icecc`` binary. You can set this variable in 3226 The location of the ``icecc`` binary. You can set this variable in
3243 your ``local.conf`` file. If your ``local.conf`` file does not define 3227 your ``local.conf`` file. If your ``local.conf`` file does not define
3244 this variable, the :ref:`icecc <ref-classes-icecc>` class attempts 3228 this variable, the :ref:`ref-classes-icecc` class attempts
3245 to define it by locating ``icecc`` using ``which``. 3229 to define it by locating ``icecc`` using ``which``.
3246 3230
3247 :term:`ICECC_RECIPE_DISABLE` 3231 :term:`ICECC_RECIPE_DISABLE`
3248 Identifies user recipes that you do not want the Icecream distributed 3232 Identifies user recipes that you do not want the Icecream distributed
3249 compile support to consider. This variable is used by the 3233 compile support to consider. This variable is used by the
3250 :ref:`icecc <ref-classes-icecc>` class. You set this variable in 3234 :ref:`ref-classes-icecc` class. You set this variable in
3251 your ``local.conf`` file. 3235 your ``local.conf`` file.
3252 3236
3253 When you list recipes using this variable, you are excluding them 3237 When you list recipes using this variable, you are excluding them
@@ -3259,7 +3243,7 @@ system and gives an overview of their function and contents.
3259 :term:`PARALLEL_MAKE` variable that you want to 3243 :term:`PARALLEL_MAKE` variable that you want to
3260 force remote distributed compilation on using the Icecream 3244 force remote distributed compilation on using the Icecream
3261 distributed compile support. This variable is used by the 3245 distributed compile support. This variable is used by the
3262 :ref:`icecc <ref-classes-icecc>` class. You set this variable in 3246 :ref:`ref-classes-icecc` class. You set this variable in
3263 your ``local.conf`` file. 3247 your ``local.conf`` file.
3264 3248
3265 :term:`IMAGE_BASENAME` 3249 :term:`IMAGE_BASENAME`
@@ -3301,12 +3285,12 @@ system and gives an overview of their function and contents.
3301 ":doc:`/ref-manual/kickstart`" chapter. 3285 ":doc:`/ref-manual/kickstart`" chapter.
3302 3286
3303 :term:`IMAGE_BUILDINFO_FILE` 3287 :term:`IMAGE_BUILDINFO_FILE`
3304 When using the :ref:`image-buildinfo <ref-classes-image-buildinfo>` class, 3288 When using the :ref:`ref-classes-image-buildinfo` class,
3305 specifies the file in the image to write the build information into. The 3289 specifies the file in the image to write the build information into. The
3306 default value is "``${sysconfdir}/buildinfo``". 3290 default value is "``${sysconfdir}/buildinfo``".
3307 3291
3308 :term:`IMAGE_BUILDINFO_VARS` 3292 :term:`IMAGE_BUILDINFO_VARS`
3309 When using the :ref:`image-buildinfo <ref-classes-image-buildinfo>` class, 3293 When using the :ref:`ref-classes-image-buildinfo` class,
3310 specifies the list of variables to include in the `Build Configuration` 3294 specifies the list of variables to include in the `Build Configuration`
3311 section of the output file (as a space-separated list). Defaults to 3295 section of the output file (as a space-separated list). Defaults to
3312 ":term:`DISTRO` :term:`DISTRO_VERSION`". 3296 ":term:`DISTRO` :term:`DISTRO_VERSION`".
@@ -3331,7 +3315,7 @@ system and gives an overview of their function and contents.
3331 3315
3332 You typically do not need to set this variable unless you are adding 3316 You typically do not need to set this variable unless you are adding
3333 support for a new image type. For more examples on how to set this 3317 support for a new image type. For more examples on how to set this
3334 variable, see the :ref:`image_types <ref-classes-image_types>` 3318 variable, see the :ref:`ref-classes-image_types`
3335 class file, which is ``meta/classes-recipe/image_types.bbclass``. 3319 class file, which is ``meta/classes-recipe/image_types.bbclass``.
3336 3320
3337 :term:`IMAGE_DEVICE_TABLES` 3321 :term:`IMAGE_DEVICE_TABLES`
@@ -3421,16 +3405,15 @@ system and gives an overview of their function and contents.
3421 3405
3422 :term:`IMAGE_INSTALL` 3406 :term:`IMAGE_INSTALL`
3423 Used by recipes to specify the packages to install into an image 3407 Used by recipes to specify the packages to install into an image
3424 through the :ref:`image <ref-classes-image>` class. Use the 3408 through the :ref:`ref-classes-image` class. Use the
3425 :term:`IMAGE_INSTALL` variable with care to avoid ordering issues. 3409 :term:`IMAGE_INSTALL` variable with care to avoid ordering issues.
3426 3410
3427 Image recipes set :term:`IMAGE_INSTALL` to specify the packages to 3411 Image recipes set :term:`IMAGE_INSTALL` to specify the packages to
3428 install into an image through :ref:`ref-classes-image`. Additionally, 3412 install into an image through :ref:`ref-classes-image`. Additionally,
3429 there are "helper" classes such as the 3413 there are "helper" classes such as the :ref:`ref-classes-core-image`
3430 :ref:`core-image <ref-classes-core-image>` class which can 3414 class which can take lists used with :term:`IMAGE_FEATURES` and turn
3431 take lists used with :term:`IMAGE_FEATURES` and turn them into 3415 them into auto-generated entries in :term:`IMAGE_INSTALL` in addition
3432 auto-generated entries in :term:`IMAGE_INSTALL` in addition to its 3416 to its default contents.
3433 default contents.
3434 3417
3435 When you use this variable, it is best to use it as follows:: 3418 When you use this variable, it is best to use it as follows::
3436 3419
@@ -3563,19 +3546,16 @@ system and gives an overview of their function and contents.
3563 :term:`IMAGE_PKGTYPE` 3546 :term:`IMAGE_PKGTYPE`
3564 Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the 3547 Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the
3565 OpenEmbedded build system. The variable is defined appropriately by 3548 OpenEmbedded build system. The variable is defined appropriately by
3566 the :ref:`package_deb <ref-classes-package_deb>`, 3549 the :ref:`ref-classes-package_deb`, :ref:`ref-classes-package_rpm`,
3567 :ref:`package_rpm <ref-classes-package_rpm>`, 3550 :ref:`ref-classes-package_ipk`, or :ref:`ref-classes-package_tar` class.
3568 :ref:`package_ipk <ref-classes-package_ipk>`, or
3569 :ref:`package_tar <ref-classes-package_tar>` class.
3570 3551
3571 .. note:: 3552 .. note::
3572 3553
3573 The ``package_tar`` class is broken and is not supported. It is 3554 The ``package_tar`` class is broken and is not supported. It is
3574 recommended that you do not use it. 3555 recommended that you do not use it.
3575 3556
3576 The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` and 3557 The :ref:`ref-classes-populate-sdk-*` and :ref:`ref-classes-image`
3577 :ref:`image <ref-classes-image>` classes use the :term:`IMAGE_PKGTYPE` 3558 classes use the :term:`IMAGE_PKGTYPE` for packaging up images and SDKs.
3578 for packaging up images and SDKs.
3579 3559
3580 You should not set the :term:`IMAGE_PKGTYPE` manually. Rather, the 3560 You should not set the :term:`IMAGE_PKGTYPE` manually. Rather, the
3581 variable is set indirectly through the appropriate 3561 variable is set indirectly through the appropriate
@@ -3672,7 +3652,7 @@ system and gives an overview of their function and contents.
3672 3652
3673 :term:`IMAGE_TYPEDEP` 3653 :term:`IMAGE_TYPEDEP`
3674 Specifies a dependency from one image type on another. Here is an 3654 Specifies a dependency from one image type on another. Here is an
3675 example from the :ref:`image-live <ref-classes-image-live>` class:: 3655 example from the :ref:`ref-classes-image-live` class::
3676 3656
3677 IMAGE_TYPEDEP:live = "ext3" 3657 IMAGE_TYPEDEP:live = "ext3"
3678 3658
@@ -3739,14 +3719,14 @@ system and gives an overview of their function and contents.
3739 the build artifacts. 3719 the build artifacts.
3740 3720
3741 :term:`IMGDEPLOYDIR` 3721 :term:`IMGDEPLOYDIR`
3742 When inheriting the :ref:`image <ref-classes-image>` class directly or 3722 When inheriting the :ref:`ref-classes-image` class directly or
3743 through the :ref:`core-image <ref-classes-core-image>` class, the 3723 through the :ref:`ref-classes-core-image` class, the
3744 :term:`IMGDEPLOYDIR` points to a temporary work area for deployed files 3724 :term:`IMGDEPLOYDIR` points to a temporary work area for deployed files
3745 that is set in the ``image`` class as follows:: 3725 that is set in the ``image`` class as follows::
3746 3726
3747 IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete" 3727 IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete"
3748 3728
3749 Recipes inheriting the :ref:`image <ref-classes-image>` class should copy 3729 Recipes inheriting the :ref:`ref-classes-image` class should copy
3750 files to be deployed into :term:`IMGDEPLOYDIR`, and the class will take 3730 files to be deployed into :term:`IMGDEPLOYDIR`, and the class will take
3751 care of copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. 3731 care of copying them into :term:`DEPLOY_DIR_IMAGE` afterwards.
3752 3732
@@ -3889,10 +3869,9 @@ system and gives an overview of their function and contents.
3889 :term:`INHIBIT_SYSROOT_STRIP` variable to "1" in your recipe, you inhibit 3869 :term:`INHIBIT_SYSROOT_STRIP` variable to "1" in your recipe, you inhibit
3890 this stripping. 3870 this stripping.
3891 3871
3892 If you want to use this variable, include the 3872 If you want to use this variable, include the :ref:`ref-classes-staging`
3893 :ref:`staging <ref-classes-staging>` class. This class uses a 3873 class. This class uses a ``sys_strip()`` function to test for the variable
3894 ``sys_strip()`` function to test for the variable and acts 3874 and acts accordingly.
3895 accordingly.
3896 3875
3897 .. note:: 3876 .. note::
3898 3877
@@ -3945,11 +3924,12 @@ system and gives an overview of their function and contents.
3945 section in the Yocto Project Development Tasks Manual. 3924 section in the Yocto Project Development Tasks Manual.
3946 3925
3947 :term:`INITRAMFS_DEPLOY_DIR_IMAGE` 3926 :term:`INITRAMFS_DEPLOY_DIR_IMAGE`
3948 Indicates the deploy directory used by :ref:`ref-tasks-bundle_initramfs` where the 3927 Indicates the deploy directory used by :ref:`ref-tasks-bundle_initramfs`
3949 :term:`INITRAMFS_IMAGE` will be fetched from. 3928 where the :term:`INITRAMFS_IMAGE` will be fetched from. This variable is
3950 This variable is set by default to ``${DEPLOY_DIR_IMAGE}`` in the 3929 set by default to ``${DEPLOY_DIR_IMAGE}`` in the
3951 :ref:`kernel <ref-classes-kernel>` class and it's only meant to be changed 3930 :ref:`ref-classes-kernel` class and it's only meant to be changed when
3952 when building an :term:`Initramfs` image from a separate multiconfig via :term:`INITRAMFS_MULTICONFIG`. 3931 building an :term:`Initramfs` image from a separate multiconfig via
3932 :term:`INITRAMFS_MULTICONFIG`.
3953 3933
3954 :term:`INITRAMFS_FSTYPES` 3934 :term:`INITRAMFS_FSTYPES`
3955 Defines the format for the output image of an initial RAM filesystem 3935 Defines the format for the output image of an initial RAM filesystem
@@ -3988,9 +3968,9 @@ system and gives an overview of their function and contents.
3988 3968
3989 You can also find more information by referencing the 3969 You can also find more information by referencing the
3990 ``meta-poky/conf/templates/default/local.conf.sample.extended`` 3970 ``meta-poky/conf/templates/default/local.conf.sample.extended``
3991 configuration file in the Source Directory, the :ref:`image 3971 configuration file in the Source Directory, the :ref:`ref-classes-image`
3992 <ref-classes-image>` class, and the :ref:`kernel <ref-classes-kernel>` 3972 class, and the :ref:`ref-classes-kernel` class to see how to use the
3993 class to see how to use the :term:`INITRAMFS_IMAGE` variable. 3973 :term:`INITRAMFS_IMAGE` variable.
3994 3974
3995 If :term:`INITRAMFS_IMAGE` is empty, which is the default, then no 3975 If :term:`INITRAMFS_IMAGE` is empty, which is the default, then no
3996 :term:`Initramfs` image is built. 3976 :term:`Initramfs` image is built.
@@ -4037,8 +4017,7 @@ system and gives an overview of their function and contents.
4037 4017
4038 INITRAMFS_IMAGE_BUNDLE = "1" 4018 INITRAMFS_IMAGE_BUNDLE = "1"
4039 4019
4040 By default, the 4020 By default, the :ref:`ref-classes-kernel` class sets this variable to a
4041 :ref:`kernel <ref-classes-kernel>` class sets this variable to a
4042 null string as follows:: 4021 null string as follows::
4043 4022
4044 INITRAMFS_IMAGE_BUNDLE ?= "" 4023 INITRAMFS_IMAGE_BUNDLE ?= ""
@@ -4071,7 +4050,8 @@ system and gives an overview of their function and contents.
4071 information. 4050 information.
4072 4051
4073 :term:`INITRAMFS_MULTICONFIG` 4052 :term:`INITRAMFS_MULTICONFIG`
4074 Defines the multiconfig to create a multiconfig dependency to be used by the :ref:`kernel <ref-classes-kernel>` class. 4053 Defines the multiconfig to create a multiconfig dependency to be used by
4054 the :ref:`ref-classes-kernel` class.
4075 4055
4076 This allows the kernel to bundle an :term:`INITRAMFS_IMAGE` coming from 4056 This allows the kernel to bundle an :term:`INITRAMFS_IMAGE` coming from
4077 a separate multiconfig, this is meant to be used in addition to :term:`INITRAMFS_DEPLOY_DIR_IMAGE`. 4057 a separate multiconfig, this is meant to be used in addition to :term:`INITRAMFS_DEPLOY_DIR_IMAGE`.
@@ -4097,7 +4077,7 @@ system and gives an overview of their function and contents.
4097 initial RAM disk (``initrd``). 4077 initial RAM disk (``initrd``).
4098 4078
4099 The :term:`INITRD` variable is an optional variable used with the 4079 The :term:`INITRD` variable is an optional variable used with the
4100 :ref:`image-live <ref-classes-image-live>` class. 4080 :ref:`ref-classes-image-live` class.
4101 4081
4102 :term:`INITRD_IMAGE` 4082 :term:`INITRD_IMAGE`
4103 When building a "live" bootable image (i.e. when 4083 When building a "live" bootable image (i.e. when
@@ -4106,8 +4086,7 @@ system and gives an overview of their function and contents.
4106 provide the initial RAM disk image. The default value is 4086 provide the initial RAM disk image. The default value is
4107 "core-image-minimal-initramfs". 4087 "core-image-minimal-initramfs".
4108 4088
4109 See the :ref:`image-live <ref-classes-image-live>` class for more 4089 See the :ref:`ref-classes-image-live` class for more information.
4110 information.
4111 4090
4112 :term:`INITSCRIPT_NAME` 4091 :term:`INITSCRIPT_NAME`
4113 The filename of the initialization script as installed to 4092 The filename of the initialization script as installed to
@@ -4134,7 +4113,7 @@ system and gives an overview of their function and contents.
4134 in initlevels 2 and 5, and stops the script in levels 0, 1 and 6. 4113 in initlevels 2 and 5, and stops the script in levels 0, 1 and 6.
4135 4114
4136 The variable's default value is "defaults", which is set in the 4115 The variable's default value is "defaults", which is set in the
4137 :ref:`update-rc.d <ref-classes-update-rc.d>` class. 4116 :ref:`ref-classes-update-rc.d` class.
4138 4117
4139 The value in :term:`INITSCRIPT_PARAMS` is passed through to the 4118 The value in :term:`INITSCRIPT_PARAMS` is passed through to the
4140 ``update-rc.d`` command. For more information on valid parameters, 4119 ``update-rc.d`` command. For more information on valid parameters,
@@ -4212,7 +4191,7 @@ system and gives an overview of their function and contents.
4212 BSP. 4191 BSP.
4213 4192
4214 :term:`KBUILD_DEFCONFIG` 4193 :term:`KBUILD_DEFCONFIG`
4215 When used with the :ref:`kernel-yocto <ref-classes-kernel-yocto>` 4194 When used with the :ref:`ref-classes-kernel-yocto`
4216 class, specifies an "in-tree" kernel configuration file for use 4195 class, specifies an "in-tree" kernel configuration file for use
4217 during a kernel build. 4196 during a kernel build.
4218 4197
@@ -4245,7 +4224,7 @@ system and gives an overview of their function and contents.
4245 section in the Yocto Project Linux Kernel Development Manual. 4224 section in the Yocto Project Linux Kernel Development Manual.
4246 4225
4247 :term:`KCONFIG_MODE` 4226 :term:`KCONFIG_MODE`
4248 When used with the :ref:`kernel-yocto <ref-classes-kernel-yocto>` 4227 When used with the :ref:`ref-classes-kernel-yocto`
4249 class, specifies the kernel configuration values to use for options 4228 class, specifies the kernel configuration values to use for options
4250 not specified in the provided ``defconfig`` file. Valid options are:: 4229 not specified in the provided ``defconfig`` file. Valid options are::
4251 4230
@@ -4302,12 +4281,12 @@ system and gives an overview of their function and contents.
4302 4281
4303 :term:`KERNEL_CLASSES` 4282 :term:`KERNEL_CLASSES`
4304 A list of classes defining kernel image types that the 4283 A list of classes defining kernel image types that the
4305 :ref:`kernel <ref-classes-kernel>` class should inherit. You typically 4284 :ref:`ref-classes-kernel` class should inherit. You typically
4306 append this variable to enable extended image types. An example is 4285 append this variable to enable extended image types. An example is
4307 ":ref:`kernel-fitimage <ref-classes-kernel-fitimage>`", which enables 4286 ":ref:`ref-classes-kernel-fitimage`", which enables
4308 fitImage support and resides in ``meta/classes-recipe/kernel-fitimage.bbclass``. 4287 fitImage support and resides in ``meta/classes-recipe/kernel-fitimage.bbclass``.
4309 You can register custom kernel image types with the 4288 You can register custom kernel image types with the
4310 :ref:`kernel <ref-classes-kernel>` class using this variable. 4289 :ref:`ref-classes-kernel` class using this variable.
4311 4290
4312 :term:`KERNEL_DEBUG_TIMESTAMPS` 4291 :term:`KERNEL_DEBUG_TIMESTAMPS`
4313 If set to "1", enables timestamping functionality during building 4292 If set to "1", enables timestamping functionality during building
@@ -4329,9 +4308,8 @@ system and gives an overview of their function and contents.
4329 There is legacy support for specifying the full path to the device 4308 There is legacy support for specifying the full path to the device
4330 tree. However, providing just the ``.dtb`` file is preferred. 4309 tree. However, providing just the ``.dtb`` file is preferred.
4331 4310
4332 In order to use this variable, the 4311 In order to use this variable, the :ref:`ref-classes-kernel-devicetree`
4333 :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must 4312 class must be inherited.
4334 be inherited.
4335 4313
4336 :term:`KERNEL_DTB_LINK_NAME` 4314 :term:`KERNEL_DTB_LINK_NAME`
4337 The link name of the kernel device tree binary (DTB). This variable 4315 The link name of the kernel device tree binary (DTB). This variable
@@ -4366,9 +4344,8 @@ system and gives an overview of their function and contents.
4366 system when generating the device trees (via ``DTC_FLAGS`` environment 4344 system when generating the device trees (via ``DTC_FLAGS`` environment
4367 variable). 4345 variable).
4368 4346
4369 In order to use this variable, the 4347 In order to use this variable, the :ref:`ref-classes-kernel-devicetree`
4370 :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must 4348 class must be inherited.
4371 be inherited.
4372 4349
4373 :term:`KERNEL_EXTRA_ARGS` 4350 :term:`KERNEL_EXTRA_ARGS`
4374 Specifies additional ``make`` command-line arguments the OpenEmbedded 4351 Specifies additional ``make`` command-line arguments the OpenEmbedded
@@ -4519,9 +4496,8 @@ system and gives an overview of their function and contents.
4519 4496
4520 :term:`KERNEL_PATH` 4497 :term:`KERNEL_PATH`
4521 The location of the kernel sources. This variable is set to the value 4498 The location of the kernel sources. This variable is set to the value
4522 of the :term:`STAGING_KERNEL_DIR` within 4499 of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module`
4523 the :ref:`module <ref-classes-module>` class. For information on 4500 class. For information on how this variable is used, see the
4524 how this variable is used, see the
4525 ":ref:`kernel-dev/common:incorporating out-of-tree modules`" 4501 ":ref:`kernel-dev/common:incorporating out-of-tree modules`"
4526 section in the Yocto Project Linux Kernel Development Manual. 4502 section in the Yocto Project Linux Kernel Development Manual.
4527 4503
@@ -4533,9 +4509,8 @@ system and gives an overview of their function and contents.
4533 4509
4534 :term:`KERNEL_SRC` 4510 :term:`KERNEL_SRC`
4535 The location of the kernel sources. This variable is set to the value 4511 The location of the kernel sources. This variable is set to the value
4536 of the :term:`STAGING_KERNEL_DIR` within 4512 of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module`
4537 the :ref:`module <ref-classes-module>` class. For information on 4513 class. For information on how this variable is used, see the
4538 how this variable is used, see the
4539 ":ref:`kernel-dev/common:incorporating out-of-tree modules`" 4514 ":ref:`kernel-dev/common:incorporating out-of-tree modules`"
4540 section in the Yocto Project Linux Kernel Development Manual. 4515 section in the Yocto Project Linux Kernel Development Manual.
4541 4516
@@ -4613,7 +4588,7 @@ system and gives an overview of their function and contents.
4613 :term:`LABELS` 4588 :term:`LABELS`
4614 Provides a list of targets for automatic configuration. 4589 Provides a list of targets for automatic configuration.
4615 4590
4616 See the :ref:`grub-efi <ref-classes-grub-efi>` class for more 4591 See the :ref:`ref-classes-grub-efi` class for more
4617 information on how this variable is used. 4592 information on how this variable is used.
4618 4593
4619 :term:`LAYERDEPENDS` 4594 :term:`LAYERDEPENDS`
@@ -4715,10 +4690,11 @@ system and gives an overview of their function and contents.
4715 4690
4716 :term:`LEAD_SONAME` 4691 :term:`LEAD_SONAME`
4717 Specifies the lead (or primary) compiled library file (i.e. ``.so``) 4692 Specifies the lead (or primary) compiled library file (i.e. ``.so``)
4718 that the :ref:`debian <ref-classes-debian>` class applies its 4693 that the :ref:`ref-classes-debian` class applies its
4719 naming policy to given a recipe that packages multiple libraries. 4694 naming policy to given a recipe that packages multiple libraries.
4720 4695
4721 This variable works in conjunction with the :ref:`debian <ref-classes-debian>` class. 4696 This variable works in conjunction with the :ref:`ref-classes-debian`
4697 class.
4722 4698
4723 :term:`LIC_FILES_CHKSUM` 4699 :term:`LIC_FILES_CHKSUM`
4724 Checksums of the license text in the recipe source code. 4700 Checksums of the license text in the recipe source code.
@@ -5103,7 +5079,7 @@ system and gives an overview of their function and contents.
5103 determined by :term:`COREBASE`). 5079 determined by :term:`COREBASE`).
5104 5080
5105 :term:`MIME_XDG_PACKAGES` 5081 :term:`MIME_XDG_PACKAGES`
5106 The current implementation of the :ref:`mime-xdg <ref-classes-mime-xdg>` 5082 The current implementation of the :ref:`ref-classes-mime-xdg`
5107 class cannot detect ``.desktop`` files installed through absolute 5083 class cannot detect ``.desktop`` files installed through absolute
5108 symbolic links. Use this setting to make the class create post-install 5084 symbolic links. Use this setting to make the class create post-install
5109 and post-remove scripts for these packages anyway, to invoke the 5085 and post-remove scripts for these packages anyway, to invoke the
@@ -5131,20 +5107,18 @@ system and gives an overview of their function and contents.
5131 .. note:: 5107 .. note::
5132 5108
5133 The "ML" in :term:`MLPREFIX` stands for "MultiLib". This representation 5109 The "ML" in :term:`MLPREFIX` stands for "MultiLib". This representation
5134 is historical and comes from a time when 5110 is historical and comes from a time when ":ref:`ref-classes-nativesdk`"
5135 ":ref:`nativesdk <ref-classes-nativesdk>`"
5136 was a suffix rather than a prefix on the recipe name. When 5111 was a suffix rather than a prefix on the recipe name. When
5137 ":ref:`nativesdk <ref-classes-nativesdk>`" was turned 5112 ":ref:`ref-classes-nativesdk`" was turned into a prefix, it made sense
5138 into a prefix, it made sense to set :term:`MLPREFIX` for it as well. 5113 to set :term:`MLPREFIX` for it as well.
5139 5114
5140 To help understand when :term:`MLPREFIX` might be needed, consider when 5115 To help understand when :term:`MLPREFIX` might be needed, consider when
5141 :term:`BBCLASSEXTEND` is used to provide a 5116 :term:`BBCLASSEXTEND` is used to provide a :ref:`ref-classes-nativesdk`
5142 :ref:`nativesdk <ref-classes-nativesdk>` version of a recipe in addition 5117 version of a recipe in addition to the target version. If that recipe
5143 to the target version. If that recipe declares build-time dependencies 5118 declares build-time dependencies on tasks in other recipes by using
5144 on tasks in other recipes by using :term:`DEPENDS`, then a dependency on 5119 :term:`DEPENDS`, then a dependency on "foo" will automatically get
5145 "foo" will automatically get rewritten to a dependency on 5120 rewritten to a dependency on "nativesdk-foo". However, dependencies like
5146 "nativesdk-foo". However, dependencies like the following will not 5121 the following will not get rewritten automatically::
5147 get rewritten automatically::
5148 5122
5149 do_foo[depends] += "recipe:do_foo" 5123 do_foo[depends] += "recipe:do_foo"
5150 5124
@@ -5243,8 +5217,7 @@ system and gives an overview of their function and contents.
5243 5217
5244 ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS} 5218 ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS}
5245 5219
5246 Some classes (e.g. 5220 Some classes (e.g. :ref:`ref-classes-cross-canadian`) modify the
5247 :ref:`cross-canadian <ref-classes-cross-canadian>`) modify the
5248 :term:`MULTIMACH_TARGET_SYS` value. 5221 :term:`MULTIMACH_TARGET_SYS` value.
5249 5222
5250 See the :term:`STAMP` variable for an example. See the 5223 See the :term:`STAMP` variable for an example. See the
@@ -5346,7 +5319,7 @@ system and gives an overview of their function and contents.
5346 The minimal command and arguments to run ``objdump``. 5319 The minimal command and arguments to run ``objdump``.
5347 5320
5348 :term:`OE_BINCONFIG_EXTRA_MANGLE` 5321 :term:`OE_BINCONFIG_EXTRA_MANGLE`
5349 When inheriting the :ref:`binconfig <ref-classes-binconfig>` class, 5322 When inheriting the :ref:`ref-classes-binconfig` class,
5350 this variable specifies additional arguments passed to the "sed" 5323 this variable specifies additional arguments passed to the "sed"
5351 command. The sed command alters any paths in configuration scripts 5324 command. The sed command alters any paths in configuration scripts
5352 that have been set up during compilation. Inheriting this class 5325 that have been set up during compilation. Inheriting this class
@@ -5412,68 +5385,67 @@ system and gives an overview of their function and contents.
5412 configuration file. 5385 configuration file.
5413 5386
5414 :term:`OVERLAYFS_ETC_DEVICE` 5387 :term:`OVERLAYFS_ETC_DEVICE`
5415 When the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` class is 5388 When the :ref:`ref-classes-overlayfs-etc` class is
5416 inherited, specifies the device to be mounted for the read/write 5389 inherited, specifies the device to be mounted for the read/write
5417 layer of ``/etc``. There is no default, so you must set this if you 5390 layer of ``/etc``. There is no default, so you must set this if you
5418 wish to enable :ref:`overlayfs-etc <ref-classes-overlayfs-etc>`, for 5391 wish to enable :ref:`ref-classes-overlayfs-etc`, for
5419 example, assuming ``/dev/mmcblk0p2`` was the desired device:: 5392 example, assuming ``/dev/mmcblk0p2`` was the desired device::
5420 5393
5421 OVERLAYFS_ETC_DEVICE = "/dev/mmcblk0p2" 5394 OVERLAYFS_ETC_DEVICE = "/dev/mmcblk0p2"
5422 5395
5423 :term:`OVERLAYFS_ETC_EXPOSE_LOWER` 5396 :term:`OVERLAYFS_ETC_EXPOSE_LOWER`
5424 When the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` class is 5397 When the :ref:`ref-classes-overlayfs-etc` class is
5425 inherited, if set to "1" then a read-only access to the original 5398 inherited, if set to "1" then a read-only access to the original
5426 ``/etc`` content will be provided as a ``lower/`` subdirectory of 5399 ``/etc`` content will be provided as a ``lower/`` subdirectory of
5427 :term:`OVERLAYFS_ETC_MOUNT_POINT`. The default value is "0". 5400 :term:`OVERLAYFS_ETC_MOUNT_POINT`. The default value is "0".
5428 5401
5429 :term:`OVERLAYFS_ETC_FSTYPE` 5402 :term:`OVERLAYFS_ETC_FSTYPE`
5430 When the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` class is 5403 When the :ref:`ref-classes-overlayfs-etc` class is
5431 inherited, specifies the file system type for the read/write 5404 inherited, specifies the file system type for the read/write
5432 layer of ``/etc``. There is no default, so you must set this if you 5405 layer of ``/etc``. There is no default, so you must set this if you
5433 wish to enable :ref:`overlayfs-etc <ref-classes-overlayfs-etc>`, 5406 wish to enable :ref:`ref-classes-overlayfs-etc`,
5434 for example, assuming the file system is ext4:: 5407 for example, assuming the file system is ext4::
5435 5408
5436 OVERLAYFS_ETC_FSTYPE = "ext4" 5409 OVERLAYFS_ETC_FSTYPE = "ext4"
5437 5410
5438 :term:`OVERLAYFS_ETC_MOUNT_OPTIONS` 5411 :term:`OVERLAYFS_ETC_MOUNT_OPTIONS`
5439 When the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` class is 5412 When the :ref:`ref-classes-overlayfs-etc` class is
5440 inherited, specifies the mount options for the read-write layer. 5413 inherited, specifies the mount options for the read-write layer.
5441 The default value is "defaults". 5414 The default value is "defaults".
5442 5415
5443 :term:`OVERLAYFS_ETC_MOUNT_POINT` 5416 :term:`OVERLAYFS_ETC_MOUNT_POINT`
5444 When the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` class is 5417 When the :ref:`ref-classes-overlayfs-etc` class is
5445 inherited, specifies the parent mount path for the filesystem layers. 5418 inherited, specifies the parent mount path for the filesystem layers.
5446 There is no default, so you must set this if you wish to enable 5419 There is no default, so you must set this if you wish to enable
5447 :ref:`overlayfs-etc <ref-classes-overlayfs-etc>`, for example if 5420 :ref:`ref-classes-overlayfs-etc`, for example if the desired path is
5448 the desired path is "/data":: 5421 "/data"::
5449 5422
5450 OVERLAYFS_ETC_MOUNT_POINT = "/data" 5423 OVERLAYFS_ETC_MOUNT_POINT = "/data"
5451 5424
5452 :term:`OVERLAYFS_ETC_USE_ORIG_INIT_NAME` 5425 :term:`OVERLAYFS_ETC_USE_ORIG_INIT_NAME`
5453 When the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` class is 5426 When the :ref:`ref-classes-overlayfs-etc` class is inherited, controls
5454 inherited, controls how the generated init will be named. For more 5427 how the generated init will be named. For more information, see the
5455 information, see the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` 5428 :ref:`ref-classes-overlayfs-etc` class documentation. The default value
5456 class documentation. The default value is "1". 5429 is "1".
5457 5430
5458 :term:`OVERLAYFS_MOUNT_POINT` 5431 :term:`OVERLAYFS_MOUNT_POINT`
5459 When inheriting the :ref:`overlayfs <ref-classes-overlayfs>` class, 5432 When inheriting the :ref:`ref-classes-overlayfs` class,
5460 specifies mount point(s) to be used. For example:: 5433 specifies mount point(s) to be used. For example::
5461 5434
5462 OVERLAYFS_MOUNT_POINT[data] = "/data" 5435 OVERLAYFS_MOUNT_POINT[data] = "/data"
5463 5436
5464 The assumes you have a ``data.mount`` systemd unit defined elsewhere 5437 The assumes you have a ``data.mount`` systemd unit defined elsewhere in
5465 in your BSP (e.g. in ``systemd-machine-units`` recipe) and it is 5438 your BSP (e.g. in ``systemd-machine-units`` recipe) and it is installed
5466 installed into the image. For more information see 5439 into the image. For more information see :ref:`ref-classes-overlayfs`.
5467 :ref:`overlayfs <ref-classes-overlayfs>`.
5468 5440
5469 .. note:: 5441 .. note::
5470 5442
5471 Although the :ref:`overlayfs <ref-classes-overlayfs>` class is 5443 Although the :ref:`ref-classes-overlayfs` class is
5472 inherited by individual recipes, :term:`OVERLAYFS_MOUNT_POINT` 5444 inherited by individual recipes, :term:`OVERLAYFS_MOUNT_POINT`
5473 should be set in your machine configuration. 5445 should be set in your machine configuration.
5474 5446
5475 :term:`OVERLAYFS_QA_SKIP` 5447 :term:`OVERLAYFS_QA_SKIP`
5476 When inheriting the :ref:`overlayfs <ref-classes-overlayfs>` class, 5448 When inheriting the :ref:`ref-classes-overlayfs` class,
5477 provides the ability to disable QA checks for particular overlayfs 5449 provides the ability to disable QA checks for particular overlayfs
5478 mounts. For example:: 5450 mounts. For example::
5479 5451
@@ -5481,12 +5453,12 @@ system and gives an overview of their function and contents.
5481 5453
5482 .. note:: 5454 .. note::
5483 5455
5484 Although the :ref:`overlayfs <ref-classes-overlayfs>` class is 5456 Although the :ref:`ref-classes-overlayfs` class is
5485 inherited by individual recipes, :term:`OVERLAYFS_QA_SKIP` 5457 inherited by individual recipes, :term:`OVERLAYFS_QA_SKIP`
5486 should be set in your machine configuration. 5458 should be set in your machine configuration.
5487 5459
5488 :term:`OVERLAYFS_WRITABLE_PATHS` 5460 :term:`OVERLAYFS_WRITABLE_PATHS`
5489 When inheriting the :ref:`overlayfs <ref-classes-overlayfs>` class, 5461 When inheriting the :ref:`ref-classes-overlayfs` class,
5490 specifies writable paths used at runtime for the recipe. For 5462 specifies writable paths used at runtime for the recipe. For
5491 example:: 5463 example::
5492 5464
@@ -5598,7 +5570,7 @@ system and gives an overview of their function and contents.
5598 5570
5599 .. note:: 5571 .. note::
5600 5572
5601 While it is a legal option, the :ref:`package_tar <ref-classes-package_tar>` 5573 While it is a legal option, the :ref:`ref-classes-package_tar`
5602 class has limited functionality due to no support for package 5574 class has limited functionality due to no support for package
5603 dependencies by that backend. Therefore, it is recommended that 5575 dependencies by that backend. Therefore, it is recommended that
5604 you do not use it. 5576 you do not use it.
@@ -5936,16 +5908,15 @@ system and gives an overview of their function and contents.
5936 A space-separated list of configuration options generated from the 5908 A space-separated list of configuration options generated from the
5937 :term:`PACKAGECONFIG` setting. 5909 :term:`PACKAGECONFIG` setting.
5938 5910
5939 Classes such as :ref:`autotools <ref-classes-autotools>` and 5911 Classes such as :ref:`ref-classes-autotools` and :ref:`ref-classes-cmake`
5940 :ref:`cmake <ref-classes-cmake>` use :term:`PACKAGECONFIG_CONFARGS` to 5912 use :term:`PACKAGECONFIG_CONFARGS` to pass :term:`PACKAGECONFIG` options
5941 pass :term:`PACKAGECONFIG` options to ``configure`` and ``cmake``, 5913 to ``configure`` and ``cmake``, respectively. If you are using
5942 respectively. If you are using :term:`PACKAGECONFIG` but not a class that 5914 :term:`PACKAGECONFIG` but not a class that handles the
5943 handles the :ref:`ref-tasks-configure` task, then you need to use 5915 :ref:`ref-tasks-configure` task, then you need to use
5944 :term:`PACKAGECONFIG_CONFARGS` appropriately. 5916 :term:`PACKAGECONFIG_CONFARGS` appropriately.
5945 5917
5946 :term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY` 5918 :term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY`
5947 For recipes inheriting the 5919 For recipes inheriting the :ref:`ref-classes-packagegroup` class, setting
5948 :ref:`packagegroup <ref-classes-packagegroup>` class, setting
5949 :term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY` to "1" specifies that the 5920 :term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY` to "1" specifies that the
5950 normal complementary packages (i.e. ``-dev``, ``-dbg``, and so forth) 5921 normal complementary packages (i.e. ``-dev``, ``-dbg``, and so forth)
5951 should not be automatically created by the ``packagegroup`` recipe, 5922 should not be automatically created by the ``packagegroup`` recipe,
@@ -6097,9 +6068,8 @@ system and gives an overview of their function and contents.
6097 :term:`PE` is the default value of the :term:`PKGE` variable. 6068 :term:`PE` is the default value of the :term:`PKGE` variable.
6098 6069
6099 :term:`PEP517_WHEEL_PATH` 6070 :term:`PEP517_WHEEL_PATH`
6100 When used by recipes that inherit the 6071 When used by recipes that inherit the :ref:`ref-classes-python_pep517`
6101 :ref:`python_pep517 <ref-classes-python_pep517>` class, 6072 class, denotes the path to ``dist/`` (short for distribution) where the
6102 denotes the path to ``dist/`` (short for distribution) where the
6103 binary archive ``wheel`` is built. 6073 binary archive ``wheel`` is built.
6104 6074
6105 :term:`PERSISTENT_DIR` 6075 :term:`PERSISTENT_DIR`
@@ -6112,10 +6082,10 @@ system and gives an overview of their function and contents.
6112 ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`} 6082 ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`}
6113 6083
6114 :term:`PIXBUF_PACKAGES` 6084 :term:`PIXBUF_PACKAGES`
6115 When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>` 6085 When inheriting the :ref:`ref-classes-pixbufcache`
6116 class, this variable identifies packages that contain the pixbuf 6086 class, this variable identifies packages that contain the pixbuf
6117 loaders used with ``gdk-pixbuf``. By default, the 6087 loaders used with ``gdk-pixbuf``. By default, the
6118 :ref:`pixbufcache <ref-classes-pixbufcache>` class assumes that 6088 :ref:`ref-classes-pixbufcache` class assumes that
6119 the loaders are in the recipe's main package (i.e. 6089 the loaders are in the recipe's main package (i.e.
6120 ``${``\ :term:`PN`\ ``}``). Use this variable if the 6090 ``${``\ :term:`PN`\ ``}``). Use this variable if the
6121 loaders you need are in a package other than that main package. 6091 loaders you need are in a package other than that main package.
@@ -6128,9 +6098,8 @@ system and gives an overview of their function and contents.
6128 6098
6129 When using the :term:`PKG` variable, you must use a package name override. 6099 When using the :term:`PKG` variable, you must use a package name override.
6130 6100
6131 For example, when the :ref:`debian <ref-classes-debian>` class 6101 For example, when the :ref:`ref-classes-debian` class renames the output
6132 renames the output package, it does so by setting 6102 package, it does so by setting ``PKG:packagename``.
6133 ``PKG:packagename``.
6134 6103
6135 :term:`PKG_CONFIG_PATH` 6104 :term:`PKG_CONFIG_PATH`
6136 The path to ``pkg-config`` files for the current build context. 6105 The path to ``pkg-config`` files for the current build context.
@@ -6531,7 +6500,7 @@ system and gives an overview of their function and contents.
6531 :term:`PV` is the default value of the :term:`PKGV` variable. 6500 :term:`PV` is the default value of the :term:`PKGV` variable.
6532 6501
6533 :term:`PYPI_PACKAGE` 6502 :term:`PYPI_PACKAGE`
6534 When inheriting the :ref:`pypi <ref-classes-pypi>` class, specifies the 6503 When inheriting the :ref:`ref-classes-pypi` class, specifies the
6535 `PyPI <https://pypi.org/>`__ package name to be built. The default value 6504 `PyPI <https://pypi.org/>`__ package name to be built. The default value
6536 is set based upon :term:`BPN` (stripping any "python-" or "python3-" 6505 is set based upon :term:`BPN` (stripping any "python-" or "python3-"
6537 prefix off if present), however for some packages it will need to be set 6506 prefix off if present), however for some packages it will need to be set
@@ -6539,22 +6508,20 @@ system and gives an overview of their function and contents.
6539 package name has a prefix, underscores, uppercase letters etc.) 6508 package name has a prefix, underscores, uppercase letters etc.)
6540 6509
6541 :term:`PYTHON_ABI` 6510 :term:`PYTHON_ABI`
6542 When used by recipes that inherit the 6511 When used by recipes that inherit the :ref:`ref-classes-setuptools3`
6543 :ref:`setuptools3 <ref-classes-setuptools3>` class, denotes the 6512 class, denotes the Application Binary Interface (ABI) currently in use
6544 Application Binary Interface (ABI) currently in use for Python. By 6513 for Python. By default, the ABI is "m". You do not have to set this
6545 default, the ABI is "m". You do not have to set this variable as the 6514 variable as the OpenEmbedded build system sets it for you.
6546 OpenEmbedded build system sets it for you.
6547 6515
6548 The OpenEmbedded build system uses the ABI to construct directory 6516 The OpenEmbedded build system uses the ABI to construct directory
6549 names used when installing the Python headers and libraries in 6517 names used when installing the Python headers and libraries in
6550 sysroot (e.g. ``.../python3.3m/...``). 6518 sysroot (e.g. ``.../python3.3m/...``).
6551 6519
6552 :term:`PYTHON_PN` 6520 :term:`PYTHON_PN`
6553 When used by recipes that inherit the 6521 When used by recipes that inherit the :ref:`ref-classes-setuptools3`
6554 :ref:`setuptools3 <ref-classes-setuptools3>` class, specifies the 6522 class, specifies the major Python version being built. For Python 3.x,
6555 major Python version being built. For Python 3.x, :term:`PYTHON_PN` would 6523 :term:`PYTHON_PN` would be "python3". You do not have to set this
6556 be "python3". You do not have to set this variable as the 6524 variable as the OpenEmbedded build system automatically sets it for you.
6557 OpenEmbedded build system automatically sets it for you.
6558 6525
6559 The variable allows recipes to use common infrastructure such as the 6526 The variable allows recipes to use common infrastructure such as the
6560 following:: 6527 following::
@@ -6685,7 +6652,7 @@ system and gives an overview of their function and contents.
6685 The package names you use with :term:`RDEPENDS` must appear as they would 6652 The package names you use with :term:`RDEPENDS` must appear as they would
6686 in the :term:`PACKAGES` variable. The :term:`PKG` variable 6653 in the :term:`PACKAGES` variable. The :term:`PKG` variable
6687 allows a different name to be used for the final package (e.g. the 6654 allows a different name to be used for the final package (e.g. the
6688 :ref:`debian <ref-classes-debian>` class uses this to rename 6655 :ref:`ref-classes-debian` class uses this to rename
6689 packages), but this final package name cannot be used with 6656 packages), but this final package name cannot be used with
6690 :term:`RDEPENDS`, which makes sense as :term:`RDEPENDS` is meant to be 6657 :term:`RDEPENDS`, which makes sense as :term:`RDEPENDS` is meant to be
6691 independent of the package format used. 6658 independent of the package format used.
@@ -6736,7 +6703,7 @@ system and gives an overview of their function and contents.
6736 See :term:`bitbake:REPODIR` in the BitBake manual. 6703 See :term:`bitbake:REPODIR` in the BitBake manual.
6737 6704
6738 :term:`REQUIRED_DISTRO_FEATURES` 6705 :term:`REQUIRED_DISTRO_FEATURES`
6739 When inheriting the :ref:`features_check <ref-classes-features_check>` 6706 When inheriting the :ref:`ref-classes-features_check`
6740 class, this variable identifies distribution features that must exist 6707 class, this variable identifies distribution features that must exist
6741 in the current configuration in order for the OpenEmbedded build 6708 in the current configuration in order for the OpenEmbedded build
6742 system to build the recipe. In other words, if the 6709 system to build the recipe. In other words, if the
@@ -6757,7 +6724,7 @@ system and gives an overview of their function and contents.
6757 for the same recipe, the :term:`REQUIRED_VERSION` value applies. 6724 for the same recipe, the :term:`REQUIRED_VERSION` value applies.
6758 6725
6759 :term:`RM_WORK_EXCLUDE` 6726 :term:`RM_WORK_EXCLUDE`
6760 With :ref:`rm_work <ref-classes-rm-work>` enabled, this variable 6727 With :ref:`ref-classes-rm-work` enabled, this variable
6761 specifies a list of recipes whose work directories should not be removed. 6728 specifies a list of recipes whose work directories should not be removed.
6762 See the ":ref:`ref-classes-rm-work`" section for more details. 6729 See the ":ref:`ref-classes-rm-work`" section for more details.
6763 6730
@@ -6789,7 +6756,7 @@ system and gives an overview of their function and contents.
6789 Indicates a filesystem image to include as the root filesystem. 6756 Indicates a filesystem image to include as the root filesystem.
6790 6757
6791 The :term:`ROOTFS` variable is an optional variable used with the 6758 The :term:`ROOTFS` variable is an optional variable used with the
6792 :ref:`image-live <ref-classes-image-live>` class. 6759 :ref:`ref-classes-image-live` class.
6793 6760
6794 :term:`ROOTFS_POSTINSTALL_COMMAND` 6761 :term:`ROOTFS_POSTINSTALL_COMMAND`
6795 Specifies a list of functions to call after the OpenEmbedded build 6762 Specifies a list of functions to call after the OpenEmbedded build
@@ -7013,7 +6980,7 @@ system and gives an overview of their function and contents.
7013 set this variable. Instead, use :term:`SDKMACHINE`. 6980 set this variable. Instead, use :term:`SDKMACHINE`.
7014 6981
7015 :term:`SDK_BUILDINFO_FILE` 6982 :term:`SDK_BUILDINFO_FILE`
7016 When using the :ref:`image-buildinfo <ref-classes-image-buildinfo>` class, 6983 When using the :ref:`ref-classes-image-buildinfo` class,
7017 specifies the file in the SDK to write the build information into. The 6984 specifies the file in the SDK to write the build information into. The
7018 default value is "``/buildinfo``". 6985 default value is "``/buildinfo``".
7019 6986
@@ -7145,7 +7112,7 @@ system and gives an overview of their function and contents.
7145 7112
7146 :term:`SDK_PREFIX` 7113 :term:`SDK_PREFIX`
7147 The toolchain binary prefix used for 7114 The toolchain binary prefix used for
7148 :ref:`nativesdk <ref-classes-nativesdk>` recipes. The 7115 :ref:`ref-classes-nativesdk` recipes. The
7149 OpenEmbedded build system uses the :term:`SDK_PREFIX` value to set the 7116 OpenEmbedded build system uses the :term:`SDK_PREFIX` value to set the
7150 :term:`TARGET_PREFIX` when building 7117 :term:`TARGET_PREFIX` when building
7151 ``nativesdk`` recipes. The default value is "${SDK_SYS}-". 7118 ``nativesdk`` recipes. The default value is "${SDK_SYS}-".
@@ -7331,25 +7298,22 @@ system and gives an overview of their function and contents.
7331 EXTRA_IMAGE_FEATURES += "read-only-rootfs" 7298 EXTRA_IMAGE_FEATURES += "read-only-rootfs"
7332 7299
7333 :term:`SETUPTOOLS_BUILD_ARGS` 7300 :term:`SETUPTOOLS_BUILD_ARGS`
7334 When used by recipes that inherit the 7301 When used by recipes that inherit the :ref:`ref-classes-setuptools3`
7335 :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable can 7302 class, this variable can be used to specify additional arguments to be
7336 be used to specify additional arguments to be passed to ``setup.py build`` 7303 passed to ``setup.py build`` in the ``setuptools3_do_compile()`` task.
7337 in the ``setuptools3_do_compile()`` task.
7338 7304
7339 :term:`SETUPTOOLS_INSTALL_ARGS` 7305 :term:`SETUPTOOLS_INSTALL_ARGS`
7340 When used by recipes that inherit the 7306 When used by recipes that inherit the :ref:`ref-classes-setuptools3`
7341 :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable can 7307 class, this variable can be used to specify additional arguments to be
7342 be used to specify additional arguments to be passed to ``setup.py install`` 7308 passed to ``setup.py install`` in the ``setuptools3_do_install()`` task.
7343 in the ``setuptools3_do_install()`` task.
7344 7309
7345 :term:`SETUPTOOLS_SETUP_PATH` 7310 :term:`SETUPTOOLS_SETUP_PATH`
7346 When used by recipes that inherit the 7311 When used by recipes that inherit the :ref:`ref-classes-setuptools3`
7347 :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable should 7312 class, this variable should be used to specify the directory in which
7348 be used to specify the directory in which the ``setup.py`` file is 7313 the ``setup.py`` file is located if it is not at the root of the source
7349 located if it is not at the root of the source tree (as specified by 7314 tree (as specified by :term:`S`). For example, in a recipe where the
7350 :term:`S`). For example, in a recipe where the sources are fetched from 7315 sources are fetched from a Git repository and ``setup.py`` is in a
7351 a Git repository and ``setup.py`` is in a ``python/pythonmodule`` 7316 ``python/pythonmodule`` subdirectory, you would have this::
7352 subdirectory, you would have this::
7353 7317
7354 S = "${WORKDIR}/git" 7318 S = "${WORKDIR}/git"
7355 SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule" 7319 SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule"
@@ -7494,7 +7458,7 @@ system and gives an overview of their function and contents.
7494 specified in :term:`SRC_URI`. 7458 specified in :term:`SRC_URI`.
7495 7459
7496 To use this variable, you must globally inherit the 7460 To use this variable, you must globally inherit the
7497 :ref:`own-mirrors <ref-classes-own-mirrors>` class and then provide 7461 :ref:`ref-classes-own-mirrors` class and then provide
7498 the URL to your mirrors. Here is the general syntax:: 7462 the URL to your mirrors. Here is the general syntax::
7499 7463
7500 INHERIT += "own-mirrors" 7464 INHERIT += "own-mirrors"
@@ -7520,7 +7484,7 @@ system and gives an overview of their function and contents.
7520 ``core-image-minimal`` for the ``qemux86-64`` machine, enabling this 7484 ``core-image-minimal`` for the ``qemux86-64`` machine, enabling this
7521 option multiplied the size of the ``tmp/deploy/spdx`` directory by a 7485 option multiplied the size of the ``tmp/deploy/spdx`` directory by a
7522 factor of 13 (+1.6 GiB for this image), compared to just using the 7486 factor of 13 (+1.6 GiB for this image), compared to just using the
7523 :ref:`create-spdx <ref-classes-create-spdx>` class with no option. 7487 :ref:`ref-classes-create-spdx` class with no option.
7524 7488
7525 Note that this option doesn't increase the size of :term:`SPDX` 7489 Note that this option doesn't increase the size of :term:`SPDX`
7526 files in ``tmp/deploy/images/MACHINE``. 7490 files in ``tmp/deploy/images/MACHINE``.
@@ -7546,7 +7510,7 @@ system and gives an overview of their function and contents.
7546 ``core-image-minimal`` for the ``qemux86-64`` machine, enabling 7510 ``core-image-minimal`` for the ``qemux86-64`` machine, enabling
7547 these options multiplied the size of the ``tmp/deploy/spdx`` 7511 these options multiplied the size of the ``tmp/deploy/spdx``
7548 directory by a factor of 11 (+1.4 GiB for this image), 7512 directory by a factor of 11 (+1.4 GiB for this image),
7549 compared to just using the :ref:`create-spdx <ref-classes-create-spdx>` 7513 compared to just using the :ref:`ref-classes-create-spdx`
7550 class with no option. 7514 class with no option.
7551 7515
7552 Note that using this option only marginally increases the size 7516 Note that using this option only marginally increases the size
@@ -7572,8 +7536,8 @@ system and gives an overview of their function and contents.
7572 directory by a factor of 3 (+291 MiB for this image), 7536 directory by a factor of 3 (+291 MiB for this image),
7573 and the size of the ``IMAGE-MACHINE.spdx.tar.zst`` in 7537 and the size of the ``IMAGE-MACHINE.spdx.tar.zst`` in
7574 ``tmp/deploy/images/MACHINE`` by a factor of 130 (+15 MiB for this 7538 ``tmp/deploy/images/MACHINE`` by a factor of 130 (+15 MiB for this
7575 image), compared to just using the 7539 image), compared to just using the :ref:`ref-classes-create-spdx` class
7576 :ref:`create-spdx <ref-classes-create-spdx>` class with no option. 7540 with no option.
7577 7541
7578 :term:`SPDX_PRETTY` 7542 :term:`SPDX_PRETTY`
7579 This option makes the SPDX output more human-readable, using 7543 This option makes the SPDX output more human-readable, using
@@ -7723,15 +7687,15 @@ system and gives an overview of their function and contents.
7723 7687
7724 :term:`SRCTREECOVEREDTASKS` 7688 :term:`SRCTREECOVEREDTASKS`
7725 A list of tasks that are typically not relevant (and therefore skipped) 7689 A list of tasks that are typically not relevant (and therefore skipped)
7726 when building using the :ref:`externalsrc <ref-classes-externalsrc>` 7690 when building using the :ref:`ref-classes-externalsrc`
7727 class. The default value as set in that class file is the set of tasks 7691 class. The default value as set in that class file is the set of tasks
7728 that are rarely needed when using external source:: 7692 that are rarely needed when using external source::
7729 7693
7730 SRCTREECOVEREDTASKS ?= "do_patch do_unpack do_fetch" 7694 SRCTREECOVEREDTASKS ?= "do_patch do_unpack do_fetch"
7731 7695
7732 The notable exception is when processing external kernel source as 7696 The notable exception is when processing external kernel source as
7733 defined in the :ref:`kernel-yocto <ref-classes-kernel-yocto>` 7697 defined in the :ref:`ref-classes-kernel-yocto` class file (formatted for
7734 class file (formatted for aesthetics):: 7698 aesthetics)::
7735 7699
7736 SRCTREECOVEREDTASKS += "\ 7700 SRCTREECOVEREDTASKS += "\
7737 do_validate_branches \ 7701 do_validate_branches \
@@ -7799,10 +7763,9 @@ system and gives an overview of their function and contents.
7799 a different GCC version for native builds, you must configure 7763 a different GCC version for native builds, you must configure
7800 :term:`SSTATE_MIRRORS` with a regular expression that maps local search 7764 :term:`SSTATE_MIRRORS` with a regular expression that maps local search
7801 paths to server paths. The paths need to take into account 7765 paths to server paths. The paths need to take into account
7802 :term:`NATIVELSBSTRING` set by the 7766 :term:`NATIVELSBSTRING` set by the :ref:`ref-classes-uninative` class.
7803 :ref:`uninative <ref-classes-uninative>` class. For example, the 7767 For example, the following maps the local search path ``universal-4.9``
7804 following maps the local search path ``universal-4.9`` to the 7768 to the server-provided path server_url_sstate_path::
7805 server-provided path server_url_sstate_path::
7806 7769
7807 SSTATE_MIRRORS ?= "file://universal-4.9/(.*) https://server_url_sstate_path/universal-4.8/\1" 7770 SSTATE_MIRRORS ?= "file://universal-4.9/(.*) https://server_url_sstate_path/universal-4.8/\1"
7808 7771
@@ -7828,11 +7791,9 @@ system and gives an overview of their function and contents.
7828 by the :term:`SSTATE_SCAN_FILES` variable. Typically, recipes add files 7791 by the :term:`SSTATE_SCAN_FILES` variable. Typically, recipes add files
7829 they want to be scanned to the value of :term:`SSTATE_SCAN_FILES` rather 7792 they want to be scanned to the value of :term:`SSTATE_SCAN_FILES` rather
7830 than the variable being comprehensively set. The 7793 than the variable being comprehensively set. The
7831 :ref:`sstate <ref-classes-sstate>` class specifies the default list 7794 :ref:`ref-classes-sstate` class specifies the default list of files.
7832 of files.
7833 7795
7834 For details on the process, see the 7796 For details on the process, see the :ref:`ref-classes-staging` class.
7835 :ref:`staging <ref-classes-staging>` class.
7836 7797
7837 :term:`STAGING_BASE_LIBDIR_NATIVE` 7798 :term:`STAGING_BASE_LIBDIR_NATIVE`
7838 Specifies the path to the ``/lib`` subdirectory of the sysroot 7799 Specifies the path to the ``/lib`` subdirectory of the sysroot
@@ -7943,10 +7904,10 @@ system and gives an overview of their function and contents.
7943 which is the majority, :term:`STAGING_DIR_TARGET` is set to match 7904 which is the majority, :term:`STAGING_DIR_TARGET` is set to match
7944 :term:`STAGING_DIR_HOST`. 7905 :term:`STAGING_DIR_HOST`.
7945 7906
7946 Some recipes build binaries that can run on the target system but 7907 Some recipes build binaries that can run on the target system but those
7947 those binaries in turn generate code for another different system 7908 binaries in turn generate code for another different system (e.g.
7948 (e.g. :ref:`cross-canadian <ref-classes-cross-canadian>` recipes). Using terminology from GNU, the 7909 :ref:`ref-classes-cross-canadian` recipes). Using terminology from GNU,
7949 primary system is referred to as the "HOST" and the secondary, or 7910 the primary system is referred to as the "HOST" and the secondary, or
7950 different, system is referred to as the "TARGET". Thus, the binaries 7911 different, system is referred to as the "TARGET". Thus, the binaries
7951 run on the "HOST" system and generate binaries for the "TARGET" 7912 run on the "HOST" system and generate binaries for the "TARGET"
7952 system. The :term:`STAGING_DIR_HOST` variable points to the sysroot used 7913 system. The :term:`STAGING_DIR_HOST` variable points to the sysroot used
@@ -8040,7 +8001,7 @@ system and gives an overview of their function and contents.
8040 8001
8041 SYSLINUX_DEFAULT_CONSOLE = "console=ttyX" 8002 SYSLINUX_DEFAULT_CONSOLE = "console=ttyX"
8042 8003
8043 The :ref:`syslinux <ref-classes-syslinux>` class initially sets 8004 The :ref:`ref-classes-syslinux` class initially sets
8044 this variable to null but then checks for a value later. 8005 this variable to null but then checks for a value later.
8045 8006
8046 :term:`SYSLINUX_OPTS` 8007 :term:`SYSLINUX_OPTS`
@@ -8048,14 +8009,14 @@ system and gives an overview of their function and contents.
8048 this variable in your recipe. If you want to list multiple options, 8009 this variable in your recipe. If you want to list multiple options,
8049 separate the options with a semicolon character (``;``). 8010 separate the options with a semicolon character (``;``).
8050 8011
8051 The :ref:`syslinux <ref-classes-syslinux>` class uses this variable 8012 The :ref:`ref-classes-syslinux` class uses this variable
8052 to create a set of options. 8013 to create a set of options.
8053 8014
8054 :term:`SYSLINUX_SERIAL` 8015 :term:`SYSLINUX_SERIAL`
8055 Specifies the alternate serial port or turns it off. To turn off 8016 Specifies the alternate serial port or turns it off. To turn off
8056 serial, set this variable to an empty string in your recipe. The 8017 serial, set this variable to an empty string in your recipe. The
8057 variable's default value is set in the 8018 variable's default value is set in the
8058 :ref:`syslinux <ref-classes-syslinux>` class as follows:: 8019 :ref:`ref-classes-syslinux` class as follows::
8059 8020
8060 SYSLINUX_SERIAL ?= "0 115200" 8021 SYSLINUX_SERIAL ?= "0 115200"
8061 8022
@@ -8063,8 +8024,8 @@ system and gives an overview of their function and contents.
8063 8024
8064 :term:`SYSLINUX_SERIAL_TTY` 8025 :term:`SYSLINUX_SERIAL_TTY`
8065 Specifies the alternate console=tty... kernel boot argument. The 8026 Specifies the alternate console=tty... kernel boot argument. The
8066 variable's default value is set in the 8027 variable's default value is set in the :ref:`ref-classes-syslinux`
8067 :ref:`syslinux <ref-classes-syslinux>` class as follows:: 8028 class as follows::
8068 8029
8069 SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200" 8030 SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200"
8070 8031
@@ -8074,7 +8035,7 @@ system and gives an overview of their function and contents.
8074 An ``.LSS`` file used as the background for the VGA boot menu when 8035 An ``.LSS`` file used as the background for the VGA boot menu when
8075 you use the boot menu. You need to set this variable in your recipe. 8036 you use the boot menu. You need to set this variable in your recipe.
8076 8037
8077 The :ref:`syslinux <ref-classes-syslinux>` class checks for this 8038 The :ref:`ref-classes-syslinux` class checks for this
8078 variable and if found, the OpenEmbedded build system installs the 8039 variable and if found, the OpenEmbedded build system installs the
8079 splash screen. 8040 splash screen.
8080 8041
@@ -8150,12 +8111,12 @@ system and gives an overview of their function and contents.
8150 processing on the staged files, or to stage additional files. 8111 processing on the staged files, or to stage additional files.
8151 8112
8152 :term:`SYSTEMD_AUTO_ENABLE` 8113 :term:`SYSTEMD_AUTO_ENABLE`
8153 When inheriting the :ref:`systemd <ref-classes-systemd>` class, 8114 When inheriting the :ref:`ref-classes-systemd` class,
8154 this variable specifies whether the specified service in 8115 this variable specifies whether the specified service in
8155 :term:`SYSTEMD_SERVICE` should start 8116 :term:`SYSTEMD_SERVICE` should start
8156 automatically or not. By default, the service is enabled to 8117 automatically or not. By default, the service is enabled to
8157 automatically start at boot time. The default setting is in the 8118 automatically start at boot time. The default setting is in the
8158 :ref:`systemd <ref-classes-systemd>` class as follows:: 8119 :ref:`ref-classes-systemd` class as follows::
8159 8120
8160 SYSTEMD_AUTO_ENABLE ??= "enable" 8121 SYSTEMD_AUTO_ENABLE ??= "enable"
8161 8122
@@ -8165,7 +8126,7 @@ system and gives an overview of their function and contents.
8165 When :term:`EFI_PROVIDER` is set to 8126 When :term:`EFI_PROVIDER` is set to
8166 "systemd-boot", the :term:`SYSTEMD_BOOT_CFG` variable specifies the 8127 "systemd-boot", the :term:`SYSTEMD_BOOT_CFG` variable specifies the
8167 configuration file that should be used. By default, the 8128 configuration file that should be used. By default, the
8168 :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the 8129 :ref:`ref-classes-systemd-boot` class sets the
8169 :term:`SYSTEMD_BOOT_CFG` as follows:: 8130 :term:`SYSTEMD_BOOT_CFG` as follows::
8170 8131
8171 SYSTEMD_BOOT_CFG ?= "${S}/loader.conf" 8132 SYSTEMD_BOOT_CFG ?= "${S}/loader.conf"
@@ -8177,9 +8138,8 @@ system and gives an overview of their function and contents.
8177 When :term:`EFI_PROVIDER` is set to 8138 When :term:`EFI_PROVIDER` is set to
8178 "systemd-boot", the :term:`SYSTEMD_BOOT_ENTRIES` variable specifies a 8139 "systemd-boot", the :term:`SYSTEMD_BOOT_ENTRIES` variable specifies a
8179 list of entry files (``*.conf``) to install that contain one boot 8140 list of entry files (``*.conf``) to install that contain one boot
8180 entry per file. By default, the 8141 entry per file. By default, the :ref:`ref-classes-systemd-boot` class
8181 :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the 8142 sets the :term:`SYSTEMD_BOOT_ENTRIES` as follows::
8182 :term:`SYSTEMD_BOOT_ENTRIES` as follows::
8183 8143
8184 SYSTEMD_BOOT_ENTRIES ?= "" 8144 SYSTEMD_BOOT_ENTRIES ?= ""
8185 8145
@@ -8190,7 +8150,7 @@ system and gives an overview of their function and contents.
8190 When :term:`EFI_PROVIDER` is set to 8150 When :term:`EFI_PROVIDER` is set to
8191 "systemd-boot", the :term:`SYSTEMD_BOOT_TIMEOUT` variable specifies the 8151 "systemd-boot", the :term:`SYSTEMD_BOOT_TIMEOUT` variable specifies the
8192 boot menu timeout in seconds. By default, the 8152 boot menu timeout in seconds. By default, the
8193 :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the 8153 :ref:`ref-classes-systemd-boot` class sets the
8194 :term:`SYSTEMD_BOOT_TIMEOUT` as follows:: 8154 :term:`SYSTEMD_BOOT_TIMEOUT` as follows::
8195 8155
8196 SYSTEMD_BOOT_TIMEOUT ?= "10" 8156 SYSTEMD_BOOT_TIMEOUT ?= "10"
@@ -8216,7 +8176,7 @@ system and gives an overview of their function and contents.
8216 SYSTEMD_DEFAULT_TARGET = "graphical.target" 8176 SYSTEMD_DEFAULT_TARGET = "graphical.target"
8217 8177
8218 :term:`SYSTEMD_PACKAGES` 8178 :term:`SYSTEMD_PACKAGES`
8219 When inheriting the :ref:`systemd <ref-classes-systemd>` class, 8179 When inheriting the :ref:`ref-classes-systemd` class,
8220 this variable locates the systemd unit files when they are not found 8180 this variable locates the systemd unit files when they are not found
8221 in the main recipe's package. By default, the :term:`SYSTEMD_PACKAGES` 8181 in the main recipe's package. By default, the :term:`SYSTEMD_PACKAGES`
8222 variable is set such that the systemd unit files are assumed to 8182 variable is set such that the systemd unit files are assumed to
@@ -8229,7 +8189,7 @@ system and gives an overview of their function and contents.
8229 the build system can find the systemd unit files. 8189 the build system can find the systemd unit files.
8230 8190
8231 :term:`SYSTEMD_SERVICE` 8191 :term:`SYSTEMD_SERVICE`
8232 When inheriting the :ref:`systemd <ref-classes-systemd>` class, 8192 When inheriting the :ref:`ref-classes-systemd` class,
8233 this variable specifies the systemd service name for a package. 8193 this variable specifies the systemd service name for a package.
8234 8194
8235 Multiple services can be specified, each one separated by a space. 8195 Multiple services can be specified, each one separated by a space.
@@ -8392,7 +8352,7 @@ system and gives an overview of their function and contents.
8392 - For native recipes, the build system sets the variable to the 8352 - For native recipes, the build system sets the variable to the
8393 value of :term:`BUILD_PREFIX`. 8353 value of :term:`BUILD_PREFIX`.
8394 8354
8395 - For native SDK recipes (:ref:`nativesdk <ref-classes-nativesdk>`), 8355 - For native SDK recipes (:ref:`ref-classes-nativesdk`),
8396 the build system sets the variable to the value of :term:`SDK_PREFIX`. 8356 the build system sets the variable to the value of :term:`SDK_PREFIX`.
8397 8357
8398 :term:`TARGET_SYS` 8358 :term:`TARGET_SYS`
@@ -8952,21 +8912,19 @@ system and gives an overview of their function and contents.
8952 "sdcard" specifies the :term:`IMAGE_FSTYPES` to use for the U-Boot image. 8912 "sdcard" specifies the :term:`IMAGE_FSTYPES` to use for the U-Boot image.
8953 8913
8954 For more information on how the :term:`UBOOT_CONFIG` is handled, see the 8914 For more information on how the :term:`UBOOT_CONFIG` is handled, see the
8955 :ref:`uboot-config <ref-classes-uboot-config>` 8915 :ref:`ref-classes-uboot-config` class.
8956 class.
8957 8916
8958 :term:`UBOOT_DTB_LOADADDRESS` 8917 :term:`UBOOT_DTB_LOADADDRESS`
8959 Specifies the load address for the dtb image used by U-Boot. During FIT 8918 Specifies the load address for the dtb image used by U-Boot. During FIT
8960 image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in 8919 image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in
8961 :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify 8920 :ref:`ref-classes-kernel-fitimage` class to specify the load address to be
8962 the load address to be used in 8921 used in creating the dtb sections of Image Tree Source for the FIT image.
8963 creating the dtb sections of Image Tree Source for the FIT image.
8964 8922
8965 :term:`UBOOT_DTBO_LOADADDRESS` 8923 :term:`UBOOT_DTBO_LOADADDRESS`
8966 Specifies the load address for the dtbo image used by U-Boot. During FIT 8924 Specifies the load address for the dtbo image used by U-Boot. During FIT
8967 image creation, the :term:`UBOOT_DTBO_LOADADDRESS` variable is used in 8925 image creation, the :term:`UBOOT_DTBO_LOADADDRESS` variable is used in
8968 :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the load address to be used in 8926 :ref:`ref-classes-kernel-fitimage` class to specify the load address to be
8969 creating the dtbo sections of Image Tree Source for the FIT image. 8927 used in creating the dtbo sections of Image Tree Source for the FIT image.
8970 8928
8971 :term:`UBOOT_ENTRYPOINT` 8929 :term:`UBOOT_ENTRYPOINT`
8972 Specifies the entry point for the U-Boot image. During U-Boot image 8930 Specifies the entry point for the U-Boot image. During U-Boot image
@@ -9001,16 +8959,16 @@ system and gives an overview of their function and contents.
9001 8959
9002 :term:`UBOOT_MKIMAGE` 8960 :term:`UBOOT_MKIMAGE`
9003 Specifies the name of the mkimage command as used by the 8961 Specifies the name of the mkimage command as used by the
9004 :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to assemble 8962 :ref:`ref-classes-kernel-fitimage` class to assemble
9005 the FIT image. This can be used to substitute an alternative command, wrapper 8963 the FIT image. This can be used to substitute an alternative command, wrapper
9006 script or function if desired. The default is "uboot-mkimage". 8964 script or function if desired. The default is "uboot-mkimage".
9007 8965
9008 :term:`UBOOT_MKIMAGE_DTCOPTS` 8966 :term:`UBOOT_MKIMAGE_DTCOPTS`
9009 Options for the device tree compiler passed to mkimage '-D' 8967 Options for the device tree compiler passed to mkimage '-D' feature while
9010 feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. 8968 creating FIT image in :ref:`ref-classes-kernel-fitimage` class. If
9011 If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then 8969 :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then
9012 :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` will not pass the 8970 :ref:`ref-classes-kernel-fitimage` will not pass the ``-D`` option to
9013 ``-D`` option to mkimage. 8971 mkimage.
9014 8972
9015 :term:`UBOOT_MKIMAGE_KERNEL_TYPE` 8973 :term:`UBOOT_MKIMAGE_KERNEL_TYPE`
9016 Specifies the type argument for the kernel as passed to ``uboot-mkimage``. 8974 Specifies the type argument for the kernel as passed to ``uboot-mkimage``.
@@ -9018,31 +8976,27 @@ system and gives an overview of their function and contents.
9018 8976
9019 :term:`UBOOT_MKIMAGE_SIGN` 8977 :term:`UBOOT_MKIMAGE_SIGN`
9020 Specifies the name of the mkimage command as used by the 8978 Specifies the name of the mkimage command as used by the
9021 :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to sign 8979 :ref:`ref-classes-kernel-fitimage` class to sign
9022 the FIT image after it has been assembled (if enabled). This can be used 8980 the FIT image after it has been assembled (if enabled). This can be used
9023 to substitute an alternative command, wrapper script or function if 8981 to substitute an alternative command, wrapper script or function if
9024 desired. The default is "${:term:`UBOOT_MKIMAGE`}". 8982 desired. The default is "${:term:`UBOOT_MKIMAGE`}".
9025 8983
9026 :term:`UBOOT_MKIMAGE_SIGN_ARGS` 8984 :term:`UBOOT_MKIMAGE_SIGN_ARGS`
9027 Optionally specifies additional arguments for the 8985 Optionally specifies additional arguments for the
9028 :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to pass to the 8986 :ref:`ref-classes-kernel-fitimage` class to pass to the
9029 mkimage command when signing the FIT image. 8987 mkimage command when signing the FIT image.
9030 8988
9031 :term:`UBOOT_RD_ENTRYPOINT` 8989 :term:`UBOOT_RD_ENTRYPOINT`
9032 Specifies the entrypoint for the RAM disk image. 8990 Specifies the entrypoint for the RAM disk image. During FIT image
9033 During FIT image creation, the 8991 creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in
9034 :term:`UBOOT_RD_ENTRYPOINT` variable is used 8992 :ref:`ref-classes-kernel-fitimage` class to specify the entrypoint to be
9035 in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the 8993 used in creating the Image Tree Source for the FIT image.
9036 entrypoint to be used in creating the Image Tree Source for
9037 the FIT image.
9038 8994
9039 :term:`UBOOT_RD_LOADADDRESS` 8995 :term:`UBOOT_RD_LOADADDRESS`
9040 Specifies the load address for the RAM disk image. 8996 Specifies the load address for the RAM disk image. During FIT image
9041 During FIT image creation, the 8997 creation, the :term:`UBOOT_RD_LOADADDRESS` variable is used in
9042 :term:`UBOOT_RD_LOADADDRESS` variable is used 8998 :ref:`ref-classes-kernel-fitimage` class to specify the load address to
9043 in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the 8999 be used in creating the Image Tree Source for the FIT image.
9044 load address to be used in creating the Image Tree Source for
9045 the FIT image.
9046 9000
9047 :term:`UBOOT_SIGN_ENABLE` 9001 :term:`UBOOT_SIGN_ENABLE`
9048 Enable signing of FIT image. The default value is "0". 9002 Enable signing of FIT image. The default value is "0".
@@ -9084,12 +9038,12 @@ system and gives an overview of their function and contents.
9084 9038
9085 The configure arguments check that uses 9039 The configure arguments check that uses
9086 :term:`UNKNOWN_CONFIGURE_OPT_IGNORE` is part of the 9040 :term:`UNKNOWN_CONFIGURE_OPT_IGNORE` is part of the
9087 :ref:`insane <ref-classes-insane>` class and is only enabled if the 9041 :ref:`ref-classes-insane` class and is only enabled if the
9088 recipe inherits the :ref:`autotools <ref-classes-autotools>` class. 9042 recipe inherits the :ref:`ref-classes-autotools` class.
9089 9043
9090 :term:`UPDATERCPN` 9044 :term:`UPDATERCPN`
9091 For recipes inheriting the 9045 For recipes inheriting the
9092 :ref:`update-rc.d <ref-classes-update-rc.d>` class, :term:`UPDATERCPN` 9046 :ref:`ref-classes-update-rc.d` class, :term:`UPDATERCPN`
9093 specifies the package that contains the initscript that is enabled. 9047 specifies the package that contains the initscript that is enabled.
9094 9048
9095 The default value is "${PN}". Given that almost all recipes that 9049 The default value is "${PN}". Given that almost all recipes that
@@ -9243,7 +9197,7 @@ system and gives an overview of their function and contents.
9243 causes the build system to use static ``gid`` values. 9197 causes the build system to use static ``gid`` values.
9244 9198
9245 :term:`USERADD_PACKAGES` 9199 :term:`USERADD_PACKAGES`
9246 When inheriting the :ref:`useradd <ref-classes-useradd>` class, 9200 When inheriting the :ref:`ref-classes-useradd` class,
9247 this variable specifies the individual packages within the recipe 9201 this variable specifies the individual packages within the recipe
9248 that require users and/or groups to be added. 9202 that require users and/or groups to be added.
9249 9203
@@ -9260,7 +9214,7 @@ system and gives an overview of their function and contents.
9260 :term:`GROUPADD_PARAM`, or :term:`GROUPMEMS_PARAM` variables. 9214 :term:`GROUPADD_PARAM`, or :term:`GROUPMEMS_PARAM` variables.
9261 9215
9262 :term:`USERADD_PARAM` 9216 :term:`USERADD_PARAM`
9263 When inheriting the :ref:`useradd <ref-classes-useradd>` class, 9217 When inheriting the :ref:`ref-classes-useradd` class,
9264 this variable specifies for a package what parameters should pass to 9218 this variable specifies for a package what parameters should pass to
9265 the ``useradd`` command if you add a user to the system when the 9219 the ``useradd`` command if you add a user to the system when the
9266 package is installed. 9220 package is installed.