diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-10-13 08:42:10 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-12-01 19:20:29 +0000 |
commit | 55621c31f1edbdb2f3d72e80916fed031e2ba298 (patch) | |
tree | 49499b82a28ed611fb478605e11fa173294f1e87 /documentation | |
parent | 7ecd9877e6a1b235070d6feba59a3840ebbc5255 (diff) | |
download | poky-55621c31f1edbdb2f3d72e80916fed031e2ba298.tar.gz |
manuals: add missing references to classes
Sometimes fixing line length in modified paragraphs too.
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 885b60f5540849bf19240a01a77efce1d1b5d9f0)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
21 files changed, 182 insertions, 156 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index b9c467526a..96a6a76180 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -1855,9 +1855,10 @@ Here are some common issues that cause failures. | |||
1855 | ":ref:`dev-manual/common-tasks:debugging parallel make races`" section. | 1855 | ":ref:`dev-manual/common-tasks:debugging parallel make races`" section. |
1856 | 1856 | ||
1857 | - *Improper host path usage:* This failure applies to recipes building | 1857 | - *Improper host path usage:* This failure applies to recipes building |
1858 | for the target or ``nativesdk`` only. The failure occurs when the | 1858 | for the target or ":ref:`nativesdk <ref-classes-nativesdk>`" only. The |
1859 | compilation process uses improper headers, libraries, or other files | 1859 | failure occurs when the compilation process uses improper headers, |
1860 | from the host system when cross-compiling for the target. | 1860 | libraries, or other files from the host system when cross-compiling for |
1861 | the target. | ||
1861 | 1862 | ||
1862 | To fix the problem, examine the ``log.do_compile`` file to identify | 1863 | To fix the problem, examine the ``log.do_compile`` file to identify |
1863 | the host paths being used (e.g. ``/usr/include``, ``/usr/lib``, and | 1864 | the host paths being used (e.g. ``/usr/include``, ``/usr/lib``, and |
@@ -3404,7 +3405,7 @@ form of a patch all using Quilt. | |||
3404 | .. note:: | 3405 | .. note:: |
3405 | 3406 | ||
3406 | With regard to preserving changes to source files, if you clean a | 3407 | With regard to preserving changes to source files, if you clean a |
3407 | recipe or have ``rm_work`` enabled, the | 3408 | recipe or have :ref:`rm_work <ref-classes-rm-work>` enabled, the |
3408 | :ref:`devtool workflow <sdk-manual/extensible:using \`\`devtool\`\` in your sdk workflow>` | 3409 | :ref:`devtool workflow <sdk-manual/extensible:using \`\`devtool\`\` in your sdk workflow>` |
3409 | as described in the Yocto Project Application Development and the | 3410 | as described in the Yocto Project Application Development and the |
3410 | Extensible Software Development Kit (eSDK) manual is a safer | 3411 | Extensible Software Development Kit (eSDK) manual is a safer |
@@ -3450,11 +3451,11 @@ Follow these general steps: | |||
3450 | .. note:: | 3451 | .. note:: |
3451 | 3452 | ||
3452 | All the modifications you make to the temporary source code disappear | 3453 | All the modifications you make to the temporary source code disappear |
3453 | once you run the :ref:`ref-tasks-clean` or :ref:`ref-tasks-cleanall` tasks using BitBake | 3454 | once you run the :ref:`ref-tasks-clean` or :ref:`ref-tasks-cleanall` |
3454 | (i.e. ``bitbake -c clean package`` and ``bitbake -c cleanall package``). | 3455 | tasks using BitBake (i.e. ``bitbake -c clean package`` and |
3455 | Modifications will also disappear if you use the ``rm_work`` feature as | 3456 | ``bitbake -c cleanall package``). Modifications will also disappear if |
3456 | described in the | 3457 | you use the :ref:`rm_work <ref-classes-rm-work>` feature as described in |
3457 | ":ref:`dev-manual/common-tasks:conserving disk space during builds`" | 3458 | the ":ref:`dev-manual/common-tasks:conserving disk space during builds`" |
3458 | section. | 3459 | section. |
3459 | 3460 | ||
3460 | 7. *Generate the Patch:* Once your changes work as expected, you need to | 3461 | 7. *Generate the Patch:* Once your changes work as expected, you need to |
@@ -7143,7 +7144,8 @@ Lighttpd, or Nginx), take the appropriate steps to do so. | |||
7143 | From within the :term:`Build Directory` where you have built an image based on | 7144 | From within the :term:`Build Directory` where you have built an image based on |
7144 | your packaging choice (i.e. the :term:`PACKAGE_CLASSES` setting), simply start | 7145 | your packaging choice (i.e. the :term:`PACKAGE_CLASSES` setting), simply start |
7145 | the server. The following example assumes a :term:`Build Directory` of ``poky/build`` | 7146 | the server. The following example assumes a :term:`Build Directory` of ``poky/build`` |
7146 | and a :term:`PACKAGE_CLASSES` setting of "package_rpm":: | 7147 | and a :term:`PACKAGE_CLASSES` setting of |
7148 | ":ref:`package_rpm <ref-classes-package_rpm>`":: | ||
7147 | 7149 | ||
7148 | $ cd poky/build/tmp/deploy/rpm | 7150 | $ cd poky/build/tmp/deploy/rpm |
7149 | $ python3 -m http.server | 7151 | $ python3 -m http.server |
@@ -7491,8 +7493,8 @@ test. Here is what you have to do for each recipe: | |||
7491 | special configurations prior to compiling the test code, you must | 7493 | special configurations prior to compiling the test code, you must |
7492 | insert a ``do_configure_ptest`` function into the recipe. | 7494 | insert a ``do_configure_ptest`` function into the recipe. |
7493 | 7495 | ||
7494 | - *Install the test suite:* The ``ptest`` class automatically copies | 7496 | - *Install the test suite:* The :ref:`ptest <ref-classes-ptest>` class |
7495 | the file ``run-ptest`` to the target and then runs make | 7497 | automatically copies the file ``run-ptest`` to the target and then runs make |
7496 | ``install-ptest`` to run the tests. If this is not enough, you need | 7498 | ``install-ptest`` to run the tests. If this is not enough, you need |
7497 | to create a ``do_install_ptest`` function and make sure it gets | 7499 | to create a ``do_install_ptest`` function and make sure it gets |
7498 | called after the "make install-ptest" completes. | 7500 | called after the "make install-ptest" completes. |
@@ -11237,7 +11239,7 @@ an :ref:`archiver <ref-classes-archiver>` class to | |||
11237 | help avoid some of these concerns. | 11239 | help avoid some of these concerns. |
11238 | 11240 | ||
11239 | Before you employ :term:`DL_DIR` or the :ref:`archiver <ref-classes-archiver>` class, you need to | 11241 | Before you employ :term:`DL_DIR` or the :ref:`archiver <ref-classes-archiver>` class, you need to |
11240 | decide how you choose to provide source. The source ``archiver`` class | 11242 | decide how you choose to provide source. The source :ref:`archiver <ref-classes-archiver>` class |
11241 | can generate tarballs and SRPMs and can create them with various levels | 11243 | can generate tarballs and SRPMs and can create them with various levels |
11242 | of compliance in mind. | 11244 | of compliance in mind. |
11243 | 11245 | ||
@@ -11325,7 +11327,7 @@ generation are included on your image. | |||
11325 | adds a separate package and an upgrade path for adding licenses to an | 11327 | adds a separate package and an upgrade path for adding licenses to an |
11326 | image. | 11328 | image. |
11327 | 11329 | ||
11328 | As the source ``archiver`` class has already archived the original | 11330 | As the source :ref:`archiver <ref-classes-archiver>` class has already archived the original |
11329 | unmodified source that contains the license files, you would have | 11331 | unmodified source that contains the license files, you would have |
11330 | already met the requirements for inclusion of the license information | 11332 | already met the requirements for inclusion of the license information |
11331 | with source as defined by the GPL and other open source licenses. | 11333 | with source as defined by the GPL and other open source licenses. |
diff --git a/documentation/migration-guides/migration-1.3.rst b/documentation/migration-guides/migration-1.3.rst index 3ba189b773..a135574744 100644 --- a/documentation/migration-guides/migration-1.3.rst +++ b/documentation/migration-guides/migration-1.3.rst | |||
@@ -91,11 +91,11 @@ consistency. | |||
91 | nativesdk | 91 | nativesdk |
92 | ~~~~~~~~~ | 92 | ~~~~~~~~~ |
93 | 93 | ||
94 | The suffix ``nativesdk`` is now implemented as a prefix, which | 94 | The suffix ``nativesdk`` is now implemented as a prefix, which simplifies a |
95 | simplifies a lot of the packaging code for ``nativesdk`` recipes. All | 95 | lot of the packaging code for :ref:`nativesdk <ref-classes-nativesdk>` recipes. |
96 | custom ``nativesdk`` recipes, which are relocatable packages that are | 96 | All custom :ref:`nativesdk <ref-classes-nativesdk>` recipes, which are |
97 | native to :term:`SDK_ARCH`, and any references need to | 97 | relocatable packages that are native to :term:`SDK_ARCH`, and any references |
98 | be updated to use ``nativesdk-*`` instead of ``*-nativesdk``. | 98 | need to be updated to use ``nativesdk-*`` instead of ``*-nativesdk``. |
99 | 99 | ||
100 | .. _migration-1.3-task-recipes: | 100 | .. _migration-1.3-task-recipes: |
101 | 101 | ||
@@ -109,12 +109,11 @@ automatic upgrade path for most packages. However, you should update | |||
109 | references in your own recipes and configurations as they could be | 109 | references in your own recipes and configurations as they could be |
110 | removed in future releases. You should also rename any custom ``task-*`` | 110 | removed in future releases. You should also rename any custom ``task-*`` |
111 | recipes to ``packagegroup-*``, and change them to inherit | 111 | recipes to ``packagegroup-*``, and change them to inherit |
112 | ``packagegroup`` instead of ``task``, as well as taking the opportunity | 112 | :ref:`packagegroup <ref-classes-packagegroup>` instead of ``task``, as well |
113 | to remove anything now handled by :ref:`ref-classes-packagegroup`, such as | 113 | as taking the opportunity to remove anything now handled by |
114 | providing ``-dev`` and ``-dbg`` packages, setting | 114 | :ref:`ref-classes-packagegroup`, such as providing ``-dev`` and ``-dbg`` |
115 | :term:`LIC_FILES_CHKSUM`, and so forth. See the | 115 | packages, setting :term:`LIC_FILES_CHKSUM`, and so forth. See the |
116 | :ref:`ref-classes-packagegroup` section for | 116 | :ref:`ref-classes-packagegroup` section for further details. |
117 | further details. | ||
118 | 117 | ||
119 | .. _migration-1.3-image-features: | 118 | .. _migration-1.3-image-features: |
120 | 119 | ||
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst index 70a087ff1a..b47980dc67 100644 --- a/documentation/migration-guides/migration-1.5.rst +++ b/documentation/migration-guides/migration-1.5.rst | |||
@@ -130,6 +130,11 @@ The following directory changes exist: | |||
130 | it easier to delete :term:`TMPDIR` and preserve the build history. | 130 | it easier to delete :term:`TMPDIR` and preserve the build history. |
131 | Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`. | 131 | Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`. |
132 | 132 | ||
133 | - When :ref:`buildhistory <ref-classes-buildhistory>` is enabled, its output | ||
134 | is now written under the :term:`Build Directory` rather than :term:`TMPDIR`. | ||
135 | Doing so makes it easier to delete :term:`TMPDIR` and preserve the build | ||
136 | history. Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`. | ||
137 | |||
133 | - The ``pkgdata`` directory produced as part of the packaging process | 138 | - The ``pkgdata`` directory produced as part of the packaging process |
134 | has been collapsed into a single machine-specific directory. This | 139 | has been collapsed into a single machine-specific directory. This |
135 | directory is located under ``sysroots`` and uses a machine-specific | 140 | directory is located under ``sysroots`` and uses a machine-specific |
diff --git a/documentation/migration-guides/migration-1.6.rst b/documentation/migration-guides/migration-1.6.rst index d3de264650..d07731dcb0 100644 --- a/documentation/migration-guides/migration-1.6.rst +++ b/documentation/migration-guides/migration-1.6.rst | |||
@@ -220,9 +220,10 @@ Package Test (ptest) | |||
220 | 220 | ||
221 | Package Tests (ptest) are built but not installed by default. For | 221 | Package Tests (ptest) are built but not installed by default. For |
222 | information on using Package Tests, see the | 222 | information on using Package Tests, see the |
223 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" | 223 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" section in the |
224 | section in the Yocto Project Development Tasks Manual. For information on the | 224 | Yocto Project Development Tasks Manual. For information on the |
225 | ``ptest`` class, see the ":ref:`ref-classes-ptest`" section. | 225 | :ref:`ptest <ref-classes-ptest>` class, see the ":ref:`ref-classes-ptest`" |
226 | section. | ||
226 | 227 | ||
227 | .. _migration-1.6-build-changes: | 228 | .. _migration-1.6-build-changes: |
228 | 229 | ||
@@ -237,7 +238,7 @@ will enable a separate :term:`Build Directory` by default as well. Recipes | |||
237 | building Autotools-based software that fails to build with a separate | 238 | building Autotools-based software that fails to build with a separate |
238 | :term:`Build Directory` should be changed to inherit from the | 239 | :term:`Build Directory` should be changed to inherit from the |
239 | :ref:`autotools-brokensep <ref-classes-autotools>` class instead of | 240 | :ref:`autotools-brokensep <ref-classes-autotools>` class instead of |
240 | the ``autotools`` or ``autotools_stage``\ classes. | 241 | the :ref:`autotools <ref-classes-autotools>` or ``autotools_stage`` classes. |
241 | 242 | ||
242 | .. _migration-1.6-building-qemu-native: | 243 | .. _migration-1.6-building-qemu-native: |
243 | 244 | ||
diff --git a/documentation/migration-guides/migration-1.8.rst b/documentation/migration-guides/migration-1.8.rst index f058029b30..35a2a21e5b 100644 --- a/documentation/migration-guides/migration-1.8.rst +++ b/documentation/migration-guides/migration-1.8.rst | |||
@@ -76,15 +76,15 @@ particular, users need to ensure that ``${S}`` (source files) and | |||
76 | ``${B}`` (build artifacts) are used correctly in functions such as | 76 | ``${B}`` (build artifacts) are used correctly in functions such as |
77 | :ref:`ref-tasks-configure` and | 77 | :ref:`ref-tasks-configure` and |
78 | :ref:`ref-tasks-install`. For kernel recipes that do not | 78 | :ref:`ref-tasks-install`. For kernel recipes that do not |
79 | inherit from ``kernel-yocto`` or include ``linux-yocto.inc``, you might | 79 | inherit from :ref:`kernel-yocto <ref-classes-kernel-yocto>` or include ``linux-yocto.inc``, you might |
80 | wish to refer to the ``linux.inc`` file in the ``meta-oe`` layer for the | 80 | wish to refer to the ``linux.inc`` file in the ``meta-oe`` layer for the |
81 | kinds of changes you need to make. For reference, here is the | 81 | kinds of changes you need to make. For reference, here is the |
82 | :oe_git:`commit </meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>` | 82 | :oe_git:`commit </meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>` |
83 | where the ``linux.inc`` file in ``meta-oe`` was updated. | 83 | where the ``linux.inc`` file in ``meta-oe`` was updated. |
84 | 84 | ||
85 | Recipes that rely on the kernel source code and do not inherit the | 85 | Recipes that rely on the kernel source code and do not inherit the |
86 | module classes might need to add explicit dependencies on the | 86 | :ref:`module <ref-classes-module>` classes might need to add explicit |
87 | :ref:`ref-tasks-shared_workdir` kernel task, for example:: | 87 | dependencies on the :ref:`ref-tasks-shared_workdir` kernel task, for example:: |
88 | 88 | ||
89 | do_configure[depends] += "virtual/kernel:do_shared_workdir" | 89 | do_configure[depends] += "virtual/kernel:do_shared_workdir" |
90 | 90 | ||
diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst index c19ba5501c..f045feadff 100644 --- a/documentation/migration-guides/migration-2.1.rst +++ b/documentation/migration-guides/migration-2.1.rst | |||
@@ -64,7 +64,7 @@ Makefile Environment Changes | |||
64 | :term:`EXTRA_OEMAKE` now defaults to "" instead of | 64 | :term:`EXTRA_OEMAKE` now defaults to "" instead of |
65 | "-e MAKEFLAGS=". Setting :term:`EXTRA_OEMAKE` to "-e MAKEFLAGS=" by default | 65 | "-e MAKEFLAGS=". Setting :term:`EXTRA_OEMAKE` to "-e MAKEFLAGS=" by default |
66 | was a historical accident that has required many classes (e.g. | 66 | was a historical accident that has required many classes (e.g. |
67 | ``autotools``, ``module``) and recipes to override this default in order | 67 | :ref:`autotools <ref-classes-autotools>`, ``module``) and recipes to override this default in order |
68 | to work with sensible build systems. When upgrading to the release, you | 68 | to work with sensible build systems. When upgrading to the release, you |
69 | must edit any recipe that relies upon this old default by either setting | 69 | must edit any recipe that relies upon this old default by either setting |
70 | :term:`EXTRA_OEMAKE` back to "-e MAKEFLAGS=" or by explicitly setting any | 70 | :term:`EXTRA_OEMAKE` back to "-e MAKEFLAGS=" or by explicitly setting any |
@@ -191,7 +191,7 @@ The following classes have changed: | |||
191 | - ``autotools_stage``: Removed because the | 191 | - ``autotools_stage``: Removed because the |
192 | :ref:`autotools <ref-classes-autotools>` class now provides its | 192 | :ref:`autotools <ref-classes-autotools>` class now provides its |
193 | functionality. Recipes that inherited from ``autotools_stage`` should | 193 | functionality. Recipes that inherited from ``autotools_stage`` should |
194 | now inherit from ``autotools`` instead. | 194 | now inherit from :ref:`autotools <ref-classes-autotools>` instead. |
195 | 195 | ||
196 | - ``boot-directdisk``: Merged into the ``image-vm`` class. The | 196 | - ``boot-directdisk``: Merged into the ``image-vm`` class. The |
197 | ``boot-directdisk`` class was rarely directly used. Consequently, | 197 | ``boot-directdisk`` class was rarely directly used. Consequently, |
@@ -401,9 +401,9 @@ These additional changes exist: | |||
401 | as these directories are automatically found and added. | 401 | as these directories are automatically found and added. |
402 | 402 | ||
403 | - Inaccurate disk and CPU percentage data has been dropped from | 403 | - Inaccurate disk and CPU percentage data has been dropped from |
404 | ``buildstats`` output. This data has been replaced with | 404 | :ref:`buildstats <ref-classes-buildstats>` output. This data has been replaced with |
405 | ``getrusage()`` data and corrected IO statistics. You will probably | 405 | ``getrusage()`` data and corrected IO statistics. You will probably |
406 | need to update any custom code that reads the ``buildstats`` data. | 406 | need to update any custom code that reads the :ref:`buildstats <ref-classes-buildstats>` data. |
407 | 407 | ||
408 | - The ``meta/conf/distro/include/package_regex.inc`` is now deprecated. | 408 | - The ``meta/conf/distro/include/package_regex.inc`` is now deprecated. |
409 | The contents of this file have been moved to individual recipes. | 409 | The contents of this file have been moved to individual recipes. |
diff --git a/documentation/migration-guides/migration-2.3.rst b/documentation/migration-guides/migration-2.3.rst index d49ed474ca..4a1f159e92 100644 --- a/documentation/migration-guides/migration-2.3.rst +++ b/documentation/migration-guides/migration-2.3.rst | |||
@@ -481,9 +481,9 @@ The following miscellaneous changes have occurred: | |||
481 | is an unnecessary burden. | 481 | is an unnecessary burden. |
482 | 482 | ||
483 | If you need to preserve these ``.la`` files (e.g. in a custom | 483 | If you need to preserve these ``.la`` files (e.g. in a custom |
484 | distribution), you must change | 484 | distribution), you must change :term:`INHERIT_DISTRO` such that |
485 | :term:`INHERIT_DISTRO` such that | 485 | ":ref:`remove-libtool <ref-classes-remove-libtool>`" is not included |
486 | "remove-libtool" is not included in the value. | 486 | in the value. |
487 | 487 | ||
488 | - Extensible SDKs built for GCC 5+ now refuse to install on a | 488 | - Extensible SDKs built for GCC 5+ now refuse to install on a |
489 | distribution where the host GCC version is 4.8 or 4.9. This change | 489 | distribution where the host GCC version is 4.8 or 4.9. This change |
@@ -492,18 +492,17 @@ The following miscellaneous changes have occurred: | |||
492 | the :ref:`uninative <ref-classes-uninative>` class for additional | 492 | the :ref:`uninative <ref-classes-uninative>` class for additional |
493 | information. | 493 | information. |
494 | 494 | ||
495 | - All native and nativesdk recipes now use a separate | 495 | - All :ref:`native <ref-classes-native>` and |
496 | :ref:`nativesdk <ref-classes-nativesdk>` recipes now use a separate | ||
496 | :term:`DISTRO_FEATURES` value instead of sharing the value used by | 497 | :term:`DISTRO_FEATURES` value instead of sharing the value used by |
497 | recipes for the target, in order to avoid unnecessary rebuilds. | 498 | recipes for the target, in order to avoid unnecessary rebuilds. |
498 | 499 | ||
499 | The :term:`DISTRO_FEATURES` for ``native`` recipes is | 500 | The :term:`DISTRO_FEATURES` for :ref:`native <ref-classes-native>` recipes |
500 | :term:`DISTRO_FEATURES_NATIVE` added to | 501 | is :term:`DISTRO_FEATURES_NATIVE` added to an intersection of |
501 | an intersection of :term:`DISTRO_FEATURES` and | 502 | :term:`DISTRO_FEATURES` and :term:`DISTRO_FEATURES_FILTER_NATIVE`. |
502 | :term:`DISTRO_FEATURES_FILTER_NATIVE`. | ||
503 | 503 | ||
504 | For nativesdk recipes, the corresponding variables are | 504 | For :ref:`nativesdk <ref-classes-nativesdk>` recipes, the corresponding |
505 | :term:`DISTRO_FEATURES_NATIVESDK` | 505 | variables are :term:`DISTRO_FEATURES_NATIVESDK` and |
506 | and | ||
507 | :term:`DISTRO_FEATURES_FILTER_NATIVESDK`. | 506 | :term:`DISTRO_FEATURES_FILTER_NATIVESDK`. |
508 | 507 | ||
509 | - The ``FILESDIR`` variable, which was previously deprecated and rarely | 508 | - The ``FILESDIR`` variable, which was previously deprecated and rarely |
diff --git a/documentation/migration-guides/migration-2.6.rst b/documentation/migration-guides/migration-2.6.rst index eedede2457..59592997ff 100644 --- a/documentation/migration-guides/migration-2.6.rst +++ b/documentation/migration-guides/migration-2.6.rst | |||
@@ -128,7 +128,8 @@ missing from :term:`DEPENDS`). | |||
128 | 128 | ||
129 | This change affects classes beyond just the two mentioned (i.e. | 129 | This change affects classes beyond just the two mentioned (i.e. |
130 | ``distutils`` and ``distutils3``). Any recipe that inherits ``distutils*`` | 130 | ``distutils`` and ``distutils3``). Any recipe that inherits ``distutils*`` |
131 | classes are affected. For example, the ``setuptools`` and ``setuptools3`` | 131 | classes are affected. For example, the ``setuptools`` and |
132 | :ref:`setuptools3 <ref-classes-setuptools3>` | ||
132 | recipes are affected since they inherit the ``distutils*`` classes. | 133 | recipes are affected since they inherit the ``distutils*`` classes. |
133 | 134 | ||
134 | Fetching these types of dependencies that are not provided in the | 135 | Fetching these types of dependencies that are not provided in the |
@@ -315,13 +316,12 @@ This section provides information about automatic testing changes: | |||
315 | exists and has been replaced by the | 316 | exists and has been replaced by the |
316 | :term:`TESTIMAGE_AUTO` variable. | 317 | :term:`TESTIMAGE_AUTO` variable. |
317 | 318 | ||
318 | - Inheriting the ``testimage`` and ``testsdk`` Classes: Best | 319 | - Inheriting the :ref:`testimage <ref-classes-testimage>` and |
319 | practices now dictate that you use the | 320 | :ref:`testsdk <ref-classes-testsdk>` classes: best practices now dictate |
320 | :term:`IMAGE_CLASSES` variable rather than the | 321 | that you use the :term:`IMAGE_CLASSES` variable rather than the |
321 | :term:`INHERIT` variable when you inherit the | 322 | :term:`INHERIT` variable when you inherit the |
322 | :ref:`testimage <ref-classes-testimage>` and | 323 | :ref:`testimage <ref-classes-testimage>` and |
323 | :ref:`testsdk <ref-classes-testsdk>` classes used for automatic | 324 | :ref:`testsdk <ref-classes-testsdk>` classes used for automatic testing. |
324 | testing. | ||
325 | 325 | ||
326 | .. _migration-2.6-openssl-changes: | 326 | .. _migration-2.6-openssl-changes: |
327 | 327 | ||
diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst index 90736e6009..95a33d4dd4 100644 --- a/documentation/migration-guides/migration-3.0.rst +++ b/documentation/migration-guides/migration-3.0.rst | |||
@@ -282,8 +282,8 @@ The following miscellaneous changes have occurred. | |||
282 | - You must change the host distro identifier used in | 282 | - You must change the host distro identifier used in |
283 | :term:`NATIVELSBSTRING` to use all lowercase | 283 | :term:`NATIVELSBSTRING` to use all lowercase |
284 | characters even if it does not contain a version number. This change | 284 | characters even if it does not contain a version number. This change |
285 | is necessary only if you are not using ``uninative`` and | 285 | is necessary only if you are not using |
286 | :term:`SANITY_TESTED_DISTROS`. | 286 | :ref:`uninative <ref-classes-uninative>` and :term:`SANITY_TESTED_DISTROS`. |
287 | 287 | ||
288 | - In the ``base-files`` recipe, writing the hostname into | 288 | - In the ``base-files`` recipe, writing the hostname into |
289 | ``/etc/hosts`` and ``/etc/hostname`` is now done within the main | 289 | ``/etc/hosts`` and ``/etc/hostname`` is now done within the main |
diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index a714bd6bca..630d5c2b94 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst | |||
@@ -217,7 +217,13 @@ Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` cla | |||
217 | Custom SDK / SDK-style recipes need to include ``nativesdk-sdk-provides-dummy`` | 217 | Custom SDK / SDK-style recipes need to include ``nativesdk-sdk-provides-dummy`` |
218 | ------------------------------------------------------------------------------- | 218 | ------------------------------------------------------------------------------- |
219 | 219 | ||
220 | All ``nativesdk`` packages require ``/bin/sh`` due to their postinstall scriptlets, thus this package has to be dummy-provided within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have a custom SDK recipe (or your own SDK-style recipe similar to e.g. ``buildtools-tarball``), you will need to ensure ``nativesdk-sdk-provides-dummy`` or an equivalent is included in :term:`TOOLCHAIN_HOST_TASK`. | 220 | All :ref:`nativesdk <ref-classes-nativesdk>` packages require ``/bin/sh`` due |
221 | to their postinstall scriptlets, thus this package has to be dummy-provided | ||
222 | within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have | ||
223 | a custom SDK recipe (or your own SDK-style recipe similar to e.g. | ||
224 | ``buildtools-tarball``), you will need to ensure | ||
225 | ``nativesdk-sdk-provides-dummy`` or an equivalent is included in | ||
226 | :term:`TOOLCHAIN_HOST_TASK`. | ||
221 | 227 | ||
222 | 228 | ||
223 | ``ld.so.conf`` now moved back to main ``glibc`` package | 229 | ``ld.so.conf`` now moved back to main ``glibc`` package |
diff --git a/documentation/migration-guides/migration-3.3.rst b/documentation/migration-guides/migration-3.3.rst index aba5c4237c..d110aacd81 100644 --- a/documentation/migration-guides/migration-3.3.rst +++ b/documentation/migration-guides/migration-3.3.rst | |||
@@ -61,13 +61,15 @@ need to update those. | |||
61 | New ``python3targetconfig`` class | 61 | New ``python3targetconfig`` class |
62 | --------------------------------- | 62 | --------------------------------- |
63 | 63 | ||
64 | A new :ref:`python3targetconfig <ref-classes-python3targetconfig>` class has been | 64 | A new :ref:`python3targetconfig <ref-classes-python3targetconfig>` class has |
65 | created for situations where you would previously have inherited the | 65 | been created for situations where you would previously have inherited the |
66 | :ref:`python3native <ref-classes-python3native>` class but need access to target configuration data (such as | 66 | :ref:`python3native <ref-classes-python3native>` class but need access to |
67 | correct installation directories). Recipes where this situation applies should | 67 | target configuration data (such as correct installation directories). Recipes |
68 | be changed to inherit ``python3targetconfig`` instead of ``python3native``. This | 68 | where this situation applies should be changed to inherit |
69 | also adds a dependency on target ``python3``, so it should only be used where | 69 | :ref:`python3targetconfig <ref-classes-python3targetconfig>` instead of |
70 | appropriate in order to avoid unnecessarily lengthening builds. | 70 | :ref:`python3native <ref-classes-python3native>`. This also adds a dependency |
71 | on target ``python3``, so it should only be used where appropriate in order to | ||
72 | avoid unnecessarily lengthening builds. | ||
71 | 73 | ||
72 | Some example recipes where this change has been made: ``gpgme``, ``libcap-ng``, | 74 | Some example recipes where this change has been made: ``gpgme``, ``libcap-ng``, |
73 | ``python3-pycairo``. | 75 | ``python3-pycairo``. |
diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index 4ceea7b0e4..ac4d08e051 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst | |||
@@ -124,7 +124,7 @@ Removed classes | |||
124 | - ``image-mklibs``: not actively tested and upstream mklibs still | 124 | - ``image-mklibs``: not actively tested and upstream mklibs still |
125 | requires Python 2 | 125 | requires Python 2 |
126 | - ``meta``: no longer useful. Recipes that need to skip installing | 126 | - ``meta``: no longer useful. Recipes that need to skip installing |
127 | packages should inherit ``nopackages`` instead. | 127 | packages should inherit :ref:`nopackages <ref-classes-nopackages>` instead. |
128 | 128 | ||
129 | Prelinking disabled by default | 129 | Prelinking disabled by default |
130 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 130 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
diff --git a/documentation/migration-guides/migration-general.rst b/documentation/migration-guides/migration-general.rst index 847bdad739..8503017580 100644 --- a/documentation/migration-guides/migration-general.rst +++ b/documentation/migration-guides/migration-general.rst | |||
@@ -79,18 +79,19 @@ any new Yocto Project release. | |||
79 | the migration (e.g. added/removed packages, added/removed files, size | 79 | the migration (e.g. added/removed packages, added/removed files, size |
80 | changes etc.). To do this, follow these steps: | 80 | changes etc.). To do this, follow these steps: |
81 | 81 | ||
82 | 1. Enable buildhistory before the migration | 82 | 1. Enable :ref:`buildhistory <ref-classes-buildhistory>` before the migration |
83 | 83 | ||
84 | 2. Run a pre-migration build | 84 | 2. Run a pre-migration build |
85 | 85 | ||
86 | 3. Capture the buildhistory output (as specified by :term:`BUILDHISTORY_DIR`) | 86 | 3. Capture the :ref:`buildhistory <ref-classes-buildhistory>` output (as |
87 | and ensure it is preserved for subsequent builds. How you would do this | 87 | specified by :term:`BUILDHISTORY_DIR`) and ensure it is preserved for |
88 | depends on how you are running your builds - if you are doing this all on | 88 | subsequent builds. How you would do this depends on how you are running |
89 | one workstation in the same :term:`Build Directory` you may not need to do | 89 | your builds - if you are doing this all on one workstation in the same |
90 | anything other than not deleting the buildhistory output directory. For | 90 | :term:`Build Directory` you may not need to do anything other than not |
91 | builds in a pipeline it may be more complicated. | 91 | deleting the :ref:`buildhistory <ref-classes-buildhistory>` output |
92 | directory. For builds in a pipeline it may be more complicated. | ||
92 | 93 | ||
93 | 4. Set a tag in the buildhistory output (which is a git repository) before | 94 | 4. Set a tag in the :ref:`buildhistory <ref-classes-buildhistory>` output (which is a git repository) before |
94 | migration, to make the commit from the pre-migration build easy to find | 95 | migration, to make the commit from the pre-migration build easy to find |
95 | as you may end up running multiple builds during the migration. | 96 | as you may end up running multiple builds during the migration. |
96 | 97 | ||
@@ -99,7 +100,7 @@ any new Yocto Project release. | |||
99 | 6. Run a build | 100 | 6. Run a build |
100 | 101 | ||
101 | 7. Check the output changes between the previously set tag and HEAD in the | 102 | 7. Check the output changes between the previously set tag and HEAD in the |
102 | buildhistory output using ``git diff`` or ``buildhistory-diff``. | 103 | :ref:`buildhistory <ref-classes-buildhistory>` output using ``git diff`` or ``buildhistory-diff``. |
103 | 104 | ||
104 | For more information on using buildhistory, see | 105 | For more information on using :ref:`buildhistory <ref-classes-buildhistory>`, see |
105 | :ref:`dev-manual/common-tasks:maintaining build output quality`. | 106 | :ref:`dev-manual/common-tasks:maintaining build output quality`. |
diff --git a/documentation/migration-guides/release-notes-3.4.rst b/documentation/migration-guides/release-notes-3.4.rst index 62683b4a5c..83ca901016 100644 --- a/documentation/migration-guides/release-notes-3.4.rst +++ b/documentation/migration-guides/release-notes-3.4.rst | |||
@@ -7,7 +7,7 @@ New Features / Enhancements in 3.4 | |||
7 | - Linux kernel 5.14, glibc 2.34 and ~280 other recipe upgrades | 7 | - Linux kernel 5.14, glibc 2.34 and ~280 other recipe upgrades |
8 | - Switched override character to ':' (replacing '_') for more robust parsing and improved performance --- see the above migration guide for help | 8 | - Switched override character to ':' (replacing '_') for more robust parsing and improved performance --- see the above migration guide for help |
9 | - Rust integrated into core, providing rust support for cross-compilation and SDK | 9 | - Rust integrated into core, providing rust support for cross-compilation and SDK |
10 | - New create-spdx class for creating SPDX SBoM documents | 10 | - New :ref:`create-spdx <ref-classes-create-spdx>` class for creating SPDX SBoM documents |
11 | - New recipes: cargo, core-image-ptest-all, core-image-ptest-fast, core-image-weston-sdk, erofs-utils, gcompat, gi-docgen, libmicrohttpd, libseccomp, libstd-rs, perlcross, python3-markdown, python3-pyyaml, python3-smartypants, python3-typogrify, rust, rust-cross, rust-cross-canadian, rust-hello-world, rust-llvm, rust-tools-cross-canadian, rustfmt, xwayland | 11 | - New recipes: cargo, core-image-ptest-all, core-image-ptest-fast, core-image-weston-sdk, erofs-utils, gcompat, gi-docgen, libmicrohttpd, libseccomp, libstd-rs, perlcross, python3-markdown, python3-pyyaml, python3-smartypants, python3-typogrify, rust, rust-cross, rust-cross-canadian, rust-hello-world, rust-llvm, rust-tools-cross-canadian, rustfmt, xwayland |
12 | - Several optimisations to reduce unnecessary task dependencies for faster builds | 12 | - Several optimisations to reduce unnecessary task dependencies for faster builds |
13 | - seccomp integrated into core, with additional enabling for gnutls, systemd, qemu | 13 | - seccomp integrated into core, with additional enabling for gnutls, systemd, qemu |
@@ -68,7 +68,9 @@ New Features / Enhancements in 3.4 | |||
68 | - SDK-related enhancements: | 68 | - SDK-related enhancements: |
69 | 69 | ||
70 | - Enable :ref:`ref-tasks-populate_sdk` with multilibs | 70 | - Enable :ref:`ref-tasks-populate_sdk` with multilibs |
71 | - New ``SDKPATHINSTALL`` variable decouples default install path from built in path to avoid rebuilding nativesdk components on e.g. :term:`DISTRO_VERSION` changes | 71 | - New ``SDKPATHINSTALL`` variable decouples default install path from |
72 | built in path to avoid rebuilding :ref:`nativesdk <ref-classes-nativesdk>` | ||
73 | components on e.g. :term:`DISTRO_VERSION` changes | ||
72 | - eSDK: Error if trying to generate an eSDK from a multiconfig | 74 | - eSDK: Error if trying to generate an eSDK from a multiconfig |
73 | - eSDK: introduce :term:`TOOLCHAIN_HOST_TASK_ESDK` to be used in place of :term:`TOOLCHAIN_HOST_TASK` to add components to the host part of the eSDK | 75 | - eSDK: introduce :term:`TOOLCHAIN_HOST_TASK_ESDK` to be used in place of :term:`TOOLCHAIN_HOST_TASK` to add components to the host part of the eSDK |
74 | 76 | ||
diff --git a/documentation/migration-guides/release-notes-4.0.rst b/documentation/migration-guides/release-notes-4.0.rst index d57227502e..3be7342a9c 100644 --- a/documentation/migration-guides/release-notes-4.0.rst +++ b/documentation/migration-guides/release-notes-4.0.rst | |||
@@ -8,9 +8,10 @@ New Features / Enhancements in 4.0 | |||
8 | 8 | ||
9 | - Linux kernel 5.15, glibc 2.35 and ~300 other recipe upgrades | 9 | - Linux kernel 5.15, glibc 2.35 and ~300 other recipe upgrades |
10 | 10 | ||
11 | - Reproducibility: this release fixes the reproducibility issues with ``rust-llvm`` and | 11 | - Reproducibility: this release fixes the reproducibility issues with |
12 | ``golang``. Recipes in OpenEmbedded-Core are now fully reproducible. Functionality | 12 | ``rust-llvm`` and ``golang``. Recipes in OpenEmbedded-Core are now fully |
13 | previously in the optional "reproducible" class has been merged into the base class. | 13 | reproducible. Functionality previously in the optional "reproducible" |
14 | class has been merged into the :ref:`base <ref-classes-base>` class. | ||
14 | 15 | ||
15 | - Network access is now disabled by default for tasks other than where it is expected to ensure build integrity (where host kernel supports it) | 16 | - Network access is now disabled by default for tasks other than where it is expected to ensure build integrity (where host kernel supports it) |
16 | 17 | ||
@@ -215,7 +216,7 @@ New Features / Enhancements in 4.0 | |||
215 | - Ensure addition of patch-fuzz retriggers do_qa_patch | 216 | - Ensure addition of patch-fuzz retriggers do_qa_patch |
216 | - Added a sanity check for allarch packagegroups | 217 | - Added a sanity check for allarch packagegroups |
217 | 218 | ||
218 | - create-spdx class improvements: | 219 | - :ref:`create-spdx <ref-classes-create-spdx>` class improvements: |
219 | 220 | ||
220 | - Get SPDX-License-Identifier from source files | 221 | - Get SPDX-License-Identifier from source files |
221 | - Generate manifest also for SDKs | 222 | - Generate manifest also for SDKs |
@@ -235,8 +236,10 @@ New Features / Enhancements in 4.0 | |||
235 | 236 | ||
236 | - SDK-related enhancements: | 237 | - SDK-related enhancements: |
237 | 238 | ||
238 | - Extended recipes to ``nativesdk``: ``cargo``, ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging`` | 239 | - Extended recipes to :ref:`nativesdk <ref-classes-nativesdk>`: ``cargo``, |
239 | - Enabled nativesdk recipes to find a correct version of the rust cross compiler | 240 | ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging`` |
241 | - Enabled :ref:`nativesdk <ref-classes-nativesdk>` recipes to find a correct version | ||
242 | of the rust cross compiler | ||
240 | - Support creating per-toolchain cmake file in SDK | 243 | - Support creating per-toolchain cmake file in SDK |
241 | 244 | ||
242 | - Rust enhancements: | 245 | - Rust enhancements: |
diff --git a/documentation/migration-guides/release-notes-4.1.rst b/documentation/migration-guides/release-notes-4.1.rst index 119cc4fd2e..60402b6588 100644 --- a/documentation/migration-guides/release-notes-4.1.rst +++ b/documentation/migration-guides/release-notes-4.1.rst | |||
@@ -58,7 +58,7 @@ New Features / Enhancements in 4.1 | |||
58 | - Dependency of -dev package on main package is now an :term:`RRECOMMENDS` and can be easily set via new :term:`DEV_PKG_DEPENDENCY` variable | 58 | - Dependency of -dev package on main package is now an :term:`RRECOMMENDS` and can be easily set via new :term:`DEV_PKG_DEPENDENCY` variable |
59 | 59 | ||
60 | - Support for CPU, I/O and memory pressure regulation in BitBake | 60 | - Support for CPU, I/O and memory pressure regulation in BitBake |
61 | - Pressure data gathering in ``buildstats`` and rendering in ``pybootchartgui`` | 61 | - Pressure data gathering in :ref:`buildstats <ref-classes-buildstats>` and rendering in ``pybootchartgui`` |
62 | 62 | ||
63 | - New Picobuild system for lightweight Python PEP-517 build support in the :ref:`python_pep517 <ref-classes-python_pep517>` class | 63 | - New Picobuild system for lightweight Python PEP-517 build support in the :ref:`python_pep517 <ref-classes-python_pep517>` class |
64 | 64 | ||
@@ -99,8 +99,8 @@ New Features / Enhancements in 4.1 | |||
99 | - :ref:`Support for using the regular build system as an SDK <sdk-manual/extensible:Setting up the Extensible SDK environment directly in a Yocto build>` | 99 | - :ref:`Support for using the regular build system as an SDK <sdk-manual/extensible:Setting up the Extensible SDK environment directly in a Yocto build>` |
100 | - :ref:`image-buildinfo <ref-classes-image-buildinfo>` class now also writes build information to SDKs | 100 | - :ref:`image-buildinfo <ref-classes-image-buildinfo>` class now also writes build information to SDKs |
101 | - New :term:`SDK_TOOLCHAIN_LANGS` variable to control support of rust / go in SDK | 101 | - New :term:`SDK_TOOLCHAIN_LANGS` variable to control support of rust / go in SDK |
102 | - rust-llvm: enabled nativesdk variant | 102 | - rust-llvm: enabled :ref:`nativesdk <ref-classes-nativesdk>` variant |
103 | - python3-pluggy: enabled for native/nativesdk | 103 | - python3-pluggy: enabled for :ref:`native <ref-classes-native>` / :ref:`nativesdk <ref-classes-nativesdk>` |
104 | 104 | ||
105 | - QEMU/runqemu enhancements: | 105 | - QEMU/runqemu enhancements: |
106 | 106 | ||
@@ -113,7 +113,8 @@ New Features / Enhancements in 4.1 | |||
113 | - New variable :term:`UBOOT_MKIMAGE_KERNEL_TYPE` | 113 | - New variable :term:`UBOOT_MKIMAGE_KERNEL_TYPE` |
114 | - New variable :term:`FIT_PAD_ALG` to control FIT image padding algorithm | 114 | - New variable :term:`FIT_PAD_ALG` to control FIT image padding algorithm |
115 | - New :term:`KERNEL_DEPLOY_DEPEND` variable to allow disabling image dependency on deploying the kernel | 115 | - New :term:`KERNEL_DEPLOY_DEPEND` variable to allow disabling image dependency on deploying the kernel |
116 | - image_types: isolate the write of UBI configuration to a ``write_ubi_config`` function that can be easily overridden | 116 | - :ref:`image_types <ref-classes-image_types>`: isolate the write of UBI |
117 | configuration to a ``write_ubi_config`` function that can be easily overridden | ||
117 | 118 | ||
118 | - openssh: add support for config snippet includes to ssh and sshd | 119 | - openssh: add support for config snippet includes to ssh and sshd |
119 | - :ref:`create-spdx <ref-classes-create-spdx>`: Add ``SPDX_PRETTY`` option | 120 | - :ref:`create-spdx <ref-classes-create-spdx>`: Add ``SPDX_PRETTY`` option |
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index c495e4cc41..386a9e09d5 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
@@ -921,7 +921,7 @@ the analysis and package splitting process use several areas: | |||
921 | - :term:`STAGING_DIR_TARGET`: | 921 | - :term:`STAGING_DIR_TARGET`: |
922 | The path for the sysroot used when a component that is built to | 922 | The path for the sysroot used when a component that is built to |
923 | execute on a system and it generates code for yet another machine | 923 | execute on a system and it generates code for yet another machine |
924 | (e.g. cross-canadian recipes). | 924 | (e.g. :ref:`cross-canadian <ref-classes-cross-canadian>` recipes). |
925 | 925 | ||
926 | The :term:`FILES` variable defines the | 926 | The :term:`FILES` variable defines the |
927 | files that go into each package in | 927 | files that go into each package in |
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index ffa3e50ab6..3a13cf56ef 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -1406,7 +1406,7 @@ an optional Initramfs bundle, an optional RAM disk, and any number of | |||
1406 | device tree. | 1406 | device tree. |
1407 | 1407 | ||
1408 | To create a FIT image, it is required that :term:`KERNEL_CLASSES` | 1408 | To create a FIT image, it is required that :term:`KERNEL_CLASSES` |
1409 | is set to include "kernel-fitimage" and :term:`KERNEL_IMAGETYPE` | 1409 | is set to include ":ref:`kernel-fitimage <ref-classes-kernel-fitimage>`" and :term:`KERNEL_IMAGETYPE` |
1410 | is set to "fitImage". | 1410 | is set to "fitImage". |
1411 | 1411 | ||
1412 | The options for the device tree compiler passed to ``mkimage -D`` | 1412 | The options for the device tree compiler passed to ``mkimage -D`` |
@@ -2566,11 +2566,12 @@ uses these build systems, the recipe needs to inherit the :ref:`setuptools3 <ref | |||
2566 | ``setuptools3_legacy.bbclass`` | 2566 | ``setuptools3_legacy.bbclass`` |
2567 | ============================== | 2567 | ============================== |
2568 | 2568 | ||
2569 | The :ref:`setuptools3_legacy <ref-classes-setuptools3_legacy>` class supports Python version 3.x extensions that use | 2569 | The :ref:`setuptools3_legacy <ref-classes-setuptools3_legacy>` class supports |
2570 | build systems based on ``setuptools`` (e.g. only have a ``setup.py`` and have | 2570 | Python version 3.x extensions that use build systems based on ``setuptools`` |
2571 | not migrated to the official ``pyproject.toml`` format). Unlike | 2571 | (e.g. only have a ``setup.py`` and have not migrated to the official |
2572 | ``setuptools3.bbclass``, this uses the traditional ``setup.py`` ``build`` and | 2572 | ``pyproject.toml`` format). Unlike :ref:`setuptools3 <ref-classes-setuptools3>`, |
2573 | ``install`` commands and not wheels. This use of ``setuptools`` like this is | 2573 | this uses the traditional ``setup.py`` ``build`` and ``install`` commands and |
2574 | not wheels. This use of ``setuptools`` like this is | ||
2574 | `deprecated <https://github.com/pypa/setuptools/blob/main/CHANGES.rst#v5830>`__ | 2575 | `deprecated <https://github.com/pypa/setuptools/blob/main/CHANGES.rst#v5830>`__ |
2575 | but still relatively common. | 2576 | but still relatively common. |
2576 | 2577 | ||
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 8b08f88969..5436d94e1d 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
@@ -374,7 +374,8 @@ remove the ``build/sstate-cache`` directory. | |||
374 | ``build/tmp/buildstats/`` | 374 | ``build/tmp/buildstats/`` |
375 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | 375 | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
376 | 376 | ||
377 | This directory stores the build statistics. | 377 | This directory stores the build statistics as generated by the |
378 | :ref:`buildstats <ref-classes-buildstats>` class. | ||
378 | 379 | ||
379 | .. _structure-build-tmp-cache: | 380 | .. _structure-build-tmp-cache: |
380 | 381 | ||
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index d3aae63308..ca62365cc3 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -203,8 +203,9 @@ system and gives an overview of their function and contents. | |||
203 | packages should be checked for libraries and renamed according to | 203 | packages should be checked for libraries and renamed according to |
204 | Debian library package naming. | 204 | Debian library package naming. |
205 | 205 | ||
206 | The default value is "${PACKAGES}", which causes the debian class to | 206 | The default value is "${PACKAGES}", which causes the |
207 | act on all packages that are explicitly generated by the recipe. | 207 | :ref:`debian <ref-classes-debian>` class to act on all packages that are |
208 | explicitly generated by the recipe. | ||
208 | 209 | ||
209 | :term:`AUTOREV` | 210 | :term:`AUTOREV` |
210 | When :term:`SRCREV` is set to the value of this variable, it specifies to | 211 | When :term:`SRCREV` is set to the value of this variable, it specifies to |
@@ -576,9 +577,9 @@ system and gives an overview of their function and contents. | |||
576 | ``quilt-native``, which is a copy of Quilt built to run on the build | 577 | ``quilt-native``, which is a copy of Quilt built to run on the build |
577 | system; "crosses" such as ``gcc-cross``, which is a compiler built to | 578 | system; "crosses" such as ``gcc-cross``, which is a compiler built to |
578 | run on the build machine but produces binaries that run on the target | 579 | run on the build machine but produces binaries that run on the target |
579 | :term:`MACHINE`; "nativesdk", which targets the SDK | 580 | :term:`MACHINE`; ":ref:`nativesdk <ref-classes-nativesdk>`", which |
580 | machine instead of :term:`MACHINE`; and "mulitlibs" in the form | 581 | targets the SDK machine instead of :term:`MACHINE`; and "mulitlibs" in |
581 | "``multilib:``\ multilib_name". | 582 | the form "``multilib:``\ multilib_name". |
582 | 583 | ||
583 | To build a different variant of the recipe with a minimal amount of | 584 | To build a different variant of the recipe with a minimal amount of |
584 | code, it usually is as simple as adding the following to your recipe:: | 585 | code, it usually is as simple as adding the following to your recipe:: |
@@ -906,7 +907,7 @@ system and gives an overview of their function and contents. | |||
906 | The toolchain binary prefix used for native recipes. The OpenEmbedded | 907 | The toolchain binary prefix used for native recipes. The OpenEmbedded |
907 | build system uses the :term:`BUILD_PREFIX` value to set the | 908 | build system uses the :term:`BUILD_PREFIX` value to set the |
908 | :term:`TARGET_PREFIX` when building for | 909 | :term:`TARGET_PREFIX` when building for |
909 | ``native`` recipes. | 910 | :ref:`native <ref-classes-native>` recipes. |
910 | 911 | ||
911 | :term:`BUILD_STRIP` | 912 | :term:`BUILD_STRIP` |
912 | Specifies the command to be used to strip debugging symbols from | 913 | Specifies the command to be used to strip debugging symbols from |
@@ -917,7 +918,7 @@ system and gives an overview of their function and contents. | |||
917 | :term:`BUILD_SYS` | 918 | :term:`BUILD_SYS` |
918 | Specifies the system, including the architecture and the operating | 919 | Specifies the system, including the architecture and the operating |
919 | system, to use when building for the build host (i.e. when building | 920 | system, to use when building for the build host (i.e. when building |
920 | ``native`` recipes). | 921 | :ref:`native <ref-classes-native>` recipes). |
921 | 922 | ||
922 | The OpenEmbedded build system automatically sets this variable based | 923 | The OpenEmbedded build system automatically sets this variable based |
923 | on :term:`BUILD_ARCH`, | 924 | on :term:`BUILD_ARCH`, |
@@ -1417,8 +1418,10 @@ system and gives an overview of their function and contents. | |||
1417 | :term:`COPYLEFT_RECIPE_TYPES` | 1418 | :term:`COPYLEFT_RECIPE_TYPES` |
1418 | A space-separated list of recipe types to include in the source | 1419 | A space-separated list of recipe types to include in the source |
1419 | archived by the :ref:`archiver <ref-classes-archiver>` class. | 1420 | archived by the :ref:`archiver <ref-classes-archiver>` class. |
1420 | Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``, | 1421 | Recipe types are ``target``, :ref:`native <ref-classes-native>`, |
1421 | ``crosssdk``, and ``cross-canadian``. | 1422 | :ref:`nativesdk <ref-classes-nativesdk>`, |
1423 | :ref:`cross <ref-classes-cross>`, :ref:`crosssdk <ref-classes-crosssdk>`, | ||
1424 | and :ref:`cross-canadian <ref-classes-cross-canadian>`. | ||
1422 | 1425 | ||
1423 | The default value, which is "target*", for :term:`COPYLEFT_RECIPE_TYPES` | 1426 | The default value, which is "target*", for :term:`COPYLEFT_RECIPE_TYPES` |
1424 | is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>` | 1427 | is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>` |
@@ -1751,9 +1754,8 @@ system and gives an overview of their function and contents. | |||
1751 | :term:`DEPLOY_DIR_DEB` | 1754 | :term:`DEPLOY_DIR_DEB` |
1752 | Points to the area that the OpenEmbedded build system uses to place | 1755 | Points to the area that the OpenEmbedded build system uses to place |
1753 | Debian packages that are ready to be used outside of the build | 1756 | Debian packages that are ready to be used outside of the build |
1754 | system. This variable applies only when | 1757 | system. This variable applies only when :term:`PACKAGE_CLASSES` contains |
1755 | :term:`PACKAGE_CLASSES` contains | 1758 | ":ref:`package_deb <ref-classes-package_deb>`". |
1756 | "package_deb". | ||
1757 | 1759 | ||
1758 | The BitBake configuration file initially defines the | 1760 | The BitBake configuration file initially defines the |
1759 | :term:`DEPLOY_DIR_DEB` variable as a sub-folder of | 1761 | :term:`DEPLOY_DIR_DEB` variable as a sub-folder of |
@@ -1794,9 +1796,8 @@ system and gives an overview of their function and contents. | |||
1794 | :term:`DEPLOY_DIR_IPK` | 1796 | :term:`DEPLOY_DIR_IPK` |
1795 | Points to the area that the OpenEmbedded build system uses to place | 1797 | Points to the area that the OpenEmbedded build system uses to place |
1796 | IPK packages that are ready to be used outside of the build system. | 1798 | IPK packages that are ready to be used outside of the build system. |
1797 | This variable applies only when | 1799 | This variable applies only when :term:`PACKAGE_CLASSES` contains |
1798 | :term:`PACKAGE_CLASSES` contains | 1800 | ":ref:`package_ipk <ref-classes-package_ipk>`". |
1799 | "package_ipk". | ||
1800 | 1801 | ||
1801 | The BitBake configuration file initially defines this variable as a | 1802 | The BitBake configuration file initially defines this variable as a |
1802 | sub-folder of :term:`DEPLOY_DIR`:: | 1803 | sub-folder of :term:`DEPLOY_DIR`:: |
@@ -1814,9 +1815,8 @@ system and gives an overview of their function and contents. | |||
1814 | :term:`DEPLOY_DIR_RPM` | 1815 | :term:`DEPLOY_DIR_RPM` |
1815 | Points to the area that the OpenEmbedded build system uses to place | 1816 | Points to the area that the OpenEmbedded build system uses to place |
1816 | RPM packages that are ready to be used outside of the build system. | 1817 | RPM packages that are ready to be used outside of the build system. |
1817 | This variable applies only when | 1818 | This variable applies only when :term:`PACKAGE_CLASSES` contains |
1818 | :term:`PACKAGE_CLASSES` contains | 1819 | ":ref:`package_rpm <ref-classes-package_rpm>`". |
1819 | "package_rpm". | ||
1820 | 1820 | ||
1821 | The BitBake configuration file initially defines this variable as a | 1821 | The BitBake configuration file initially defines this variable as a |
1822 | sub-folder of :term:`DEPLOY_DIR`:: | 1822 | sub-folder of :term:`DEPLOY_DIR`:: |
@@ -1834,9 +1834,8 @@ system and gives an overview of their function and contents. | |||
1834 | :term:`DEPLOY_DIR_TAR` | 1834 | :term:`DEPLOY_DIR_TAR` |
1835 | Points to the area that the OpenEmbedded build system uses to place | 1835 | Points to the area that the OpenEmbedded build system uses to place |
1836 | tarballs that are ready to be used outside of the build system. This | 1836 | tarballs that are ready to be used outside of the build system. This |
1837 | variable applies only when | 1837 | variable applies only when :term:`PACKAGE_CLASSES` contains |
1838 | :term:`PACKAGE_CLASSES` contains | 1838 | ":ref:`package_tar <ref-classes-package_tar>`". |
1839 | "package_tar". | ||
1840 | 1839 | ||
1841 | The BitBake configuration file initially defines this variable as a | 1840 | The BitBake configuration file initially defines this variable as a |
1842 | sub-folder of :term:`DEPLOY_DIR`:: | 1841 | sub-folder of :term:`DEPLOY_DIR`:: |
@@ -1993,11 +1992,11 @@ system and gives an overview of their function and contents. | |||
1993 | 1992 | ||
1994 | :term:`DISTRO_FEATURES_FILTER_NATIVESDK` | 1993 | :term:`DISTRO_FEATURES_FILTER_NATIVESDK` |
1995 | Specifies a list of features that if present in the target | 1994 | Specifies a list of features that if present in the target |
1996 | :term:`DISTRO_FEATURES` value should be | 1995 | :term:`DISTRO_FEATURES` value should be included in |
1997 | included in :term:`DISTRO_FEATURES` when building nativesdk recipes. This | 1996 | :term:`DISTRO_FEATURES` when building |
1998 | variable is used in addition to the features filtered using the | 1997 | :ref:`nativesdk <ref-classes-nativesdk>` recipes. This variable is used |
1999 | :term:`DISTRO_FEATURES_NATIVESDK` | 1998 | in addition to the features filtered using the |
2000 | variable. | 1999 | :term:`DISTRO_FEATURES_NATIVESDK` variable. |
2001 | 2000 | ||
2002 | :term:`DISTRO_FEATURES_NATIVE` | 2001 | :term:`DISTRO_FEATURES_NATIVE` |
2003 | Specifies a list of features that should be included in | 2002 | Specifies a list of features that should be included in |
@@ -2010,10 +2009,9 @@ system and gives an overview of their function and contents. | |||
2010 | :term:`DISTRO_FEATURES_NATIVESDK` | 2009 | :term:`DISTRO_FEATURES_NATIVESDK` |
2011 | Specifies a list of features that should be included in | 2010 | Specifies a list of features that should be included in |
2012 | :term:`DISTRO_FEATURES` when building | 2011 | :term:`DISTRO_FEATURES` when building |
2013 | nativesdk recipes. This variable is used in addition to the features | 2012 | :ref:`nativesdk <ref-classes-nativesdk>` recipes. This variable is used |
2014 | filtered using the | 2013 | in addition to the features filtered using the |
2015 | :term:`DISTRO_FEATURES_FILTER_NATIVESDK` | 2014 | :term:`DISTRO_FEATURES_FILTER_NATIVESDK` variable. |
2016 | variable. | ||
2017 | 2015 | ||
2018 | :term:`DISTRO_NAME` | 2016 | :term:`DISTRO_NAME` |
2019 | The long name of the distribution. For information on the short name | 2017 | The long name of the distribution. For information on the short name |
@@ -4124,12 +4122,12 @@ system and gives an overview of their function and contents. | |||
4124 | 4122 | ||
4125 | :term:`KERNEL_CLASSES` | 4123 | :term:`KERNEL_CLASSES` |
4126 | A list of classes defining kernel image types that the | 4124 | A list of classes defining kernel image types that the |
4127 | :ref:`kernel <ref-classes-kernel>` class should inherit. You | 4125 | :ref:`kernel <ref-classes-kernel>` class should inherit. You typically |
4128 | typically append this variable to enable extended image types. An | 4126 | append this variable to enable extended image types. An example is |
4129 | example is the "kernel-fitimage", which enables fitImage support and | 4127 | ":ref:`kernel-fitimage <ref-classes-kernel-fitimage>`", which enables |
4130 | resides in ``meta/classes-recipe/kernel-fitimage.bbclass``. You can register | 4128 | fitImage support and resides in ``meta/classes-recipe/kernel-fitimage.bbclass``. |
4131 | custom kernel image types with the :ref:`kernel <ref-classes-kernel>` class using this | 4129 | You can register custom kernel image types with the |
4132 | variable. | 4130 | :ref:`kernel <ref-classes-kernel>` class using this variable. |
4133 | 4131 | ||
4134 | :term:`KERNEL_DEBUG_TIMESTAMPS` | 4132 | :term:`KERNEL_DEBUG_TIMESTAMPS` |
4135 | If set to "1", enables timestamping functionality during building | 4133 | If set to "1", enables timestamping functionality during building |
@@ -4949,16 +4947,18 @@ system and gives an overview of their function and contents. | |||
4949 | 4947 | ||
4950 | .. note:: | 4948 | .. note:: |
4951 | 4949 | ||
4952 | The "ML" in :term:`MLPREFIX` stands for "MultiLib". This representation is | 4950 | The "ML" in :term:`MLPREFIX` stands for "MultiLib". This representation |
4953 | historical and comes from a time when ``nativesdk`` was a suffix | 4951 | is historical and comes from a time when |
4954 | rather than a prefix on the recipe name. When ``nativesdk`` was turned | 4952 | ":ref:`nativesdk <ref-classes-nativesdk>`" |
4953 | was a suffix rather than a prefix on the recipe name. When | ||
4954 | ":ref:`nativesdk <ref-classes-nativesdk>`" was turned | ||
4955 | into a prefix, it made sense to set :term:`MLPREFIX` for it as well. | 4955 | into a prefix, it made sense to set :term:`MLPREFIX` for it as well. |
4956 | 4956 | ||
4957 | To help understand when :term:`MLPREFIX` might be needed, consider when | 4957 | To help understand when :term:`MLPREFIX` might be needed, consider when |
4958 | :term:`BBCLASSEXTEND` is used to provide a | 4958 | :term:`BBCLASSEXTEND` is used to provide a |
4959 | ``nativesdk`` version of a recipe in addition to the target version. | 4959 | :ref:`nativesdk <ref-classes-nativesdk>` version of a recipe in addition |
4960 | If that recipe declares build-time dependencies on tasks in other | 4960 | to the target version. If that recipe declares build-time dependencies |
4961 | recipes by using :term:`DEPENDS`, then a dependency on | 4961 | on tasks in other recipes by using :term:`DEPENDS`, then a dependency on |
4962 | "foo" will automatically get rewritten to a dependency on | 4962 | "foo" will automatically get rewritten to a dependency on |
4963 | "nativesdk-foo". However, dependencies like the following will not | 4963 | "nativesdk-foo". However, dependencies like the following will not |
4964 | get rewritten automatically:: | 4964 | get rewritten automatically:: |
@@ -5406,12 +5406,13 @@ system and gives an overview of their function and contents. | |||
5406 | OpenEmbedded build system uses when packaging data. | 5406 | OpenEmbedded build system uses when packaging data. |
5407 | 5407 | ||
5408 | You can provide one or more of the following arguments for the | 5408 | You can provide one or more of the following arguments for the |
5409 | variable: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk | 5409 | variable:: |
5410 | package_tar" | 5410 | |
5411 | PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk package_tar" | ||
5411 | 5412 | ||
5412 | .. note:: | 5413 | .. note:: |
5413 | 5414 | ||
5414 | While it is a legal option, the ``package_tar`` | 5415 | While it is a legal option, the :ref:`package_tar <ref-classes-package_tar>` |
5415 | class has limited functionality due to no support for package | 5416 | class has limited functionality due to no support for package |
5416 | dependencies by that backend. Therefore, it is recommended that | 5417 | dependencies by that backend. Therefore, it is recommended that |
5417 | you do not use it. | 5418 | you do not use it. |
@@ -5925,8 +5926,9 @@ system and gives an overview of their function and contents. | |||
5925 | :term:`PIXBUF_PACKAGES` | 5926 | :term:`PIXBUF_PACKAGES` |
5926 | When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>` | 5927 | When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>` |
5927 | class, this variable identifies packages that contain the pixbuf | 5928 | class, this variable identifies packages that contain the pixbuf |
5928 | loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache`` | 5929 | loaders used with ``gdk-pixbuf``. By default, the |
5929 | class assumes that the loaders are in the recipe's main package (i.e. | 5930 | :ref:`pixbufcache <ref-classes-pixbufcache>` class assumes that |
5931 | the loaders are in the recipe's main package (i.e. | ||
5930 | ``${``\ :term:`PN`\ ``}``). Use this variable if the | 5932 | ``${``\ :term:`PN`\ ``}``). Use this variable if the |
5931 | loaders you need are in a package other than that main package. | 5933 | loaders you need are in a package other than that main package. |
5932 | 5934 | ||
@@ -6358,7 +6360,7 @@ system and gives an overview of their function and contents. | |||
6358 | 6360 | ||
6359 | :term:`PYTHON_PN` | 6361 | :term:`PYTHON_PN` |
6360 | When used by recipes that inherit the | 6362 | When used by recipes that inherit the |
6361 | :ref:`setuptools3 <ref-classes-setuptools3>` classe, specifies the | 6363 | :ref:`setuptools3 <ref-classes-setuptools3>` class, specifies the |
6362 | major Python version being built. For Python 3.x, :term:`PYTHON_PN` would | 6364 | major Python version being built. For Python 3.x, :term:`PYTHON_PN` would |
6363 | be "python3". You do not have to set this variable as the | 6365 | be "python3". You do not have to set this variable as the |
6364 | OpenEmbedded build system automatically sets it for you. | 6366 | OpenEmbedded build system automatically sets it for you. |
@@ -6562,10 +6564,9 @@ system and gives an overview of their function and contents. | |||
6562 | for the same recipe, the :term:`REQUIRED_VERSION` value applies. | 6564 | for the same recipe, the :term:`REQUIRED_VERSION` value applies. |
6563 | 6565 | ||
6564 | :term:`RM_WORK_EXCLUDE` | 6566 | :term:`RM_WORK_EXCLUDE` |
6565 | With ``rm_work`` enabled, this variable specifies a list of recipes | 6567 | With :ref:`rm_work <ref-classes-rm-work>` enabled, this variable |
6566 | whose work directories should not be removed. See the | 6568 | specifies a list of recipes whose work directories should not be removed. |
6567 | ":ref:`ref-classes-rm-work`" section for more | 6569 | See the ":ref:`ref-classes-rm-work`" section for more details. |
6568 | details. | ||
6569 | 6570 | ||
6570 | :term:`ROOT_HOME` | 6571 | :term:`ROOT_HOME` |
6571 | Defines the root home directory. By default, this directory is set as | 6572 | Defines the root home directory. By default, this directory is set as |
@@ -6830,9 +6831,9 @@ system and gives an overview of their function and contents. | |||
6830 | 6831 | ||
6831 | :term:`SDK_DEPLOY` | 6832 | :term:`SDK_DEPLOY` |
6832 | The directory set up and used by the | 6833 | The directory set up and used by the |
6833 | :ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which | 6834 | :ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which the |
6834 | the SDK is deployed. The ``populate_sdk_base`` class defines | 6835 | SDK is deployed. The :ref:`populate_sdk_base <ref-classes-populate-sdk>` |
6835 | :term:`SDK_DEPLOY` as follows:: | 6836 | class defines :term:`SDK_DEPLOY` as follows:: |
6836 | 6837 | ||
6837 | SDK_DEPLOY = "${TMPDIR}/deploy/sdk" | 6838 | SDK_DEPLOY = "${TMPDIR}/deploy/sdk" |
6838 | 6839 | ||
@@ -6950,7 +6951,8 @@ system and gives an overview of their function and contents. | |||
6950 | :term:`SDK_DIR` variable for more information. | 6951 | :term:`SDK_DIR` variable for more information. |
6951 | 6952 | ||
6952 | :term:`SDK_PREFIX` | 6953 | :term:`SDK_PREFIX` |
6953 | The toolchain binary prefix used for ``nativesdk`` recipes. The | 6954 | The toolchain binary prefix used for |
6955 | :ref:`nativesdk <ref-classes-nativesdk>` recipes. The | ||
6954 | OpenEmbedded build system uses the :term:`SDK_PREFIX` value to set the | 6956 | OpenEmbedded build system uses the :term:`SDK_PREFIX` value to set the |
6955 | :term:`TARGET_PREFIX` when building | 6957 | :term:`TARGET_PREFIX` when building |
6956 | ``nativesdk`` recipes. The default value is "${SDK_SYS}-". | 6958 | ``nativesdk`` recipes. The default value is "${SDK_SYS}-". |
@@ -7761,7 +7763,7 @@ system and gives an overview of their function and contents. | |||
7761 | 7763 | ||
7762 | Some recipes build binaries that can run on the target system but | 7764 | Some recipes build binaries that can run on the target system but |
7763 | those binaries in turn generate code for another different system | 7765 | those binaries in turn generate code for another different system |
7764 | (e.g. cross-canadian recipes). Using terminology from GNU, the | 7766 | (e.g. :ref:`cross-canadian <ref-classes-cross-canadian>` recipes). Using terminology from GNU, the |
7765 | primary system is referred to as the "HOST" and the secondary, or | 7767 | primary system is referred to as the "HOST" and the secondary, or |
7766 | different, system is referred to as the "TARGET". Thus, the binaries | 7768 | different, system is referred to as the "TARGET". Thus, the binaries |
7767 | run on the "HOST" system and generate binaries for the "TARGET" | 7769 | run on the "HOST" system and generate binaries for the "TARGET" |
@@ -8205,8 +8207,8 @@ system and gives an overview of their function and contents. | |||
8205 | - For native recipes, the build system sets the variable to the | 8207 | - For native recipes, the build system sets the variable to the |
8206 | value of :term:`BUILD_PREFIX`. | 8208 | value of :term:`BUILD_PREFIX`. |
8207 | 8209 | ||
8208 | - For native SDK recipes (``nativesdk``), the build system sets the | 8210 | - For native SDK recipes (:ref:`nativesdk <ref-classes-nativesdk>`), |
8209 | variable to the value of :term:`SDK_PREFIX`. | 8211 | the build system sets the variable to the value of :term:`SDK_PREFIX`. |
8210 | 8212 | ||
8211 | :term:`TARGET_SYS` | 8213 | :term:`TARGET_SYS` |
8212 | Specifies the system, including the architecture and the operating | 8214 | Specifies the system, including the architecture and the operating |
@@ -8817,8 +8819,9 @@ system and gives an overview of their function and contents. | |||
8817 | :term:`UBOOT_MKIMAGE_DTCOPTS` | 8819 | :term:`UBOOT_MKIMAGE_DTCOPTS` |
8818 | Options for the device tree compiler passed to mkimage '-D' | 8820 | Options for the device tree compiler passed to mkimage '-D' |
8819 | feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. | 8821 | feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. |
8820 | If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then kernel-fitimage will not | 8822 | If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then |
8821 | pass the ``-D`` option to mkimage. | 8823 | :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` will not pass the |
8824 | ``-D`` option to mkimage. | ||
8822 | 8825 | ||
8823 | :term:`UBOOT_MKIMAGE_KERNEL_TYPE` | 8826 | :term:`UBOOT_MKIMAGE_KERNEL_TYPE` |
8824 | Specifies the type argument for the kernel as passed to ``uboot-mkimage``. | 8827 | Specifies the type argument for the kernel as passed to ``uboot-mkimage``. |
diff --git a/documentation/test-manual/understand-autobuilder.rst b/documentation/test-manual/understand-autobuilder.rst index 66471972de..70ec4535f5 100644 --- a/documentation/test-manual/understand-autobuilder.rst +++ b/documentation/test-manual/understand-autobuilder.rst | |||
@@ -206,7 +206,7 @@ are general setup steps that are run once and include: | |||
206 | 206 | ||
207 | #. Set up any ``buildtools-tarball`` if configured. | 207 | #. Set up any ``buildtools-tarball`` if configured. |
208 | 208 | ||
209 | #. Call "buildhistory-init" if buildhistory is configured. | 209 | #. Call "buildhistory-init" if :ref:`buildhistory <ref-classes-buildhistory>` is configured. |
210 | 210 | ||
211 | For each step that is configured in ``config.json``, it will perform the | 211 | For each step that is configured in ``config.json``, it will perform the |
212 | following: | 212 | following: |