diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-11-24 17:50:52 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-12-01 19:20:29 +0000 |
commit | 945c669138a76be18c6b4da4f8f907d2a5cfd83f (patch) | |
tree | cebff3cae5021d4fcceb5aa51fce1c2aead97ed2 /documentation/ref-manual | |
parent | 6fe3143800925463279d0664fc7f3372b53c6c52 (diff) | |
download | poky-945c669138a76be18c6b4da4f8f907d2a5cfd83f.tar.gz |
manuals: split dev-manual/common-tasks.rst
A 500 KB source file is always harder to manage,
and can have section title conflicts.
So, the "Common Tasks" document is gone and all
its constituents are moved up one level.
You now have 40 chapters in the Development Tasks Manual.
(From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/classes.rst | 38 | ||||
-rw-r--r-- | documentation/ref-manual/devtool-reference.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/faq.rst | 6 | ||||
-rw-r--r-- | documentation/ref-manual/features.rst | 8 | ||||
-rw-r--r-- | documentation/ref-manual/images.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/kickstart.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/release-process.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/resources.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/structure.rst | 12 | ||||
-rw-r--r-- | documentation/ref-manual/system-requirements.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/tasks.rst | 10 | ||||
-rw-r--r-- | documentation/ref-manual/terms.rst | 8 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 112 |
13 files changed, 107 insertions, 107 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index aeab72a1e4..9f8593831f 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -74,7 +74,7 @@ The :ref:`archiver <ref-classes-archiver>` class supports releasing source code | |||
74 | materials with the binaries. | 74 | materials with the binaries. |
75 | 75 | ||
76 | For more details on the source :ref:`archiver <ref-classes-archiver>`, see the | 76 | For more details on the source :ref:`archiver <ref-classes-archiver>`, see the |
77 | ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" | 77 | ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" |
78 | section in the Yocto Project Development Tasks Manual. You can also see | 78 | section in the Yocto Project Development Tasks Manual. You can also see |
79 | the :term:`ARCHIVER_MODE` variable for information | 79 | the :term:`ARCHIVER_MODE` variable for information |
80 | about the variable flags (varflags) that help control archive creation. | 80 | about the variable flags (varflags) that help control archive creation. |
@@ -93,7 +93,7 @@ standardization. This class defines a set of tasks (e.g. ``configure``, | |||
93 | should usually be enough to define a few standard variables and then | 93 | should usually be enough to define a few standard variables and then |
94 | simply ``inherit autotools``. These classes can also work with software | 94 | simply ``inherit autotools``. These classes can also work with software |
95 | that emulates Autotools. For more information, see the | 95 | that emulates Autotools. For more information, see the |
96 | ":ref:`dev-manual/common-tasks:autotooled package`" section | 96 | ":ref:`dev-manual/new-recipe:autotooled package`" section |
97 | in the Yocto Project Development Tasks Manual. | 97 | in the Yocto Project Development Tasks Manual. |
98 | 98 | ||
99 | By default, the :ref:`autotools* <ref-classes-autotools>` classes use out-of-tree builds (i.e. | 99 | By default, the :ref:`autotools* <ref-classes-autotools>` classes use out-of-tree builds (i.e. |
@@ -222,7 +222,7 @@ The :ref:`buildhistory <ref-classes-buildhistory>` class records a history of bu | |||
222 | which can be used to detect possible regressions as well as used for | 222 | which can be used to detect possible regressions as well as used for |
223 | analysis of the build output. For more information on using Build | 223 | analysis of the build output. For more information on using Build |
224 | History, see the | 224 | History, see the |
225 | ":ref:`dev-manual/common-tasks:maintaining build output quality`" | 225 | ":ref:`dev-manual/build-quality:maintaining build output quality`" |
226 | section in the Yocto Project Development Tasks Manual. | 226 | section in the Yocto Project Development Tasks Manual. |
227 | 227 | ||
228 | .. _ref-classes-buildstats: | 228 | .. _ref-classes-buildstats: |
@@ -390,7 +390,7 @@ by the :term:`SPDX_PRETTY`, :term:`SPDX_ARCHIVE_PACKAGED`, | |||
390 | :term:`SPDX_ARCHIVE_SOURCES` and :term:`SPDX_INCLUDE_SOURCES` variables. | 390 | :term:`SPDX_ARCHIVE_SOURCES` and :term:`SPDX_INCLUDE_SOURCES` variables. |
391 | 391 | ||
392 | See the description of these variables and the | 392 | See the description of these variables and the |
393 | ":ref:`dev-manual/common-tasks:creating a software bill of materials`" | 393 | ":ref:`dev-manual/sbom:creating a software bill of materials`" |
394 | section in the Yocto Project Development Manual for more details. | 394 | section in the Yocto Project Development Manual for more details. |
395 | 395 | ||
396 | .. _ref-classes-cross: | 396 | .. _ref-classes-cross: |
@@ -484,7 +484,7 @@ These can only be detected by reviewing the details of the issues and iterating | |||
484 | and following what happens in other Linux distributions and in the greater open source community. | 484 | and following what happens in other Linux distributions and in the greater open source community. |
485 | 485 | ||
486 | You will find some more details in the | 486 | You will find some more details in the |
487 | ":ref:`dev-manual/common-tasks:checking for vulnerabilities`" | 487 | ":ref:`dev-manual/vulnerabilities:checking for vulnerabilities`" |
488 | section in the Development Tasks Manual. | 488 | section in the Development Tasks Manual. |
489 | 489 | ||
490 | .. _ref-classes-debian: | 490 | .. _ref-classes-debian: |
@@ -524,7 +524,7 @@ staging the files from :term:`DEPLOYDIR` to :term:`DEPLOY_DIR_IMAGE`. | |||
524 | ==================== | 524 | ==================== |
525 | 525 | ||
526 | The :ref:`devshell <ref-classes-devshell>` class adds the :ref:`ref-tasks-devshell` task. Distribution | 526 | The :ref:`devshell <ref-classes-devshell>` class adds the :ref:`ref-tasks-devshell` task. Distribution |
527 | policy dictates whether to include this class. See the ":ref:`dev-manual/common-tasks:using a development shell`" | 527 | policy dictates whether to include this class. See the ":ref:`dev-manual/development-shell:using a development shell`" |
528 | section in the Yocto Project Development Tasks Manual for more | 528 | section in the Yocto Project Development Tasks Manual for more |
529 | information about using :ref:`devshell <ref-classes-devshell>`. | 529 | information about using :ref:`devshell <ref-classes-devshell>`. |
530 | 530 | ||
@@ -598,7 +598,7 @@ For more information on the :ref:`externalsrc <ref-classes-externalsrc>` class, | |||
598 | ``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`. | 598 | ``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`. |
599 | For information on how to use the | 599 | For information on how to use the |
600 | :ref:`externalsrc <ref-classes-externalsrc>` class, see the | 600 | :ref:`externalsrc <ref-classes-externalsrc>` class, see the |
601 | ":ref:`dev-manual/common-tasks:building software from an external source`" | 601 | ":ref:`dev-manual/building:building software from an external source`" |
602 | section in the Yocto Project Development Tasks Manual. | 602 | section in the Yocto Project Development Tasks Manual. |
603 | 603 | ||
604 | .. _ref-classes-extrausers: | 604 | .. _ref-classes-extrausers: |
@@ -962,7 +962,7 @@ then one or more image files are created. | |||
962 | install into the image. | 962 | install into the image. |
963 | 963 | ||
964 | For information on customizing images, see the | 964 | For information on customizing images, see the |
965 | ":ref:`dev-manual/common-tasks:customizing images`" section | 965 | ":ref:`dev-manual/customizing-images:customizing images`" section |
966 | in the Yocto Project Development Tasks Manual. For information on how | 966 | in the Yocto Project Development Tasks Manual. For information on how |
967 | images are created, see the | 967 | images are created, see the |
968 | ":ref:`overview-manual/concepts:images`" section in the | 968 | ":ref:`overview-manual/concepts:images`" section in the |
@@ -1364,7 +1364,7 @@ packages such as ``kernel-vmlinux``. | |||
1364 | The :ref:`kernel <ref-classes-kernel>` class contains logic that allows you to embed an initial | 1364 | The :ref:`kernel <ref-classes-kernel>` class contains logic that allows you to embed an initial |
1365 | RAM filesystem (:term:`Initramfs`) image when you build the kernel image. For | 1365 | RAM filesystem (:term:`Initramfs`) image when you build the kernel image. For |
1366 | information on how to build an :term:`Initramfs`, see the | 1366 | information on how to build an :term:`Initramfs`, see the |
1367 | ":ref:`dev-manual/common-tasks:building an initial ram filesystem (Initramfs) image`" section in | 1367 | ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section in |
1368 | the Yocto Project Development Tasks Manual. | 1368 | the Yocto Project Development Tasks Manual. |
1369 | 1369 | ||
1370 | Various other classes are used by the :ref:`kernel <ref-classes-kernel>` and :ref:`module <ref-classes-module>` classes | 1370 | Various other classes are used by the :ref:`kernel <ref-classes-kernel>` and :ref:`module <ref-classes-module>` classes |
@@ -1674,7 +1674,7 @@ different target optimizations or target architectures and installing | |||
1674 | them side-by-side in the same image. | 1674 | them side-by-side in the same image. |
1675 | 1675 | ||
1676 | For more information on using the Multilib feature, see the | 1676 | For more information on using the Multilib feature, see the |
1677 | ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" | 1677 | ":ref:`dev-manual/libraries:combining multiple versions of library files into one image`" |
1678 | section in the Yocto Project Development Tasks Manual. | 1678 | section in the Yocto Project Development Tasks Manual. |
1679 | 1679 | ||
1680 | .. _ref-classes-native: | 1680 | .. _ref-classes-native: |
@@ -1782,7 +1782,7 @@ Provides support for building Node.js software fetched using the | |||
1782 | fetcher to have dependencies fetched and packaged automatically. | 1782 | fetcher to have dependencies fetched and packaged automatically. |
1783 | 1783 | ||
1784 | For information on how to create NPM packages, see the | 1784 | For information on how to create NPM packages, see the |
1785 | ":ref:`dev-manual/common-tasks:creating node package manager (npm) packages`" | 1785 | ":ref:`dev-manual/packages:creating node package manager (npm) packages`" |
1786 | section in the Yocto Project Development Tasks Manual. | 1786 | section in the Yocto Project Development Tasks Manual. |
1787 | 1787 | ||
1788 | .. _ref-classes-oelint: | 1788 | .. _ref-classes-oelint: |
@@ -1958,7 +1958,7 @@ If you take the optional step to set up a repository (package feed) on | |||
1958 | the development host that can be used by DNF, you can install packages | 1958 | the development host that can be used by DNF, you can install packages |
1959 | from the feed while you are running the image on the target (i.e. | 1959 | from the feed while you are running the image on the target (i.e. |
1960 | runtime installation of packages). For more information, see the | 1960 | runtime installation of packages). For more information, see the |
1961 | ":ref:`dev-manual/common-tasks:using runtime package management`" | 1961 | ":ref:`dev-manual/packages:using runtime package management`" |
1962 | section in the Yocto Project Development Tasks Manual. | 1962 | section in the Yocto Project Development Tasks Manual. |
1963 | 1963 | ||
1964 | The package-specific class you choose can affect build-time performance | 1964 | The package-specific class you choose can affect build-time performance |
@@ -2077,7 +2077,7 @@ so forth). It is highly recommended that all package group recipes | |||
2077 | inherit this class. | 2077 | inherit this class. |
2078 | 2078 | ||
2079 | For information on how to use this class, see the | 2079 | For information on how to use this class, see the |
2080 | ":ref:`dev-manual/common-tasks:customizing images using custom package groups`" | 2080 | ":ref:`dev-manual/customizing-images:customizing images using custom package groups`" |
2081 | section in the Yocto Project Development Tasks Manual. | 2081 | section in the Yocto Project Development Tasks Manual. |
2082 | 2082 | ||
2083 | Previously, this class was called the ``task`` class. | 2083 | Previously, this class was called the ``task`` class. |
@@ -2292,7 +2292,7 @@ The :ref:`primport <ref-classes-primport>` class provides functionality for impo | |||
2292 | ================== | 2292 | ================== |
2293 | 2293 | ||
2294 | The :ref:`prserv <ref-classes-prserv>` class provides functionality for using a :ref:`PR | 2294 | The :ref:`prserv <ref-classes-prserv>` class provides functionality for using a :ref:`PR |
2295 | service <dev-manual/common-tasks:working with a pr service>` in order to | 2295 | service <dev-manual/packages:working with a pr service>` in order to |
2296 | automatically manage the incrementing of the :term:`PR` | 2296 | automatically manage the incrementing of the :term:`PR` |
2297 | variable for each recipe. | 2297 | variable for each recipe. |
2298 | 2298 | ||
@@ -2312,7 +2312,7 @@ runtime tests for recipes that build software that provides these tests. | |||
2312 | This class is intended to be inherited by individual recipes. However, | 2312 | This class is intended to be inherited by individual recipes. However, |
2313 | the class' functionality is largely disabled unless "ptest" appears in | 2313 | the class' functionality is largely disabled unless "ptest" appears in |
2314 | :term:`DISTRO_FEATURES`. See the | 2314 | :term:`DISTRO_FEATURES`. See the |
2315 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" | 2315 | ":ref:`dev-manual/packages:testing packages with ptest`" |
2316 | section in the Yocto Project Development Tasks Manual for more information | 2316 | section in the Yocto Project Development Tasks Manual for more information |
2317 | on ptest. | 2317 | on ptest. |
2318 | 2318 | ||
@@ -2325,7 +2325,7 @@ Enables package tests (ptests) specifically for GNOME packages, which | |||
2325 | have tests intended to be executed with ``gnome-desktop-testing``. | 2325 | have tests intended to be executed with ``gnome-desktop-testing``. |
2326 | 2326 | ||
2327 | For information on setting up and running ptests, see the | 2327 | For information on setting up and running ptests, see the |
2328 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" | 2328 | ":ref:`dev-manual/packages:testing packages with ptest`" |
2329 | section in the Yocto Project Development Tasks Manual. | 2329 | section in the Yocto Project Development Tasks Manual. |
2330 | 2330 | ||
2331 | .. _ref-classes-python3-dir: | 2331 | .. _ref-classes-python3-dir: |
@@ -2413,7 +2413,7 @@ override the removal by setting ``REMOVE_LIBTOOL_LA`` to "0" as follows:: | |||
2413 | ======================== | 2413 | ======================== |
2414 | 2414 | ||
2415 | The :ref:`report-error <ref-classes-report-error>` class supports enabling the :ref:`error reporting | 2415 | The :ref:`report-error <ref-classes-report-error>` class supports enabling the :ref:`error reporting |
2416 | tool <dev-manual/common-tasks:using the error reporting tool>`", | 2416 | tool <dev-manual/error-reporting-tool:using the error reporting tool>`", |
2417 | which allows you to submit build error information to a central database. | 2417 | which allows you to submit build error information to a central database. |
2418 | 2418 | ||
2419 | The class collects debug information for recipe, recipe version, task, | 2419 | The class collects debug information for recipe, recipe version, task, |
@@ -2810,7 +2810,7 @@ unless you have set | |||
2810 | :term:`SYSTEMD_AUTO_ENABLE` to "disable". | 2810 | :term:`SYSTEMD_AUTO_ENABLE` to "disable". |
2811 | 2811 | ||
2812 | For more information on :ref:`systemd <ref-classes-systemd>`, see the | 2812 | For more information on :ref:`systemd <ref-classes-systemd>`, see the |
2813 | ":ref:`dev-manual/common-tasks:selecting an initialization manager`" | 2813 | ":ref:`dev-manual/init-manager:selecting an initialization manager`" |
2814 | section in the Yocto Project Development Tasks Manual. | 2814 | section in the Yocto Project Development Tasks Manual. |
2815 | 2815 | ||
2816 | .. _ref-classes-systemd-boot: | 2816 | .. _ref-classes-systemd-boot: |
@@ -2885,7 +2885,7 @@ after it is built, you can set :term:`TESTIMAGE_AUTO`:: | |||
2885 | TESTIMAGE_AUTO = "1" | 2885 | TESTIMAGE_AUTO = "1" |
2886 | 2886 | ||
2887 | For information on how to enable, run, and create new tests, see the | 2887 | For information on how to enable, run, and create new tests, see the |
2888 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 2888 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
2889 | section in the Yocto Project Development Tasks Manual. | 2889 | section in the Yocto Project Development Tasks Manual. |
2890 | 2890 | ||
2891 | .. _ref-classes-testsdk: | 2891 | .. _ref-classes-testsdk: |
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index 997ec0351c..c2e1c2c29b 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst | |||
@@ -410,7 +410,7 @@ Upgrading a Recipe | |||
410 | As software matures, upstream recipes are upgraded to newer versions. As | 410 | As software matures, upstream recipes are upgraded to newer versions. As |
411 | a developer, you need to keep your local recipes up-to-date with the | 411 | a developer, you need to keep your local recipes up-to-date with the |
412 | upstream version releases. There are several ways of upgrading recipes. | 412 | upstream version releases. There are several ways of upgrading recipes. |
413 | You can read about them in the ":ref:`dev-manual/common-tasks:upgrading recipes`" | 413 | You can read about them in the ":ref:`dev-manual/upgrading-recipes:upgrading recipes`" |
414 | section of the Yocto Project Development Tasks Manual. This section | 414 | section of the Yocto Project Development Tasks Manual. This section |
415 | overviews the ``devtool upgrade`` command. | 415 | overviews the ``devtool upgrade`` command. |
416 | 416 | ||
@@ -438,7 +438,7 @@ You can read more on the ``devtool upgrade`` workflow in the | |||
438 | ":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" | 438 | ":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" |
439 | section in the Yocto Project Application Development and the Extensible | 439 | section in the Yocto Project Application Development and the Extensible |
440 | Software Development Kit (eSDK) manual. You can also see an example of | 440 | Software Development Kit (eSDK) manual. You can also see an example of |
441 | how to use ``devtool upgrade`` in the ":ref:`dev-manual/common-tasks:using \`\`devtool upgrade\`\``" | 441 | how to use ``devtool upgrade`` in the ":ref:`dev-manual/upgrading-recipes:using \`\`devtool upgrade\`\``" |
442 | section in the Yocto Project Development Tasks Manual. | 442 | section in the Yocto Project Development Tasks Manual. |
443 | 443 | ||
444 | .. _devtool-resetting-a-recipe: | 444 | .. _devtool-resetting-a-recipe: |
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index d35ab78bff..8f38808a78 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst | |||
@@ -291,7 +291,7 @@ How do I make the Yocto Project support my board? | |||
291 | Support for an additional board is added by creating a Board | 291 | Support for an additional board is added by creating a Board |
292 | Support Package (BSP) layer for it. For more information on how to | 292 | Support Package (BSP) layer for it. For more information on how to |
293 | create a BSP layer, see the | 293 | create a BSP layer, see the |
294 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 294 | ":ref:`dev-manual/layers:understanding and creating layers`" |
295 | section in the Yocto Project Development Tasks Manual and the | 295 | section in the Yocto Project Development Tasks Manual and the |
296 | :doc:`/bsp-guide/index`. | 296 | :doc:`/bsp-guide/index`. |
297 | 297 | ||
@@ -303,7 +303,7 @@ How do I make the Yocto Project support my package? | |||
303 | 303 | ||
304 | To add a package, you need to create a BitBake recipe. For | 304 | To add a package, you need to create a BitBake recipe. For |
305 | information on how to create a BitBake recipe, see the | 305 | information on how to create a BitBake recipe, see the |
306 | ":ref:`dev-manual/common-tasks:writing a new recipe`" | 306 | ":ref:`dev-manual/new-recipe:writing a new recipe`" |
307 | section in the Yocto Project Development Tasks Manual. | 307 | section in the Yocto Project Development Tasks Manual. |
308 | 308 | ||
309 | What do I need to ship for license compliance? | 309 | What do I need to ship for license compliance? |
@@ -320,7 +320,7 @@ configured and built. | |||
320 | You can find more information on licensing in the | 320 | You can find more information on licensing in the |
321 | ":ref:`overview-manual/development-environment:licensing`" | 321 | ":ref:`overview-manual/development-environment:licensing`" |
322 | section in the Yocto Project Overview and Concepts Manual and also in the | 322 | section in the Yocto Project Overview and Concepts Manual and also in the |
323 | ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" | 323 | ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" |
324 | section in the Yocto Project Development Tasks Manual. | 324 | section in the Yocto Project Development Tasks Manual. |
325 | 325 | ||
326 | Do I have to make a full reflash after recompiling one package? | 326 | Do I have to make a full reflash after recompiling one package? |
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst index 71d3c5e2aa..0229747650 100644 --- a/documentation/ref-manual/features.rst +++ b/documentation/ref-manual/features.rst | |||
@@ -143,7 +143,7 @@ metadata, as extra layers can define their own: | |||
143 | - *cramfs:* Include CramFS support. | 143 | - *cramfs:* Include CramFS support. |
144 | 144 | ||
145 | - *debuginfod:* Include support for getting ELF debugging information through | 145 | - *debuginfod:* Include support for getting ELF debugging information through |
146 | a :ref:`debuginfod <dev-manual/common-tasks:using the debuginfod server method>` | 146 | a :ref:`debuginfod <dev-manual/debugging:using the debuginfod server method>` |
147 | server. | 147 | server. |
148 | 148 | ||
149 | - *directfb:* Include DirectFB support. | 149 | - *directfb:* Include DirectFB support. |
@@ -202,7 +202,7 @@ metadata, as extra layers can define their own: | |||
202 | 202 | ||
203 | - *ptest:* Enables building the package tests where supported by | 203 | - *ptest:* Enables building the package tests where supported by |
204 | individual recipes. For more information on package tests, see the | 204 | individual recipes. For more information on package tests, see the |
205 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" section | 205 | ":ref:`dev-manual/packages:testing packages with ptest`" section |
206 | in the Yocto Project Development Tasks Manual. | 206 | in the Yocto Project Development Tasks Manual. |
207 | 207 | ||
208 | - *pulseaudio:* Include support for | 208 | - *pulseaudio:* Include support for |
@@ -325,7 +325,7 @@ Here are the image features available for all images: | |||
325 | 325 | ||
326 | - *read-only-rootfs:* Creates an image whose root filesystem is | 326 | - *read-only-rootfs:* Creates an image whose root filesystem is |
327 | read-only. See the | 327 | read-only. See the |
328 | ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" | 328 | ":ref:`dev-manual/read-only-rootfs:creating a read-only root filesystem`" |
329 | section in the Yocto Project Development Tasks Manual for more | 329 | section in the Yocto Project Development Tasks Manual for more |
330 | information. | 330 | information. |
331 | 331 | ||
@@ -394,7 +394,7 @@ these valid features is as follows: | |||
394 | 394 | ||
395 | - *tools-debug:* Installs debugging tools such as ``strace`` and | 395 | - *tools-debug:* Installs debugging tools such as ``strace`` and |
396 | ``gdb``. For information on GDB, see the | 396 | ``gdb``. For information on GDB, see the |
397 | ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section | 397 | ":ref:`dev-manual/debugging:debugging with the gnu project debugger (gdb) remotely`" section |
398 | in the Yocto Project Development Tasks Manual. For information on | 398 | in the Yocto Project Development Tasks Manual. For information on |
399 | tracing and profiling, see the :doc:`/profile-manual/index`. | 399 | tracing and profiling, see the :doc:`/profile-manual/index`. |
400 | 400 | ||
diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst index 4b771d0601..d52b39f3cf 100644 --- a/documentation/ref-manual/images.rst +++ b/documentation/ref-manual/images.rst | |||
@@ -117,7 +117,7 @@ Following is a list of supported recipes: | |||
117 | deployed to a separate partition so that you can boot into it and use | 117 | deployed to a separate partition so that you can boot into it and use |
118 | it to deploy a second image to be tested. You can find more | 118 | it to deploy a second image to be tested. You can find more |
119 | information about runtime testing in the | 119 | information about runtime testing in the |
120 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 120 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
121 | section in the Yocto Project Development Tasks Manual. | 121 | section in the Yocto Project Development Tasks Manual. |
122 | 122 | ||
123 | - ``core-image-testmaster-initramfs``: A RAM-based Initial Root | 123 | - ``core-image-testmaster-initramfs``: A RAM-based Initial Root |
@@ -127,7 +127,7 @@ Following is a list of supported recipes: | |||
127 | - ``core-image-weston``: A very basic Wayland image with a terminal. | 127 | - ``core-image-weston``: A very basic Wayland image with a terminal. |
128 | This image provides the Wayland protocol libraries and the reference | 128 | This image provides the Wayland protocol libraries and the reference |
129 | Weston compositor. For more information, see the | 129 | Weston compositor. For more information, see the |
130 | ":ref:`dev-manual/common-tasks:using wayland and weston`" | 130 | ":ref:`dev-manual/wayland:using wayland and weston`" |
131 | section in the Yocto Project Development Tasks Manual. | 131 | section in the Yocto Project Development Tasks Manual. |
132 | 132 | ||
133 | - ``core-image-x11``: A very basic X11 image with a terminal. | 133 | - ``core-image-x11``: A very basic X11 image with a terminal. |
diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index 11bc373b3c..297887805c 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst | |||
@@ -82,7 +82,7 @@ the ``part`` and ``partition`` commands: | |||
82 | source of the data that populates the partition. The most common | 82 | source of the data that populates the partition. The most common |
83 | value for this option is "rootfs", but you can use any value that | 83 | value for this option is "rootfs", but you can use any value that |
84 | maps to a valid source plugin. For information on the source plugins, | 84 | maps to a valid source plugin. For information on the source plugins, |
85 | see the ":ref:`dev-manual/common-tasks:using the wic plugin interface`" | 85 | see the ":ref:`dev-manual/wic:using the wic plugin interface`" |
86 | section in the Yocto Project Development Tasks Manual. | 86 | section in the Yocto Project Development Tasks Manual. |
87 | 87 | ||
88 | If you use ``--source rootfs``, Wic creates a partition as large as | 88 | If you use ``--source rootfs``, Wic creates a partition as large as |
diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst index c36fa557d8..19e8040638 100644 --- a/documentation/ref-manual/release-process.rst +++ b/documentation/ref-manual/release-process.rst | |||
@@ -107,7 +107,7 @@ Additionally, because the test strategies are visible to you as a | |||
107 | developer, you can validate your projects. This section overviews the | 107 | developer, you can validate your projects. This section overviews the |
108 | available test infrastructure used in the Yocto Project. For information | 108 | available test infrastructure used in the Yocto Project. For information |
109 | on how to run available tests on your projects, see the | 109 | on how to run available tests on your projects, see the |
110 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 110 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
111 | section in the Yocto Project Development Tasks Manual. | 111 | section in the Yocto Project Development Tasks Manual. |
112 | 112 | ||
113 | The QA/testing infrastructure is woven into the project to the point | 113 | The QA/testing infrastructure is woven into the project to the point |
@@ -134,7 +134,7 @@ consists of the following pieces: | |||
134 | operation and functions. However, the test can also use the IP | 134 | operation and functions. However, the test can also use the IP |
135 | address of a machine to test. | 135 | address of a machine to test. |
136 | 136 | ||
137 | - :ref:`ptest <dev-manual/common-tasks:testing packages with ptest>`: | 137 | - :ref:`ptest <dev-manual/packages:testing packages with ptest>`: |
138 | Runs tests against packages produced during the build for a given | 138 | Runs tests against packages produced during the build for a given |
139 | piece of software. The test allows the packages to be run within a | 139 | piece of software. The test allows the packages to be run within a |
140 | target image. | 140 | target image. |
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 292a9d6f61..c737cba912 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst | |||
@@ -23,7 +23,7 @@ The Yocto Project gladly accepts contributions. You can submit changes | |||
23 | to the project either by creating and sending pull requests, or by | 23 | to the project either by creating and sending pull requests, or by |
24 | submitting patches through email. For information on how to do both as | 24 | submitting patches through email. For information on how to do both as |
25 | well as information on how to identify the maintainer for each area of | 25 | well as information on how to identify the maintainer for each area of |
26 | code, see the ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" section in the | 26 | code, see the ":ref:`dev-manual/changes:submitting a change to the yocto project`" section in the |
27 | Yocto Project Development Tasks Manual. | 27 | Yocto Project Development Tasks Manual. |
28 | 28 | ||
29 | .. _resources-bugtracker: | 29 | .. _resources-bugtracker: |
@@ -46,7 +46,7 @@ your expectations). | |||
46 | For a general procedure and guidelines on how to use Bugzilla to submit a bug | 46 | For a general procedure and guidelines on how to use Bugzilla to submit a bug |
47 | against the Yocto Project, see the following: | 47 | against the Yocto Project, see the following: |
48 | 48 | ||
49 | - The ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`" | 49 | - The ":ref:`dev-manual/changes:submitting a defect against the yocto project`" |
50 | section in the Yocto Project Development Tasks Manual. | 50 | section in the Yocto Project Development Tasks Manual. |
51 | 51 | ||
52 | - The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` | 52 | - The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` |
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 5436d94e1d..f3a52a19f3 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
@@ -177,7 +177,7 @@ within the :term:`Source Directory`. If you design a | |||
177 | custom distribution, you can include your own version of this | 177 | custom distribution, you can include your own version of this |
178 | configuration file to mention the targets defined by your distribution. | 178 | configuration file to mention the targets defined by your distribution. |
179 | See the | 179 | See the |
180 | ":ref:`dev-manual/common-tasks:creating a custom template configuration directory`" | 180 | ":ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory`" |
181 | section in the Yocto Project Development Tasks Manual for more | 181 | section in the Yocto Project Development Tasks Manual for more |
182 | information. | 182 | information. |
183 | 183 | ||
@@ -194,7 +194,7 @@ your choice. For example, the following command creates a | |||
194 | The OpenEmbedded build system uses the template configuration files, which | 194 | The OpenEmbedded build system uses the template configuration files, which |
195 | are found by default in the ``meta-poky/conf/templates/default`` directory in the Source | 195 | are found by default in the ``meta-poky/conf/templates/default`` directory in the Source |
196 | Directory. See the | 196 | Directory. See the |
197 | ":ref:`dev-manual/common-tasks:creating a custom template configuration directory`" | 197 | ":ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory`" |
198 | section in the Yocto Project Development Tasks Manual for more | 198 | section in the Yocto Project Development Tasks Manual for more |
199 | information. | 199 | information. |
200 | 200 | ||
@@ -236,7 +236,7 @@ The OpenEmbedded build system creates this directory when you enable | |||
236 | build history via the :ref:`buildhistory <ref-classes-buildhistory>` class file. The directory | 236 | build history via the :ref:`buildhistory <ref-classes-buildhistory>` class file. The directory |
237 | organizes build information into image, packages, and SDK | 237 | organizes build information into image, packages, and SDK |
238 | subdirectories. For information on the build history feature, see the | 238 | subdirectories. For information on the build history feature, see the |
239 | ":ref:`dev-manual/common-tasks:maintaining build output quality`" | 239 | ":ref:`dev-manual/build-quality:maintaining build output quality`" |
240 | section in the Yocto Project Development Tasks Manual. | 240 | section in the Yocto Project Development Tasks Manual. |
241 | 241 | ||
242 | .. _structure-build-cache: | 242 | .. _structure-build-cache: |
@@ -303,7 +303,7 @@ file, it uses ``sed`` to substitute final | |||
303 | ---------------------------- | 303 | ---------------------------- |
304 | 304 | ||
305 | This configuration file defines | 305 | This configuration file defines |
306 | :ref:`layers <dev-manual/common-tasks:understanding and creating layers>`, | 306 | :ref:`layers <dev-manual/layers:understanding and creating layers>`, |
307 | which are directory trees, traversed (or walked) by BitBake. The | 307 | which are directory trees, traversed (or walked) by BitBake. The |
308 | ``bblayers.conf`` file uses the :term:`BBLAYERS` | 308 | ``bblayers.conf`` file uses the :term:`BBLAYERS` |
309 | variable to list the layers BitBake tries to find. | 309 | variable to list the layers BitBake tries to find. |
@@ -441,7 +441,7 @@ directory contains sub-directories for ``bash``, ``busybox``, and | |||
441 | ``glibc`` (among others) that in turn contain appropriate ``COPYING`` | 441 | ``glibc`` (among others) that in turn contain appropriate ``COPYING`` |
442 | license files with other licensing information. For information on | 442 | license files with other licensing information. For information on |
443 | licensing, see the | 443 | licensing, see the |
444 | ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" | 444 | ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" |
445 | section in the Yocto Project Development Tasks Manual. | 445 | section in the Yocto Project Development Tasks Manual. |
446 | 446 | ||
447 | .. _structure-build-tmp-deploy-images: | 447 | .. _structure-build-tmp-deploy-images: |
@@ -578,7 +578,7 @@ built within the Yocto Project. For this package, a work directory of | |||
578 | ``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred | 578 | ``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred |
579 | to as the :term:`WORKDIR`, is created. Within this directory, the source is | 579 | to as the :term:`WORKDIR`, is created. Within this directory, the source is |
580 | unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. | 580 | unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. |
581 | (See the ":ref:`dev-manual/common-tasks:using quilt in your workflow`" section in | 581 | (See the ":ref:`dev-manual/quilt:using quilt in your workflow`" section in |
582 | the Yocto Project Development Tasks Manual for more information.) Within | 582 | the Yocto Project Development Tasks Manual for more information.) Within |
583 | the ``linux-qemux86-standard-build`` directory, standard Quilt | 583 | the ``linux-qemux86-standard-build`` directory, standard Quilt |
584 | directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and | 584 | directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and |
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst index 1502633816..8dab359b69 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst | |||
@@ -86,7 +86,7 @@ distributions: | |||
86 | interested in hearing about your experience. For information on | 86 | interested in hearing about your experience. For information on |
87 | how to submit a bug, see the Yocto Project | 87 | how to submit a bug, see the Yocto Project |
88 | :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` | 88 | :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` |
89 | and the ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`" | 89 | and the ":ref:`dev-manual/changes:submitting a defect against the yocto project`" |
90 | section in the Yocto Project Development Tasks Manual. | 90 | section in the Yocto Project Development Tasks Manual. |
91 | 91 | ||
92 | 92 | ||
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index b17c09cdc4..e626095b20 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst | |||
@@ -343,7 +343,7 @@ while ``file2.patch`` would not be applied. | |||
343 | You can find out more about the patching process in the | 343 | You can find out more about the patching process in the |
344 | ":ref:`overview-manual/concepts:patching`" section in | 344 | ":ref:`overview-manual/concepts:patching`" section in |
345 | the Yocto Project Overview and Concepts Manual and the | 345 | the Yocto Project Overview and Concepts Manual and the |
346 | ":ref:`dev-manual/common-tasks:patching code`" section in the | 346 | ":ref:`dev-manual/new-recipe:patching code`" section in the |
347 | Yocto Project Development Tasks Manual. | 347 | Yocto Project Development Tasks Manual. |
348 | 348 | ||
349 | .. _ref-tasks-populate_lic: | 349 | .. _ref-tasks-populate_lic: |
@@ -522,7 +522,7 @@ scratch is guaranteed. | |||
522 | Starts a shell in which an interactive Python interpreter allows you to | 522 | Starts a shell in which an interactive Python interpreter allows you to |
523 | interact with the BitBake build environment. From within this shell, you | 523 | interact with the BitBake build environment. From within this shell, you |
524 | can directly examine and set bits from the data store and execute | 524 | can directly examine and set bits from the data store and execute |
525 | functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a Python development shell`" section in | 525 | functions as if within the BitBake environment. See the ":ref:`dev-manual/python-development-shell:using a Python development shell`" section in |
526 | the Yocto Project Development Tasks Manual for more information about | 526 | the Yocto Project Development Tasks Manual for more information about |
527 | using ``pydevshell``. | 527 | using ``pydevshell``. |
528 | 528 | ||
@@ -532,7 +532,7 @@ using ``pydevshell``. | |||
532 | --------------- | 532 | --------------- |
533 | 533 | ||
534 | Starts a shell whose environment is set up for development, debugging, | 534 | Starts a shell whose environment is set up for development, debugging, |
535 | or both. See the ":ref:`dev-manual/common-tasks:using a development shell`" section in the | 535 | or both. See the ":ref:`dev-manual/development-shell:using a development shell`" section in the |
536 | Yocto Project Development Tasks Manual for more information about using | 536 | Yocto Project Development Tasks Manual for more information about using |
537 | ``devshell``. | 537 | ``devshell``. |
538 | 538 | ||
@@ -595,7 +595,7 @@ information on how the root filesystem is created. | |||
595 | 595 | ||
596 | Boots an image and performs runtime tests within the image. For | 596 | Boots an image and performs runtime tests within the image. For |
597 | information on automatically testing images, see the | 597 | information on automatically testing images, see the |
598 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 598 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
599 | section in the Yocto Project Development Tasks Manual. | 599 | section in the Yocto Project Development Tasks Manual. |
600 | 600 | ||
601 | .. _ref-tasks-testimage_auto: | 601 | .. _ref-tasks-testimage_auto: |
@@ -608,7 +608,7 @@ after it has been built. This task is enabled when you set | |||
608 | :term:`TESTIMAGE_AUTO` equal to "1". | 608 | :term:`TESTIMAGE_AUTO` equal to "1". |
609 | 609 | ||
610 | For information on automatically testing images, see the | 610 | For information on automatically testing images, see the |
611 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 611 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
612 | section in the Yocto Project Development Tasks Manual. | 612 | section in the Yocto Project Development Tasks Manual. |
613 | 613 | ||
614 | Kernel-Related Tasks | 614 | Kernel-Related Tasks |
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index 51f6e79200..4081dbebd7 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst | |||
@@ -21,7 +21,7 @@ universal, the list includes them just in case: | |||
21 | 21 | ||
22 | Information in append files extends or overrides the information in the | 22 | Information in append files extends or overrides the information in the |
23 | similarly-named recipe file. For an example of an append file in use, see | 23 | similarly-named recipe file. For an example of an append file in use, see |
24 | the ":ref:`dev-manual/common-tasks:appending other layers metadata with your layer`" | 24 | the ":ref:`dev-manual/layers:appending other layers metadata with your layer`" |
25 | section in the Yocto Project Development Tasks Manual. | 25 | section in the Yocto Project Development Tasks Manual. |
26 | 26 | ||
27 | When you name an append file, you can use the "``%``" wildcard character | 27 | When you name an append file, you can use the "``%``" wildcard character |
@@ -203,7 +203,7 @@ universal, the list includes them just in case: | |||
203 | ":ref:`overview-manual/yp-intro:The Yocto Project Layer | 203 | ":ref:`overview-manual/yp-intro:The Yocto Project Layer |
204 | Model`" section in the Yocto Project Overview and Concepts Manual. For | 204 | Model`" section in the Yocto Project Overview and Concepts Manual. For |
205 | more detailed information on layers, see the | 205 | more detailed information on layers, see the |
206 | ":ref:`dev-manual/common-tasks:Understanding and Creating | 206 | ":ref:`dev-manual/layers:Understanding and Creating |
207 | Layers`" section in the Yocto Project Development Tasks Manual. For a | 207 | Layers`" section in the Yocto Project Development Tasks Manual. For a |
208 | discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:BSP | 208 | discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:BSP |
209 | Layers`" section in the Yocto Project Board Support Packages (BSP) | 209 | Layers`" section in the Yocto Project Board Support Packages (BSP) |
@@ -335,7 +335,7 @@ universal, the list includes them just in case: | |||
335 | 335 | ||
336 | The OpenEmbedded Build System can generate such documentation for your | 336 | The OpenEmbedded Build System can generate such documentation for your |
337 | project, in :term:`SPDX` format, based on all the metadata it used to | 337 | project, in :term:`SPDX` format, based on all the metadata it used to |
338 | build the software images. See the ":ref:`dev-manual/common-tasks:creating | 338 | build the software images. See the ":ref:`dev-manual/sbom:creating |
339 | a software bill of materials`" section of the Development Tasks manual. | 339 | a software bill of materials`" section of the Development Tasks manual. |
340 | 340 | ||
341 | :term:`Source Directory` | 341 | :term:`Source Directory` |
@@ -406,7 +406,7 @@ universal, the list includes them just in case: | |||
406 | provide an :term:`SBOM` associated to each a software image. | 406 | provide an :term:`SBOM` associated to each a software image. |
407 | 407 | ||
408 | For details, see Wikipedia's :wikipedia:`SPDX page <Software_Package_Data_Exchange>` | 408 | For details, see Wikipedia's :wikipedia:`SPDX page <Software_Package_Data_Exchange>` |
409 | and the ":ref:`dev-manual/common-tasks:creating a software bill of materials`" | 409 | and the ":ref:`dev-manual/sbom:creating a software bill of materials`" |
410 | section of the Development Tasks manual. | 410 | section of the Development Tasks manual. |
411 | 411 | ||
412 | :term:`Sysroot` | 412 | :term:`Sysroot` |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 8b54420d95..6bfacece07 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -221,7 +221,7 @@ system and gives an overview of their function and contents. | |||
221 | :term:`PV` in your recipe so that it does contain ``${SRCPV}``. | 221 | :term:`PV` in your recipe so that it does contain ``${SRCPV}``. |
222 | 222 | ||
223 | For more information see the | 223 | For more information see the |
224 | ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" | 224 | ":ref:`dev-manual/packages:automatically incrementing a package version number`" |
225 | section in the Yocto Project Development Tasks Manual. | 225 | section in the Yocto Project Development Tasks Manual. |
226 | 226 | ||
227 | :term:`AUTO_SYSLINUXMENU` | 227 | :term:`AUTO_SYSLINUXMENU` |
@@ -237,7 +237,7 @@ system and gives an overview of their function and contents. | |||
237 | The list simply presents the tunes that are available. Not all tunes | 237 | The list simply presents the tunes that are available. Not all tunes |
238 | may be compatible with a particular machine configuration, or with | 238 | may be compatible with a particular machine configuration, or with |
239 | each other in a | 239 | each other in a |
240 | :ref:`Multilib <dev-manual/common-tasks:combining multiple versions of library files into one image>` | 240 | :ref:`Multilib <dev-manual/libraries:combining multiple versions of library files into one image>` |
241 | configuration. | 241 | configuration. |
242 | 242 | ||
243 | To add a tune to the list, be sure to append it with spaces using the | 243 | To add a tune to the list, be sure to append it with spaces using the |
@@ -302,7 +302,7 @@ system and gives an overview of their function and contents. | |||
302 | :term:`BASE_LIB` | 302 | :term:`BASE_LIB` |
303 | The library directory name for the CPU or Application Binary | 303 | The library directory name for the CPU or Application Binary |
304 | Interface (ABI) tune. The :term:`BASE_LIB` applies only in the Multilib | 304 | Interface (ABI) tune. The :term:`BASE_LIB` applies only in the Multilib |
305 | context. See the ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" | 305 | context. See the ":ref:`dev-manual/libraries:combining multiple versions of library files into one image`" |
306 | section in the Yocto Project Development Tasks Manual for information | 306 | section in the Yocto Project Development Tasks Manual for information |
307 | on Multilib. | 307 | on Multilib. |
308 | 308 | ||
@@ -526,7 +526,7 @@ system and gives an overview of their function and contents. | |||
526 | is not set higher than "20". | 526 | is not set higher than "20". |
527 | 527 | ||
528 | For more information on speeding up builds, see the | 528 | For more information on speeding up builds, see the |
529 | ":ref:`dev-manual/common-tasks:speeding up a build`" | 529 | ":ref:`dev-manual/speeding-up-build:speeding up a build`" |
530 | section in the Yocto Project Development Tasks Manual. | 530 | section in the Yocto Project Development Tasks Manual. |
531 | 531 | ||
532 | On the other hand, if your goal is to limit the amount of system | 532 | On the other hand, if your goal is to limit the amount of system |
@@ -751,7 +751,7 @@ system and gives an overview of their function and contents. | |||
751 | 751 | ||
752 | For information on how to use :term:`BBMULTICONFIG` in an environment | 752 | For information on how to use :term:`BBMULTICONFIG` in an environment |
753 | that supports building targets with multiple configurations, see the | 753 | that supports building targets with multiple configurations, see the |
754 | ":ref:`dev-manual/common-tasks:building images for multiple targets using multiple configurations`" | 754 | ":ref:`dev-manual/building:building images for multiple targets using multiple configurations`" |
755 | section in the Yocto Project Development Tasks Manual. | 755 | section in the Yocto Project Development Tasks Manual. |
756 | 756 | ||
757 | :term:`BBSERVER` | 757 | :term:`BBSERVER` |
@@ -980,7 +980,7 @@ system and gives an overview of their function and contents. | |||
980 | When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` | 980 | When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` |
981 | class, this variable specifies the build history features to be | 981 | class, this variable specifies the build history features to be |
982 | enabled. For more information on how build history works, see the | 982 | enabled. For more information on how build history works, see the |
983 | ":ref:`dev-manual/common-tasks:maintaining build output quality`" | 983 | ":ref:`dev-manual/build-quality:maintaining build output quality`" |
984 | section in the Yocto Project Development Tasks Manual. | 984 | section in the Yocto Project Development Tasks Manual. |
985 | 985 | ||
986 | You can specify these features in the form of a space-separated list: | 986 | You can specify these features in the form of a space-separated list: |
@@ -1287,7 +1287,7 @@ system and gives an overview of their function and contents. | |||
1287 | will be the aggregate of all of them. | 1287 | will be the aggregate of all of them. |
1288 | 1288 | ||
1289 | For information on creating an :term:`Initramfs`, see the | 1289 | For information on creating an :term:`Initramfs`, see the |
1290 | ":ref:`dev-manual/common-tasks:building an initial ram filesystem (Initramfs) image`" section | 1290 | ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section |
1291 | in the Yocto Project Development Tasks Manual. | 1291 | in the Yocto Project Development Tasks Manual. |
1292 | 1292 | ||
1293 | :term:`CONFIG_SITE` | 1293 | :term:`CONFIG_SITE` |
@@ -1335,7 +1335,7 @@ system and gives an overview of their function and contents. | |||
1335 | newly installed packages to an image, which might be most suitable for | 1335 | newly installed packages to an image, which might be most suitable for |
1336 | read-only filesystems that cannot be upgraded. See the | 1336 | read-only filesystems that cannot be upgraded. See the |
1337 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. | 1337 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. |
1338 | You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" | 1338 | You can also reference the ":ref:`dev-manual/licenses:providing license text`" |
1339 | section in the Yocto Project Development Tasks Manual for | 1339 | section in the Yocto Project Development Tasks Manual for |
1340 | information on providing license text. | 1340 | information on providing license text. |
1341 | 1341 | ||
@@ -1351,7 +1351,7 @@ system and gives an overview of their function and contents. | |||
1351 | newly installed packages to an image, which might be most suitable for | 1351 | newly installed packages to an image, which might be most suitable for |
1352 | read-only filesystems that cannot be upgraded. See the | 1352 | read-only filesystems that cannot be upgraded. See the |
1353 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. | 1353 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. |
1354 | You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" | 1354 | You can also reference the ":ref:`dev-manual/licenses:providing license text`" |
1355 | section in the Yocto Project Development Tasks Manual for | 1355 | section in the Yocto Project Development Tasks Manual for |
1356 | information on providing license text. | 1356 | information on providing license text. |
1357 | 1357 | ||
@@ -2118,7 +2118,7 @@ system and gives an overview of their function and contents. | |||
2118 | When used with the :ref:`report-error <ref-classes-report-error>` | 2118 | When used with the :ref:`report-error <ref-classes-report-error>` |
2119 | class, specifies the path used for storing the debug files created by | 2119 | class, specifies the path used for storing the debug files created by |
2120 | the :ref:`error reporting | 2120 | the :ref:`error reporting |
2121 | tool <dev-manual/common-tasks:using the error reporting tool>`, which | 2121 | tool <dev-manual/error-reporting-tool:using the error reporting tool>`, which |
2122 | allows you to submit build errors you encounter to a central | 2122 | allows you to submit build errors you encounter to a central |
2123 | database. By default, the value of this variable is | 2123 | database. By default, the value of this variable is |
2124 | ``${``\ :term:`LOG_DIR`\ ``}/error-report``. | 2124 | ``${``\ :term:`LOG_DIR`\ ``}/error-report``. |
@@ -2276,7 +2276,7 @@ system and gives an overview of their function and contents. | |||
2276 | 2276 | ||
2277 | See the ":ref:`ref-classes-externalsrc`" section for details. You | 2277 | See the ":ref:`ref-classes-externalsrc`" section for details. You |
2278 | can also find information on how to use this variable in the | 2278 | can also find information on how to use this variable in the |
2279 | ":ref:`dev-manual/common-tasks:building software from an external source`" | 2279 | ":ref:`dev-manual/building:building software from an external source`" |
2280 | section in the Yocto Project Development Tasks Manual. | 2280 | section in the Yocto Project Development Tasks Manual. |
2281 | 2281 | ||
2282 | :term:`EXTERNALSRC_BUILD` | 2282 | :term:`EXTERNALSRC_BUILD` |
@@ -2289,7 +2289,7 @@ system and gives an overview of their function and contents. | |||
2289 | 2289 | ||
2290 | See the ":ref:`ref-classes-externalsrc`" section for details. You | 2290 | See the ":ref:`ref-classes-externalsrc`" section for details. You |
2291 | can also find information on how to use this variable in the | 2291 | can also find information on how to use this variable in the |
2292 | ":ref:`dev-manual/common-tasks:building software from an external source`" | 2292 | ":ref:`dev-manual/building:building software from an external source`" |
2293 | section in the Yocto Project Development Tasks Manual. | 2293 | section in the Yocto Project Development Tasks Manual. |
2294 | 2294 | ||
2295 | :term:`EXTRA_AUTORECONF` | 2295 | :term:`EXTRA_AUTORECONF` |
@@ -2326,7 +2326,7 @@ system and gives an overview of their function and contents. | |||
2326 | useful if you want to develop against the libraries in the image. | 2326 | useful if you want to develop against the libraries in the image. |
2327 | - "read-only-rootfs" --- creates an image whose root filesystem is | 2327 | - "read-only-rootfs" --- creates an image whose root filesystem is |
2328 | read-only. See the | 2328 | read-only. See the |
2329 | ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" | 2329 | ":ref:`dev-manual/read-only-rootfs:creating a read-only root filesystem`" |
2330 | section in the Yocto Project Development Tasks Manual for more | 2330 | section in the Yocto Project Development Tasks Manual for more |
2331 | information | 2331 | information |
2332 | - "tools-debug" --- adds debugging tools such as gdb and strace. | 2332 | - "tools-debug" --- adds debugging tools such as gdb and strace. |
@@ -2339,7 +2339,7 @@ system and gives an overview of their function and contents. | |||
2339 | Project, see the ":ref:`ref-features-image`" section. | 2339 | Project, see the ":ref:`ref-features-image`" section. |
2340 | 2340 | ||
2341 | For an example that shows how to customize your image by using this | 2341 | For an example that shows how to customize your image by using this |
2342 | variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" | 2342 | variable, see the ":ref:`dev-manual/customizing-images:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" |
2343 | section in the Yocto Project Development Tasks Manual. | 2343 | section in the Yocto Project Development Tasks Manual. |
2344 | 2344 | ||
2345 | :term:`EXTRA_IMAGECMD` | 2345 | :term:`EXTRA_IMAGECMD` |
@@ -2684,7 +2684,7 @@ system and gives an overview of their function and contents. | |||
2684 | You can find out more about the patching process in the | 2684 | You can find out more about the patching process in the |
2685 | ":ref:`overview-manual/concepts:patching`" section | 2685 | ":ref:`overview-manual/concepts:patching`" section |
2686 | in the Yocto Project Overview and Concepts Manual and the | 2686 | in the Yocto Project Overview and Concepts Manual and the |
2687 | ":ref:`dev-manual/common-tasks:patching code`" section in | 2687 | ":ref:`dev-manual/new-recipe:patching code`" section in |
2688 | the Yocto Project Development Tasks Manual. See the | 2688 | the Yocto Project Development Tasks Manual. See the |
2689 | :ref:`ref-tasks-patch` task as well. | 2689 | :ref:`ref-tasks-patch` task as well. |
2690 | 2690 | ||
@@ -2819,7 +2819,7 @@ system and gives an overview of their function and contents. | |||
2819 | Allows to specify an extra search path for ``.so`` files | 2819 | Allows to specify an extra search path for ``.so`` files |
2820 | in GLib related recipes using GObject introspection, | 2820 | in GLib related recipes using GObject introspection, |
2821 | and which do not compile without this setting. | 2821 | and which do not compile without this setting. |
2822 | See the ":ref:`dev-manual/common-tasks:enabling gobject introspection support`" | 2822 | See the ":ref:`dev-manual/gobject-introspection:enabling gobject introspection support`" |
2823 | section for details. | 2823 | section for details. |
2824 | 2824 | ||
2825 | :term:`GITDIR` | 2825 | :term:`GITDIR` |
@@ -3113,7 +3113,7 @@ system and gives an overview of their function and contents. | |||
3113 | the same files into a ``boot`` directory within the target partition. | 3113 | the same files into a ``boot`` directory within the target partition. |
3114 | 3114 | ||
3115 | You can find information on how to use the Wic tool in the | 3115 | You can find information on how to use the Wic tool in the |
3116 | ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" | 3116 | ":ref:`dev-manual/wic:creating partitioned images using wic`" |
3117 | section of the Yocto Project Development Tasks Manual. Reference | 3117 | section of the Yocto Project Development Tasks Manual. Reference |
3118 | material for Wic is located in the | 3118 | material for Wic is located in the |
3119 | ":doc:`/ref-manual/kickstart`" chapter. | 3119 | ":doc:`/ref-manual/kickstart`" chapter. |
@@ -3191,7 +3191,7 @@ system and gives an overview of their function and contents. | |||
3191 | the same files into a ``boot`` directory within the target partition. | 3191 | the same files into a ``boot`` directory within the target partition. |
3192 | 3192 | ||
3193 | You can find information on how to use the Wic tool in the | 3193 | You can find information on how to use the Wic tool in the |
3194 | ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" | 3194 | ":ref:`dev-manual/wic:creating partitioned images using wic`" |
3195 | section of the Yocto Project Development Tasks Manual. Reference | 3195 | section of the Yocto Project Development Tasks Manual. Reference |
3196 | material for Wic is located in the | 3196 | material for Wic is located in the |
3197 | ":doc:`/ref-manual/kickstart`" chapter. | 3197 | ":doc:`/ref-manual/kickstart`" chapter. |
@@ -3212,7 +3212,7 @@ system and gives an overview of their function and contents. | |||
3212 | the ":ref:`ref-features-image`" section. | 3212 | the ":ref:`ref-features-image`" section. |
3213 | 3213 | ||
3214 | For an example that shows how to customize your image by using this | 3214 | For an example that shows how to customize your image by using this |
3215 | variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" | 3215 | variable, see the ":ref:`dev-manual/customizing-images:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" |
3216 | section in the Yocto Project Development Tasks Manual. | 3216 | section in the Yocto Project Development Tasks Manual. |
3217 | 3217 | ||
3218 | :term:`IMAGE_FSTYPES` | 3218 | :term:`IMAGE_FSTYPES` |
@@ -3268,7 +3268,7 @@ system and gives an overview of their function and contents. | |||
3268 | allows the initial RAM filesystem (:term:`Initramfs`) recipe to use a | 3268 | allows the initial RAM filesystem (:term:`Initramfs`) recipe to use a |
3269 | fixed set of packages and not be affected by :term:`IMAGE_INSTALL`. | 3269 | fixed set of packages and not be affected by :term:`IMAGE_INSTALL`. |
3270 | For information on creating an :term:`Initramfs`, see the | 3270 | For information on creating an :term:`Initramfs`, see the |
3271 | ":ref:`dev-manual/common-tasks:building an initial ram filesystem (Initramfs) image`" | 3271 | ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" |
3272 | section in the Yocto Project Development Tasks Manual. | 3272 | section in the Yocto Project Development Tasks Manual. |
3273 | 3273 | ||
3274 | - Using :term:`IMAGE_INSTALL` with the | 3274 | - Using :term:`IMAGE_INSTALL` with the |
@@ -3759,7 +3759,7 @@ system and gives an overview of their function and contents. | |||
3759 | or be included in the kernel binary. | 3759 | or be included in the kernel binary. |
3760 | 3760 | ||
3761 | For information on creating and using an :term:`Initramfs`, see the | 3761 | For information on creating and using an :term:`Initramfs`, see the |
3762 | ":ref:`dev-manual/common-tasks:building an initial ram filesystem (Initramfs) image`" | 3762 | ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" |
3763 | section in the Yocto Project Development Tasks Manual. | 3763 | section in the Yocto Project Development Tasks Manual. |
3764 | 3764 | ||
3765 | :term:`INITRAMFS_DEPLOY_DIR_IMAGE` | 3765 | :term:`INITRAMFS_DEPLOY_DIR_IMAGE` |
@@ -3817,7 +3817,7 @@ system and gives an overview of their function and contents. | |||
3817 | :term:`INITRAMFS_IMAGE_BUNDLE` | 3817 | :term:`INITRAMFS_IMAGE_BUNDLE` |
3818 | variable, which allows the generated image to be bundled inside the | 3818 | variable, which allows the generated image to be bundled inside the |
3819 | kernel image. Additionally, for information on creating an :term:`Initramfs` | 3819 | kernel image. Additionally, for information on creating an :term:`Initramfs` |
3820 | image, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (Initramfs) image`" section | 3820 | image, see the ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section |
3821 | in the Yocto Project Development Tasks Manual. | 3821 | in the Yocto Project Development Tasks Manual. |
3822 | 3822 | ||
3823 | :term:`INITRAMFS_IMAGE_BUNDLE` | 3823 | :term:`INITRAMFS_IMAGE_BUNDLE` |
@@ -3869,7 +3869,7 @@ system and gives an overview of their function and contents. | |||
3869 | See the | 3869 | See the |
3870 | :yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/templates/default/local.conf.sample.extended>` | 3870 | :yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/templates/default/local.conf.sample.extended>` |
3871 | file for additional information. Also, for information on creating an | 3871 | file for additional information. Also, for information on creating an |
3872 | :term:`Initramfs`, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (Initramfs) image`" section | 3872 | :term:`Initramfs`, see the ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section |
3873 | in the Yocto Project Development Tasks Manual. | 3873 | in the Yocto Project Development Tasks Manual. |
3874 | 3874 | ||
3875 | :term:`INITRAMFS_LINK_NAME` | 3875 | :term:`INITRAMFS_LINK_NAME` |
@@ -3895,7 +3895,7 @@ system and gives an overview of their function and contents. | |||
3895 | a separate multiconfig, this is meant to be used in addition to :term:`INITRAMFS_DEPLOY_DIR_IMAGE`. | 3895 | a separate multiconfig, this is meant to be used in addition to :term:`INITRAMFS_DEPLOY_DIR_IMAGE`. |
3896 | 3896 | ||
3897 | For more information on how to bundle an :term:`Initramfs` image from a separate | 3897 | For more information on how to bundle an :term:`Initramfs` image from a separate |
3898 | multiconfig see the ":ref:`dev-manual/common-tasks:Bundling an Initramfs Image From a Separate Multiconfig`" | 3898 | multiconfig see the ":ref:`dev-manual/building:Bundling an Initramfs Image From a Separate Multiconfig`" |
3899 | section in the Yocto Project Development Tasks Manual. | 3899 | section in the Yocto Project Development Tasks Manual. |
3900 | 3900 | ||
3901 | :term:`INITRAMFS_NAME` | 3901 | :term:`INITRAMFS_NAME` |
@@ -4497,7 +4497,7 @@ system and gives an overview of their function and contents. | |||
4497 | The OpenEmbedded build system produces a warning if the variable | 4497 | The OpenEmbedded build system produces a warning if the variable |
4498 | is not set for any given layer. | 4498 | is not set for any given layer. |
4499 | 4499 | ||
4500 | See the ":ref:`dev-manual/common-tasks:creating your own layer`" | 4500 | See the ":ref:`dev-manual/layers:creating your own layer`" |
4501 | section in the Yocto Project Development Tasks Manual. | 4501 | section in the Yocto Project Development Tasks Manual. |
4502 | 4502 | ||
4503 | :term:`LAYERVERSION` | 4503 | :term:`LAYERVERSION` |
@@ -4546,7 +4546,7 @@ system and gives an overview of their function and contents. | |||
4546 | This variable must be defined for all recipes (unless | 4546 | This variable must be defined for all recipes (unless |
4547 | :term:`LICENSE` is set to "CLOSED"). | 4547 | :term:`LICENSE` is set to "CLOSED"). |
4548 | 4548 | ||
4549 | For more information, see the ":ref:`dev-manual/common-tasks:tracking license changes`" | 4549 | For more information, see the ":ref:`dev-manual/licenses:tracking license changes`" |
4550 | section in the Yocto Project Development Tasks Manual. | 4550 | section in the Yocto Project Development Tasks Manual. |
4551 | 4551 | ||
4552 | :term:`LICENSE` | 4552 | :term:`LICENSE` |
@@ -4610,7 +4610,7 @@ system and gives an overview of their function and contents. | |||
4610 | For related information on providing license text, see the | 4610 | For related information on providing license text, see the |
4611 | :term:`COPY_LIC_DIRS` variable, the | 4611 | :term:`COPY_LIC_DIRS` variable, the |
4612 | :term:`COPY_LIC_MANIFEST` variable, and the | 4612 | :term:`COPY_LIC_MANIFEST` variable, and the |
4613 | ":ref:`dev-manual/common-tasks:providing license text`" | 4613 | ":ref:`dev-manual/licenses:providing license text`" |
4614 | section in the Yocto Project Development Tasks Manual. | 4614 | section in the Yocto Project Development Tasks Manual. |
4615 | 4615 | ||
4616 | :term:`LICENSE_FLAGS` | 4616 | :term:`LICENSE_FLAGS` |
@@ -4623,14 +4623,14 @@ system and gives an overview of their function and contents. | |||
4623 | typically used to mark recipes that might require additional licenses | 4623 | typically used to mark recipes that might require additional licenses |
4624 | in order to be used in a commercial product. For more information, | 4624 | in order to be used in a commercial product. For more information, |
4625 | see the | 4625 | see the |
4626 | ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" | 4626 | ":ref:`dev-manual/licenses:enabling commercially licensed recipes`" |
4627 | section in the Yocto Project Development Tasks Manual. | 4627 | section in the Yocto Project Development Tasks Manual. |
4628 | 4628 | ||
4629 | :term:`LICENSE_FLAGS_ACCEPTED` | 4629 | :term:`LICENSE_FLAGS_ACCEPTED` |
4630 | Lists license flags that when specified in | 4630 | Lists license flags that when specified in |
4631 | :term:`LICENSE_FLAGS` within a recipe should not | 4631 | :term:`LICENSE_FLAGS` within a recipe should not |
4632 | prevent that recipe from being built. For more information, see the | 4632 | prevent that recipe from being built. For more information, see the |
4633 | ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" | 4633 | ":ref:`dev-manual/licenses:enabling commercially licensed recipes`" |
4634 | section in the Yocto Project Development Tasks Manual. | 4634 | section in the Yocto Project Development Tasks Manual. |
4635 | 4635 | ||
4636 | :term:`LICENSE_PATH` | 4636 | :term:`LICENSE_PATH` |
@@ -5193,7 +5193,7 @@ system and gives an overview of their function and contents. | |||
5193 | Controls how the OpenEmbedded build system spawns interactive | 5193 | Controls how the OpenEmbedded build system spawns interactive |
5194 | terminals on the host development system (e.g. using the BitBake | 5194 | terminals on the host development system (e.g. using the BitBake |
5195 | command with the ``-c devshell`` command-line option). For more | 5195 | command with the ``-c devshell`` command-line option). For more |
5196 | information, see the ":ref:`dev-manual/common-tasks:using a development shell`" section in | 5196 | information, see the ":ref:`dev-manual/development-shell:using a development shell`" section in |
5197 | the Yocto Project Development Tasks Manual. | 5197 | the Yocto Project Development Tasks Manual. |
5198 | 5198 | ||
5199 | You can use the following values for the :term:`OE_TERMINAL` variable: | 5199 | You can use the following values for the :term:`OE_TERMINAL` variable: |
@@ -5341,7 +5341,7 @@ system and gives an overview of their function and contents. | |||
5341 | 5341 | ||
5342 | An easy way to see what overrides apply is to search for :term:`OVERRIDES` | 5342 | An easy way to see what overrides apply is to search for :term:`OVERRIDES` |
5343 | in the output of the ``bitbake -e`` command. See the | 5343 | in the output of the ``bitbake -e`` command. See the |
5344 | ":ref:`dev-manual/common-tasks:viewing variable values`" section in the Yocto | 5344 | ":ref:`dev-manual/debugging:viewing variable values`" section in the Yocto |
5345 | Project Development Tasks Manual for more information. | 5345 | Project Development Tasks Manual for more information. |
5346 | 5346 | ||
5347 | :term:`P` | 5347 | :term:`P` |
@@ -5362,7 +5362,7 @@ system and gives an overview of their function and contents. | |||
5362 | specific by using the package name as a suffix. | 5362 | specific by using the package name as a suffix. |
5363 | 5363 | ||
5364 | You can find out more about applying this variable in the | 5364 | You can find out more about applying this variable in the |
5365 | ":ref:`dev-manual/common-tasks:adding custom metadata to packages`" | 5365 | ":ref:`dev-manual/packages:adding custom metadata to packages`" |
5366 | section in the Yocto Project Development Tasks Manual. | 5366 | section in the Yocto Project Development Tasks Manual. |
5367 | 5367 | ||
5368 | :term:`PACKAGE_ARCH` | 5368 | :term:`PACKAGE_ARCH` |
@@ -5470,7 +5470,7 @@ system and gives an overview of their function and contents. | |||
5470 | use of the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable. | 5470 | use of the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable. |
5471 | 5471 | ||
5472 | You can find out more about debugging using GDB by reading the | 5472 | You can find out more about debugging using GDB by reading the |
5473 | ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section | 5473 | ":ref:`dev-manual/debugging:debugging with the gnu project debugger (gdb) remotely`" section |
5474 | in the Yocto Project Development Tasks Manual. | 5474 | in the Yocto Project Development Tasks Manual. |
5475 | 5475 | ||
5476 | :term:`PACKAGE_EXCLUDE` | 5476 | :term:`PACKAGE_EXCLUDE` |
@@ -5629,7 +5629,7 @@ system and gives an overview of their function and contents. | |||
5629 | the :ref:`core-image-minimal-initramfs <ref-manual/images:images>` | 5629 | the :ref:`core-image-minimal-initramfs <ref-manual/images:images>` |
5630 | image. When working with an initial RAM filesystem (:term:`Initramfs`) image, | 5630 | image. When working with an initial RAM filesystem (:term:`Initramfs`) image, |
5631 | use the :term:`PACKAGE_INSTALL` variable. For information on creating an | 5631 | use the :term:`PACKAGE_INSTALL` variable. For information on creating an |
5632 | :term:`Initramfs`, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (Initramfs) image`" section | 5632 | :term:`Initramfs`, see the ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section |
5633 | in the Yocto Project Development Tasks Manual. | 5633 | in the Yocto Project Development Tasks Manual. |
5634 | 5634 | ||
5635 | :term:`PACKAGE_INSTALL_ATTEMPTONLY` | 5635 | :term:`PACKAGE_INSTALL_ATTEMPTONLY` |
@@ -5652,7 +5652,7 @@ system and gives an overview of their function and contents. | |||
5652 | :term:`PACKAGE_WRITE_DEPS`. | 5652 | :term:`PACKAGE_WRITE_DEPS`. |
5653 | 5653 | ||
5654 | For information on running post-installation scripts, see the | 5654 | For information on running post-installation scripts, see the |
5655 | ":ref:`dev-manual/common-tasks:post-installation scripts`" | 5655 | ":ref:`dev-manual/new-recipe:post-installation scripts`" |
5656 | section in the Yocto Project Development Tasks Manual. | 5656 | section in the Yocto Project Development Tasks Manual. |
5657 | 5657 | ||
5658 | :term:`PACKAGECONFIG` | 5658 | :term:`PACKAGECONFIG` |
@@ -5803,7 +5803,7 @@ system and gives an overview of their function and contents. | |||
5803 | 5803 | ||
5804 | For an example of how to use the :term:`PACKAGES_DYNAMIC` variable when | 5804 | For an example of how to use the :term:`PACKAGES_DYNAMIC` variable when |
5805 | you are splitting packages, see the | 5805 | you are splitting packages, see the |
5806 | ":ref:`dev-manual/common-tasks:handling optional module packaging`" | 5806 | ":ref:`dev-manual/packages:handling optional module packaging`" |
5807 | section in the Yocto Project Development Tasks Manual. | 5807 | section in the Yocto Project Development Tasks Manual. |
5808 | 5808 | ||
5809 | :term:`PACKAGESPLITFUNCS` | 5809 | :term:`PACKAGESPLITFUNCS` |
@@ -5841,7 +5841,7 @@ system and gives an overview of their function and contents. | |||
5841 | the :ref:`ref-tasks-compile` task that result in race conditions, you can clear | 5841 | the :ref:`ref-tasks-compile` task that result in race conditions, you can clear |
5842 | the :term:`PARALLEL_MAKE` variable within the recipe as a workaround. For | 5842 | the :term:`PARALLEL_MAKE` variable within the recipe as a workaround. For |
5843 | information on addressing race conditions, see the | 5843 | information on addressing race conditions, see the |
5844 | ":ref:`dev-manual/common-tasks:debugging parallel make races`" | 5844 | ":ref:`dev-manual/debugging:debugging parallel make races`" |
5845 | section in the Yocto Project Development Tasks Manual. | 5845 | section in the Yocto Project Development Tasks Manual. |
5846 | 5846 | ||
5847 | For single socket systems (i.e. one CPU), you should not have to | 5847 | For single socket systems (i.e. one CPU), you should not have to |
@@ -5851,7 +5851,7 @@ system and gives an overview of their function and contents. | |||
5851 | not set higher than "-j 20". | 5851 | not set higher than "-j 20". |
5852 | 5852 | ||
5853 | For more information on speeding up builds, see the | 5853 | For more information on speeding up builds, see the |
5854 | ":ref:`dev-manual/common-tasks:speeding up a build`" | 5854 | ":ref:`dev-manual/speeding-up-build:speeding up a build`" |
5855 | section in the Yocto Project Development Tasks Manual. | 5855 | section in the Yocto Project Development Tasks Manual. |
5856 | 5856 | ||
5857 | :term:`PARALLEL_MAKEINST` | 5857 | :term:`PARALLEL_MAKEINST` |
@@ -5872,7 +5872,7 @@ system and gives an overview of their function and contents. | |||
5872 | the :ref:`ref-tasks-install` task that result in race conditions, you can | 5872 | the :ref:`ref-tasks-install` task that result in race conditions, you can |
5873 | clear the :term:`PARALLEL_MAKEINST` variable within the recipe as a | 5873 | clear the :term:`PARALLEL_MAKEINST` variable within the recipe as a |
5874 | workaround. For information on addressing race conditions, see the | 5874 | workaround. For information on addressing race conditions, see the |
5875 | ":ref:`dev-manual/common-tasks:debugging parallel make races`" | 5875 | ":ref:`dev-manual/debugging:debugging parallel make races`" |
5876 | section in the Yocto Project Development Tasks Manual. | 5876 | section in the Yocto Project Development Tasks Manual. |
5877 | 5877 | ||
5878 | :term:`PATCHRESOLVE` | 5878 | :term:`PATCHRESOLVE` |
@@ -5968,7 +5968,7 @@ system and gives an overview of their function and contents. | |||
5968 | For examples of how this data is used, see the | 5968 | For examples of how this data is used, see the |
5969 | ":ref:`overview-manual/concepts:automatically added runtime dependencies`" | 5969 | ":ref:`overview-manual/concepts:automatically added runtime dependencies`" |
5970 | section in the Yocto Project Overview and Concepts Manual and the | 5970 | section in the Yocto Project Overview and Concepts Manual and the |
5971 | ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" | 5971 | ":ref:`dev-manual/debugging:viewing package information with \`\`oe-pkgdata-util\`\``" |
5972 | section in the Yocto Project Development Tasks Manual. For more | 5972 | section in the Yocto Project Development Tasks Manual. For more |
5973 | information on the shared, global-state directory, see | 5973 | information on the shared, global-state directory, see |
5974 | :term:`STAGING_DIR_HOST`. | 5974 | :term:`STAGING_DIR_HOST`. |
@@ -6084,7 +6084,7 @@ system and gives an overview of their function and contents. | |||
6084 | 6084 | ||
6085 | Because manually managing :term:`PR` can be cumbersome and error-prone, | 6085 | Because manually managing :term:`PR` can be cumbersome and error-prone, |
6086 | an automated solution exists. See the | 6086 | an automated solution exists. See the |
6087 | ":ref:`dev-manual/common-tasks:working with a pr service`" section | 6087 | ":ref:`dev-manual/packages:working with a pr service`" section |
6088 | in the Yocto Project Development Tasks Manual for more information. | 6088 | in the Yocto Project Development Tasks Manual for more information. |
6089 | 6089 | ||
6090 | :term:`PREFERRED_PROVIDER` | 6090 | :term:`PREFERRED_PROVIDER` |
@@ -6107,7 +6107,7 @@ system and gives an overview of their function and contents. | |||
6107 | PREFERRED_PROVIDER_virtual/libgl ?= "mesa" | 6107 | PREFERRED_PROVIDER_virtual/libgl ?= "mesa" |
6108 | 6108 | ||
6109 | For more | 6109 | For more |
6110 | information, see the ":ref:`dev-manual/common-tasks:using virtual providers`" | 6110 | information, see the ":ref:`dev-manual/new-recipe:using virtual providers`" |
6111 | section in the Yocto Project Development Tasks Manual. | 6111 | section in the Yocto Project Development Tasks Manual. |
6112 | 6112 | ||
6113 | .. note:: | 6113 | .. note:: |
@@ -6307,7 +6307,7 @@ system and gives an overview of their function and contents. | |||
6307 | 6307 | ||
6308 | You must | 6308 | You must |
6309 | set the variable if you want to automatically start a local :ref:`PR | 6309 | set the variable if you want to automatically start a local :ref:`PR |
6310 | service <dev-manual/common-tasks:working with a pr service>`. You can | 6310 | service <dev-manual/packages:working with a pr service>`. You can |
6311 | set :term:`PRSERV_HOST` to other values to use a remote PR service. | 6311 | set :term:`PRSERV_HOST` to other values to use a remote PR service. |
6312 | 6312 | ||
6313 | 6313 | ||
@@ -6321,7 +6321,7 @@ system and gives an overview of their function and contents. | |||
6321 | 6321 | ||
6322 | :term:`PTEST_ENABLED` | 6322 | :term:`PTEST_ENABLED` |
6323 | Specifies whether or not :ref:`Package | 6323 | Specifies whether or not :ref:`Package |
6324 | Test <dev-manual/common-tasks:testing packages with ptest>` (ptest) | 6324 | Test <dev-manual/packages:testing packages with ptest>` (ptest) |
6325 | functionality is enabled when building a recipe. You should not set | 6325 | functionality is enabled when building a recipe. You should not set |
6326 | this variable directly. Enabling and disabling building Package Tests | 6326 | this variable directly. Enabling and disabling building Package Tests |
6327 | at build time should be done by adding "ptest" to (or removing it | 6327 | at build time should be done by adding "ptest" to (or removing it |
@@ -7440,7 +7440,7 @@ system and gives an overview of their function and contents. | |||
7440 | various ``SPL_*`` variables used by the OpenEmbedded build system. | 7440 | various ``SPL_*`` variables used by the OpenEmbedded build system. |
7441 | 7441 | ||
7442 | See the BeagleBone machine configuration example in the | 7442 | See the BeagleBone machine configuration example in the |
7443 | ":ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" | 7443 | ":ref:`dev-manual/layers:adding a layer using the \`\`bitbake-layers\`\` script`" |
7444 | section in the Yocto Project Board Support Package Developer's Guide | 7444 | section in the Yocto Project Board Support Package Developer's Guide |
7445 | for additional information. | 7445 | for additional information. |
7446 | 7446 | ||
@@ -7532,7 +7532,7 @@ system and gives an overview of their function and contents. | |||
7532 | For information on limitations when inheriting the latest revision | 7532 | For information on limitations when inheriting the latest revision |
7533 | of software using :term:`SRCREV`, see the :term:`AUTOREV` variable | 7533 | of software using :term:`SRCREV`, see the :term:`AUTOREV` variable |
7534 | description and the | 7534 | description and the |
7535 | ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" | 7535 | ":ref:`dev-manual/packages:automatically incrementing a package version number`" |
7536 | section, which is in the Yocto Project Development Tasks Manual. | 7536 | section, which is in the Yocto Project Development Tasks Manual. |
7537 | 7537 | ||
7538 | :term:`SRCTREECOVEREDTASKS` | 7538 | :term:`SRCTREECOVEREDTASKS` |
@@ -8058,7 +8058,7 @@ system and gives an overview of their function and contents. | |||
8058 | 8058 | ||
8059 | :term:`SYSVINIT_ENABLED_GETTYS` | 8059 | :term:`SYSVINIT_ENABLED_GETTYS` |
8060 | When using | 8060 | When using |
8061 | :ref:`SysVinit <dev-manual/common-tasks:enabling system services>`, | 8061 | :ref:`SysVinit <dev-manual/new-recipe:enabling system services>`, |
8062 | specifies a space-separated list of the virtual terminals that should | 8062 | specifies a space-separated list of the virtual terminals that should |
8063 | run a `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ | 8063 | run a `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ |
8064 | (allowing login), assuming :term:`USE_VT` is not set to | 8064 | (allowing login), assuming :term:`USE_VT` is not set to |
@@ -8305,7 +8305,7 @@ system and gives an overview of their function and contents. | |||
8305 | BitBake targets shown when sourcing the ``oe-init-build-env`` script. | 8305 | BitBake targets shown when sourcing the ``oe-init-build-env`` script. |
8306 | 8306 | ||
8307 | For details, see the | 8307 | For details, see the |
8308 | :ref:`dev-manual/common-tasks:creating a custom template configuration directory` | 8308 | :ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory` |
8309 | section in the Yocto Project Development Tasks manual. | 8309 | section in the Yocto Project Development Tasks manual. |
8310 | 8310 | ||
8311 | .. note:: | 8311 | .. note:: |
@@ -8360,7 +8360,7 @@ system and gives an overview of their function and contents. | |||
8360 | file. | 8360 | file. |
8361 | 8361 | ||
8362 | For more information on testing images, see the | 8362 | For more information on testing images, see the |
8363 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 8363 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
8364 | section in the Yocto Project Development Tasks Manual. | 8364 | section in the Yocto Project Development Tasks Manual. |
8365 | 8365 | ||
8366 | :term:`TEST_SERIALCONTROL_CMD` | 8366 | :term:`TEST_SERIALCONTROL_CMD` |
@@ -8433,7 +8433,7 @@ system and gives an overview of their function and contents. | |||
8433 | TEST_SUITES = "test_A test_B" | 8433 | TEST_SUITES = "test_A test_B" |
8434 | 8434 | ||
8435 | For more information on testing images, see the | 8435 | For more information on testing images, see the |
8436 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 8436 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
8437 | section in the Yocto Project Development Tasks Manual. | 8437 | section in the Yocto Project Development Tasks Manual. |
8438 | 8438 | ||
8439 | :term:`TEST_TARGET` | 8439 | :term:`TEST_TARGET` |
@@ -8452,7 +8452,7 @@ system and gives an overview of their function and contents. | |||
8452 | You can provide the following arguments with :term:`TEST_TARGET`: | 8452 | You can provide the following arguments with :term:`TEST_TARGET`: |
8453 | 8453 | ||
8454 | - *"qemu":* Boots a QEMU image and runs the tests. See the | 8454 | - *"qemu":* Boots a QEMU image and runs the tests. See the |
8455 | ":ref:`dev-manual/common-tasks:enabling runtime tests on qemu`" section | 8455 | ":ref:`dev-manual/runtime-testing:enabling runtime tests on qemu`" section |
8456 | in the Yocto Project Development Tasks Manual for more | 8456 | in the Yocto Project Development Tasks Manual for more |
8457 | information. | 8457 | information. |
8458 | 8458 | ||
@@ -8468,7 +8468,7 @@ system and gives an overview of their function and contents. | |||
8468 | ``meta/lib/oeqa/controllers/simpleremote.py``. | 8468 | ``meta/lib/oeqa/controllers/simpleremote.py``. |
8469 | 8469 | ||
8470 | For information on running tests on hardware, see the | 8470 | For information on running tests on hardware, see the |
8471 | ":ref:`dev-manual/common-tasks:enabling runtime tests on hardware`" | 8471 | ":ref:`dev-manual/runtime-testing:enabling runtime tests on hardware`" |
8472 | section in the Yocto Project Development Tasks Manual. | 8472 | section in the Yocto Project Development Tasks Manual. |
8473 | 8473 | ||
8474 | :term:`TEST_TARGET_IP` | 8474 | :term:`TEST_TARGET_IP` |
@@ -8505,7 +8505,7 @@ system and gives an overview of their function and contents. | |||
8505 | 8505 | ||
8506 | For more information | 8506 | For more information |
8507 | on enabling, running, and writing these tests, see the | 8507 | on enabling, running, and writing these tests, see the |
8508 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 8508 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
8509 | section in the Yocto Project Development Tasks Manual and the | 8509 | section in the Yocto Project Development Tasks Manual and the |
8510 | ":ref:`ref-classes-testimage`" section. | 8510 | ":ref:`ref-classes-testimage`" section. |
8511 | 8511 | ||
@@ -8969,13 +8969,13 @@ system and gives an overview of their function and contents. | |||
8969 | specifically set. Typically, you would set :term:`USE_DEVFS` to "0" for a | 8969 | specifically set. Typically, you would set :term:`USE_DEVFS` to "0" for a |
8970 | statically populated ``/dev`` directory. | 8970 | statically populated ``/dev`` directory. |
8971 | 8971 | ||
8972 | See the ":ref:`dev-manual/common-tasks:selecting a device manager`" section in | 8972 | See the ":ref:`dev-manual/device-manager:selecting a device manager`" section in |
8973 | the Yocto Project Development Tasks Manual for information on how to | 8973 | the Yocto Project Development Tasks Manual for information on how to |
8974 | use this variable. | 8974 | use this variable. |
8975 | 8975 | ||
8976 | :term:`USE_VT` | 8976 | :term:`USE_VT` |
8977 | When using | 8977 | When using |
8978 | :ref:`SysVinit <dev-manual/common-tasks:enabling system services>`, | 8978 | :ref:`SysVinit <dev-manual/new-recipe:enabling system services>`, |
8979 | determines whether or not to run a | 8979 | determines whether or not to run a |
8980 | `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any | 8980 | `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any |
8981 | virtual terminals in order to enable logging in through those | 8981 | virtual terminals in order to enable logging in through those |
@@ -9156,7 +9156,7 @@ system and gives an overview of their function and contents. | |||
9156 | OpenEmbedded build system to create a partitioned image | 9156 | OpenEmbedded build system to create a partitioned image |
9157 | (``image.wic``). For information on how to create a partitioned | 9157 | (``image.wic``). For information on how to create a partitioned |
9158 | image, see the | 9158 | image, see the |
9159 | ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" | 9159 | ":ref:`dev-manual/wic:creating partitioned images using wic`" |
9160 | section in the Yocto Project Development Tasks Manual. For details on | 9160 | section in the Yocto Project Development Tasks Manual. For details on |
9161 | the kickstart file format, see the ":doc:`/ref-manual/kickstart`" Chapter. | 9161 | the kickstart file format, see the ":doc:`/ref-manual/kickstart`" Chapter. |
9162 | 9162 | ||