summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-11-23 18:48:30 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-12-13 23:31:34 +0000
commit121f5758ab39b305be2e651f538c8b9a6b4e4a81 (patch)
tree0828cfc5e7b098a18154b9bfb60e9d4d563bd634 /documentation
parenta19add4aaaa4ff64ae3403eae415c08713bbdb38 (diff)
downloadpoky-121f5758ab39b305be2e651f538c8b9a6b4e4a81.tar.gz
ref-manual: add more class references
(From yocto-docs rev: f4610b060968c481c68d0411b82201c302050b71) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/classes.rst4
-rw-r--r--documentation/ref-manual/structure.rst2
-rw-r--r--documentation/ref-manual/tasks.rst4
-rw-r--r--documentation/ref-manual/variables.rst48
4 files changed, 28 insertions, 30 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index a33a5909ca..e258469dcb 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -570,11 +570,11 @@ be performed using the
570.. note:: 570.. note::
571 571
572 The user and group operations added using the 572 The user and group operations added using the
573 extrausers 573 :ref:`extrausers <ref-classes-extrausers>`
574 class are not tied to a specific recipe outside of the recipe for the 574 class are not tied to a specific recipe outside of the recipe for the
575 image. Thus, the operations can be performed across the image as a 575 image. Thus, the operations can be performed across the image as a
576 whole. Use the 576 whole. Use the
577 useradd 577 :ref:`useradd <ref-classes-useradd>`
578 class to add user and group configuration to a specific recipe. 578 class to add user and group configuration to a specific recipe.
579 579
580Here is an example that uses this class in an image recipe:: 580Here is an example that uses this class in an image recipe::
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index 5f00edb06c..5d2e3a86ef 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -231,7 +231,7 @@ is available via the :term:`TOPDIR` variable.
231----------------------- 231-----------------------
232 232
233The OpenEmbedded build system creates this directory when you enable 233The OpenEmbedded build system creates this directory when you enable
234build history via the ``buildhistory`` class file. The directory 234build history via the :ref:`buildhistory <ref-classes-buildhistory>` class file. The directory
235organizes build information into image, packages, and SDK 235organizes build information into image, packages, and SDK
236subdirectories. For information on the build history feature, see the 236subdirectories. For information on the build history feature, see the
237":ref:`dev-manual/common-tasks:maintaining build output quality`" 237":ref:`dev-manual/common-tasks:maintaining build output quality`"
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 299969dea4..8d563714a1 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -80,7 +80,7 @@ task runs with the current working directory set to
80Recipes implementing this task should inherit the 80Recipes implementing this task should inherit the
81:ref:`deploy <ref-classes-deploy>` class and should write the output 81:ref:`deploy <ref-classes-deploy>` class and should write the output
82to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be 82to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be
83confused with ``${DEPLOY_DIR}``. The ``deploy`` class sets up 83confused with ``${DEPLOY_DIR}``. The :ref:`deploy <ref-classes-deploy>` class sets up
84``do_deploy`` as a shared state (sstate) task that can be accelerated 84``do_deploy`` as a shared state (sstate) task that can be accelerated
85through sstate use. The sstate mechanism takes care of copying the 85through sstate use. The sstate mechanism takes care of copying the
86output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``. 86output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``.
@@ -102,7 +102,7 @@ Adding ``do_deploy`` after other tasks works the same way.
102.. note:: 102.. note::
103 103
104 You do not need to add ``before do_build`` to the ``addtask`` command 104 You do not need to add ``before do_build`` to the ``addtask`` command
105 (though it is harmless), because the ``base`` class contains the following:: 105 (though it is harmless), because the :ref:`base <ref-classes-base>` class contains the following::
106 106
107 do_build[recrdeptask] += "do_deploy" 107 do_build[recrdeptask] += "do_deploy"
108 108
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 26b56e145c..c30110d916 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -773,7 +773,7 @@ system and gives an overview of their function and contents.
773 :ref:`binconfig-disabled <ref-classes-binconfig-disabled>` class, 773 :ref:`binconfig-disabled <ref-classes-binconfig-disabled>` class,
774 this variable specifies binary configuration scripts to disable in 774 this variable specifies binary configuration scripts to disable in
775 favor of using ``pkg-config`` to query the information. The 775 favor of using ``pkg-config`` to query the information. The
776 ``binconfig-disabled`` class will modify the specified scripts to 776 :ref:`binconfig-disabled <ref-classes-binconfig-disabled>` class will modify the specified scripts to
777 return an error so that calls to them can be easily found and 777 return an error so that calls to them can be easily found and
778 replaced. 778 replaced.
779 779
@@ -941,13 +941,13 @@ system and gives an overview of their function and contents.
941 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 941 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
942 class, this variable specifies whether or not to commit the build 942 class, this variable specifies whether or not to commit the build
943 history output in a local Git repository. If set to "1", this local 943 history output in a local Git repository. If set to "1", this local
944 repository will be maintained automatically by the ``buildhistory`` 944 repository will be maintained automatically by the :ref:`buildhistory <ref-classes-buildhistory>`
945 class and a commit will be created on every build for changes to each 945 class and a commit will be created on every build for changes to each
946 top-level subdirectory of the build history output (images, packages, 946 top-level subdirectory of the build history output (images, packages,
947 and sdk). If you want to track changes to build history over time, 947 and sdk). If you want to track changes to build history over time,
948 you should set this value to "1". 948 you should set this value to "1".
949 949
950 By default, the ``buildhistory`` class does not commit the build 950 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class does not commit the build
951 history output in a local Git repository:: 951 history output in a local Git repository::
952 952
953 BUILDHISTORY_COMMIT ?= "0" 953 BUILDHISTORY_COMMIT ?= "0"
@@ -964,7 +964,7 @@ system and gives an overview of their function and contents.
964 email@host". Providing an email address or host that is not valid 964 email@host". Providing an email address or host that is not valid
965 does not produce an error. 965 does not produce an error.
966 966
967 By default, the ``buildhistory`` class sets the variable as follows:: 967 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class sets the variable as follows::
968 968
969 BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>" 969 BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>"
970 970
@@ -972,9 +972,9 @@ system and gives an overview of their function and contents.
972 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 972 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
973 class, this variable specifies the directory in which build history 973 class, this variable specifies the directory in which build history
974 information is kept. For more information on how the variable works, 974 information is kept. For more information on how the variable works,
975 see the ``buildhistory.class``. 975 see the ``buildhistory.bbclass`` file.
976 976
977 By default, the ``buildhistory`` class sets the directory as follows:: 977 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class sets the directory as follows::
978 978
979 BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory" 979 BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory"
980 980
@@ -1001,7 +1001,7 @@ system and gives an overview of their function and contents.
1001 This saves one file per task and lists the SHA-256 checksums for 1001 This saves one file per task and lists the SHA-256 checksums for
1002 each file staged (i.e. the output of the task). 1002 each file staged (i.e. the output of the task).
1003 1003
1004 By default, the ``buildhistory`` class enables the following 1004 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class enables the following
1005 features:: 1005 features::
1006 1006
1007 BUILDHISTORY_FEATURES ?= "image package sdk" 1007 BUILDHISTORY_FEATURES ?= "image package sdk"
@@ -1017,7 +1017,7 @@ system and gives an overview of their function and contents.
1017 any file. Specifying an invalid path does not produce an error. 1017 any file. Specifying an invalid path does not produce an error.
1018 Consequently, you can include files that might not always be present. 1018 Consequently, you can include files that might not always be present.
1019 1019
1020 By default, the ``buildhistory`` class provides paths to the 1020 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class provides paths to the
1021 following files:: 1021 following files::
1022 1022
1023 BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group" 1023 BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group"
@@ -1030,7 +1030,7 @@ system and gives an overview of their function and contents.
1030 useful when build history is populated from multiple sources that may not 1030 useful when build history is populated from multiple sources that may not
1031 all use the same top level directory. 1031 all use the same top level directory.
1032 1032
1033 By default, the ``buildhistory`` class sets the variable as follows:: 1033 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class sets the variable as follows::
1034 1034
1035 BUILDHISTORY_PATH_PREFIX_STRIP ?= "" 1035 BUILDHISTORY_PATH_PREFIX_STRIP ?= ""
1036 1036
@@ -1049,7 +1049,7 @@ system and gives an overview of their function and contents.
1049 that you have set up manually using ``git remote`` within the local 1049 that you have set up manually using ``git remote`` within the local
1050 repository. 1050 repository.
1051 1051
1052 By default, the ``buildhistory`` class sets the variable as follows:: 1052 By default, the :ref:`buildhistory <ref-classes-buildhistory>` class sets the variable as follows::
1053 1053
1054 BUILDHISTORY_PUSH_REPO ?= "" 1054 BUILDHISTORY_PUSH_REPO ?= ""
1055 1055
@@ -1323,7 +1323,7 @@ system and gives an overview of their function and contents.
1323 The default value, which is "CLOSED Proprietary", for 1323 The default value, which is "CLOSED Proprietary", for
1324 :term:`COPYLEFT_LICENSE_EXCLUDE` is set by the 1324 :term:`COPYLEFT_LICENSE_EXCLUDE` is set by the
1325 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which 1325 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
1326 is inherited by the ``archiver`` class. 1326 is inherited by the :ref:`archiver <ref-classes-archiver>` class.
1327 1327
1328 :term:`COPYLEFT_LICENSE_INCLUDE` 1328 :term:`COPYLEFT_LICENSE_INCLUDE`
1329 A space-separated list of licenses to include in the source archived 1329 A space-separated list of licenses to include in the source archived
@@ -1334,7 +1334,7 @@ system and gives an overview of their function and contents.
1334 1334
1335 The default value is set by the 1335 The default value is set by the
1336 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which 1336 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
1337 is inherited by the ``archiver`` class. The default value includes 1337 is inherited by the :ref:`archiver <ref-classes-archiver>` class. The default value includes
1338 "GPL*", "LGPL*", and "AGPL*". 1338 "GPL*", "LGPL*", and "AGPL*".
1339 1339
1340 :term:`COPYLEFT_PN_EXCLUDE` 1340 :term:`COPYLEFT_PN_EXCLUDE`
@@ -1349,7 +1349,7 @@ system and gives an overview of their function and contents.
1349 The default value, which is "" indicating to not explicitly exclude 1349 The default value, which is "" indicating to not explicitly exclude
1350 any recipes by name, for :term:`COPYLEFT_PN_EXCLUDE` is set by the 1350 any recipes by name, for :term:`COPYLEFT_PN_EXCLUDE` is set by the
1351 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which 1351 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
1352 is inherited by the ``archiver`` class. 1352 is inherited by the :ref:`archiver <ref-classes-archiver>` class.
1353 1353
1354 :term:`COPYLEFT_PN_INCLUDE` 1354 :term:`COPYLEFT_PN_INCLUDE`
1355 A list of recipes to include in the source archived by the 1355 A list of recipes to include in the source archived by the
@@ -1363,7 +1363,7 @@ system and gives an overview of their function and contents.
1363 The default value, which is "" indicating to not explicitly include 1363 The default value, which is "" indicating to not explicitly include
1364 any recipes by name, for :term:`COPYLEFT_PN_INCLUDE` is set by the 1364 any recipes by name, for :term:`COPYLEFT_PN_INCLUDE` is set by the
1365 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which 1365 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
1366 is inherited by the ``archiver`` class. 1366 is inherited by the :ref:`archiver <ref-classes-archiver>` class.
1367 1367
1368 :term:`COPYLEFT_RECIPE_TYPES` 1368 :term:`COPYLEFT_RECIPE_TYPES`
1369 A space-separated list of recipe types to include in the source 1369 A space-separated list of recipe types to include in the source
@@ -1373,7 +1373,7 @@ system and gives an overview of their function and contents.
1373 1373
1374 The default value, which is "target*", for :term:`COPYLEFT_RECIPE_TYPES` 1374 The default value, which is "target*", for :term:`COPYLEFT_RECIPE_TYPES`
1375 is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>` 1375 is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>`
1376 class, which is inherited by the ``archiver`` class. 1376 class, which is inherited by the :ref:`archiver <ref-classes-archiver>` class.
1377 1377
1378 :term:`COPY_LIC_DIRS` 1378 :term:`COPY_LIC_DIRS`
1379 If set to "1" along with the 1379 If set to "1" along with the
@@ -1805,11 +1805,11 @@ system and gives an overview of their function and contents.
1805 :term:`DEPLOYDIR` 1805 :term:`DEPLOYDIR`
1806 When inheriting the :ref:`deploy <ref-classes-deploy>` class, the 1806 When inheriting the :ref:`deploy <ref-classes-deploy>` class, the
1807 :term:`DEPLOYDIR` points to a temporary work area for deployed files that 1807 :term:`DEPLOYDIR` points to a temporary work area for deployed files that
1808 is set in the ``deploy`` class as follows:: 1808 is set in the :ref:`deploy <ref-classes-deploy>` class as follows::
1809 1809
1810 DEPLOYDIR = "${WORKDIR}/deploy-${PN}" 1810 DEPLOYDIR = "${WORKDIR}/deploy-${PN}"
1811 1811
1812 Recipes inheriting the ``deploy`` class should copy files to be 1812 Recipes inheriting the :ref:`deploy <ref-classes-deploy>` class should copy files to be
1813 deployed into :term:`DEPLOYDIR`, and the class will take care of copying 1813 deployed into :term:`DEPLOYDIR`, and the class will take care of copying
1814 them into :term:`DEPLOY_DIR_IMAGE` 1814 them into :term:`DEPLOY_DIR_IMAGE`
1815 afterwards. 1815 afterwards.
@@ -2293,7 +2293,7 @@ system and gives an overview of their function and contents.
2293 group configurations to a specific recipe. 2293 group configurations to a specific recipe.
2294 2294
2295 The set list of commands you can configure using the 2295 The set list of commands you can configure using the
2296 :term:`EXTRA_USERS_PARAMS` is shown in the ``extrausers`` class. These 2296 :term:`EXTRA_USERS_PARAMS` is shown in the :ref:`extrausers <ref-classes-extrausers>` class. These
2297 commands map to the normal Unix commands of the same names:: 2297 commands map to the normal Unix commands of the same names::
2298 2298
2299 # EXTRA_USERS_PARAMS = "\ 2299 # EXTRA_USERS_PARAMS = "\
@@ -2628,7 +2628,7 @@ system and gives an overview of their function and contents.
2628 :term:`FONT_PACKAGES` 2628 :term:`FONT_PACKAGES`
2629 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, 2629 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class,
2630 this variable identifies packages containing font files that need to 2630 this variable identifies packages containing font files that need to
2631 be cached by Fontconfig. By default, the ``fontcache`` class assumes 2631 be cached by Fontconfig. By default, the :ref:`fontcache <ref-classes-fontcache>` class assumes
2632 that fonts are in the recipe's main package (i.e. 2632 that fonts are in the recipe's main package (i.e.
2633 ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you 2633 ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you
2634 need are in a package other than that main package. 2634 need are in a package other than that main package.
@@ -3890,7 +3890,7 @@ system and gives an overview of their function and contents.
3890 typically append this variable to enable extended image types. An 3890 typically append this variable to enable extended image types. An
3891 example is the "kernel-fitimage", which enables fitImage support and 3891 example is the "kernel-fitimage", which enables fitImage support and
3892 resides in ``meta/classes/kernel-fitimage.bbclass``. You can register 3892 resides in ``meta/classes/kernel-fitimage.bbclass``. You can register
3893 custom kernel image types with the ``kernel`` class using this 3893 custom kernel image types with the :ref:`kernel <ref-classes-kernel>` class using this
3894 variable. 3894 variable.
3895 3895
3896 :term:`KERNEL_DEVICETREE` 3896 :term:`KERNEL_DEVICETREE`
@@ -4285,7 +4285,7 @@ system and gives an overview of their function and contents.
4285 that the :ref:`debian <ref-classes-debian>` class applies its 4285 that the :ref:`debian <ref-classes-debian>` class applies its
4286 naming policy to given a recipe that packages multiple libraries. 4286 naming policy to given a recipe that packages multiple libraries.
4287 4287
4288 This variable works in conjunction with the ``debian`` class. 4288 This variable works in conjunction with the :ref:`debian <ref-classes-debian>` class.
4289 4289
4290 :term:`LIC_FILES_CHKSUM` 4290 :term:`LIC_FILES_CHKSUM`
4291 Checksums of the license text in the recipe source code. 4291 Checksums of the license text in the recipe source code.
@@ -4910,9 +4910,7 @@ system and gives an overview of their function and contents.
4910 4910
4911 See the ``meta/classes/binconfig.bbclass`` in the 4911 See the ``meta/classes/binconfig.bbclass`` in the
4912 :term:`Source Directory` for details on how this class 4912 :term:`Source Directory` for details on how this class
4913 applies these additional sed command arguments. For general 4913 applies these additional sed command arguments.
4914 information on the ``binconfig`` class, see the
4915 ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section.
4916 4914
4917 :term:`OE_IMPORTS` 4915 :term:`OE_IMPORTS`
4918 An internal variable used to tell the OpenEmbedded build system what 4916 An internal variable used to tell the OpenEmbedded build system what
@@ -6009,7 +6007,7 @@ system and gives an overview of their function and contents.
6009 names used when installing the Python headers and libraries in 6007 names used when installing the Python headers and libraries in
6010 sysroot (e.g. ``.../python3.3m/...``). 6008 sysroot (e.g. ``.../python3.3m/...``).
6011 6009
6012 Recipes that inherit the ``distutils3`` class during cross-builds also 6010 Recipes that inherit the :ref:`distutils3 <ref-classes-distutils3>` class during cross-builds also
6013 use this variable to locate the headers and libraries of the 6011 use this variable to locate the headers and libraries of the
6014 appropriate Python that the extension is targeting. 6012 appropriate Python that the extension is targeting.
6015 6013