diff options
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/classes.rst | 53 | ||||
| -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 | 6 | ||||
| -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/structure.rst | 12 | ||||
| -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 | 131 |
11 files changed, 118 insertions, 122 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 04afd3acf7..d27deb8c08 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
| @@ -67,8 +67,8 @@ inherit the ``allarch`` class. | |||
| 67 | The ``archiver`` class supports releasing source code and other | 67 | The ``archiver`` class supports releasing source code and other |
| 68 | materials with the binaries. | 68 | materials with the binaries. |
| 69 | 69 | ||
| 70 | For more details on the source archiver, see the | 70 | For more details on the source :ref:`ref-classes-archiver`, see the |
| 71 | ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" | 71 | ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" |
| 72 | section in the Yocto Project Development Tasks Manual. You can also see | 72 | section in the Yocto Project Development Tasks Manual. You can also see |
| 73 | the :term:`ARCHIVER_MODE` variable for information | 73 | the :term:`ARCHIVER_MODE` variable for information |
| 74 | about the variable flags (varflags) that help control archive creation. | 74 | about the variable flags (varflags) that help control archive creation. |
| @@ -86,7 +86,7 @@ standardization. This class defines a set of tasks (e.g. ``configure``, | |||
| 86 | should usually be enough to define a few standard variables and then | 86 | should usually be enough to define a few standard variables and then |
| 87 | simply ``inherit autotools``. These classes can also work with software | 87 | simply ``inherit autotools``. These classes can also work with software |
| 88 | that emulates Autotools. For more information, see the | 88 | that emulates Autotools. For more information, see the |
| 89 | ":ref:`dev-manual/common-tasks:autotooled package`" section | 89 | ":ref:`dev-manual/new-recipe:building an autotooled package`" section |
| 90 | in the Yocto Project Development Tasks Manual. | 90 | in the Yocto Project Development Tasks Manual. |
| 91 | 91 | ||
| 92 | By default, the ``autotools*`` classes use out-of-tree builds (i.e. | 92 | By default, the ``autotools*`` classes use out-of-tree builds (i.e. |
| @@ -216,7 +216,7 @@ The ``buildhistory`` class records a history of build output metadata, | |||
| 216 | which can be used to detect possible regressions as well as used for | 216 | which can be used to detect possible regressions as well as used for |
| 217 | analysis of the build output. For more information on using Build | 217 | analysis of the build output. For more information on using Build |
| 218 | History, see the | 218 | History, see the |
| 219 | ":ref:`dev-manual/common-tasks:maintaining build output quality`" | 219 | ":ref:`dev-manual/build-quality:maintaining build output quality`" |
| 220 | section in the Yocto Project Development Tasks Manual. | 220 | section in the Yocto Project Development Tasks Manual. |
| 221 | 221 | ||
| 222 | .. _ref-classes-buildstats: | 222 | .. _ref-classes-buildstats: |
| @@ -384,7 +384,7 @@ by the :term:`SPDX_PRETTY`, :term:`SPDX_ARCHIVE_PACKAGED`, | |||
| 384 | :term:`SPDX_ARCHIVE_SOURCES` and :term:`SPDX_INCLUDE_SOURCES` variables. | 384 | :term:`SPDX_ARCHIVE_SOURCES` and :term:`SPDX_INCLUDE_SOURCES` variables. |
| 385 | 385 | ||
| 386 | See the description of these variables and the | 386 | See the description of these variables and the |
| 387 | ":ref:`dev-manual/common-tasks:creating a software bill of materials`" | 387 | ":ref:`dev-manual/sbom:creating a software bill of materials`" |
| 388 | section in the Yocto Project Development Manual for more details. | 388 | section in the Yocto Project Development Manual for more details. |
| 389 | 389 | ||
| 390 | .. _ref-classes-cross: | 390 | .. _ref-classes-cross: |
| @@ -478,7 +478,7 @@ These can only be detected by reviewing the details of the issues and iterating | |||
| 478 | and following what happens in other Linux distributions and in the greater open source community. | 478 | and following what happens in other Linux distributions and in the greater open source community. |
| 479 | 479 | ||
| 480 | You will find some more details in the | 480 | You will find some more details in the |
| 481 | ":ref:`dev-manual/common-tasks:checking for vulnerabilities`" | 481 | ":ref:`dev-manual/vulnerabilities:checking for vulnerabilities`" |
| 482 | section in the Development Tasks Manual. | 482 | section in the Development Tasks Manual. |
| 483 | 483 | ||
| 484 | .. _ref-classes-debian: | 484 | .. _ref-classes-debian: |
| @@ -517,10 +517,10 @@ staging the files from :term:`DEPLOYDIR` to :term:`DEPLOY_DIR_IMAGE`. | |||
| 517 | ``devshell.bbclass`` | 517 | ``devshell.bbclass`` |
| 518 | ==================== | 518 | ==================== |
| 519 | 519 | ||
| 520 | The ``devshell`` class adds the ``do_devshell`` task. Distribution | 520 | The :ref:`ref-classes-devshell` class adds the :ref:`ref-tasks-devshell` task. Distribution |
| 521 | policy dictates whether to include this class. See the ":ref:`dev-manual/common-tasks:using a development shell`" | 521 | policy dictates whether to include this class. See the ":ref:`dev-manual/development-shell:using a development shell`" |
| 522 | section in the Yocto Project Development Tasks Manual for more | 522 | section in the Yocto Project Development Tasks Manual for more |
| 523 | information about using ``devshell``. | 523 | information about using :ref:`ref-classes-devshell`. |
| 524 | 524 | ||
| 525 | .. _ref-classes-devupstream: | 525 | .. _ref-classes-devupstream: |
| 526 | 526 | ||
| @@ -591,9 +591,8 @@ See these variables for more information: | |||
| 591 | 591 | ||
| 592 | For more information on the ``externalsrc`` class, see the comments in | 592 | For more information on the ``externalsrc`` class, see the comments in |
| 593 | ``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`. | 593 | ``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`. |
| 594 | For information on how to use the | 594 | For information on how to use the :ref:`ref-classes-externalsrc` class, see the |
| 595 | ``externalsrc`` class, see the | 595 | ":ref:`dev-manual/building:building software from an external source`" |
| 596 | ":ref:`dev-manual/common-tasks:building software from an external source`" | ||
| 597 | section in the Yocto Project Development Tasks Manual. | 596 | section in the Yocto Project Development Tasks Manual. |
| 598 | 597 | ||
| 599 | .. _ref-classes-extrausers: | 598 | .. _ref-classes-extrausers: |
| @@ -942,7 +941,7 @@ then one or more image files are created. | |||
| 942 | install into the image. | 941 | install into the image. |
| 943 | 942 | ||
| 944 | For information on customizing images, see the | 943 | For information on customizing images, see the |
| 945 | ":ref:`dev-manual/common-tasks:customizing images`" section | 944 | ":ref:`dev-manual/customizing-images:customizing images`" section |
| 946 | in the Yocto Project Development Tasks Manual. For information on how | 945 | in the Yocto Project Development Tasks Manual. For information on how |
| 947 | images are created, see the | 946 | images are created, see the |
| 948 | ":ref:`overview-manual/concepts:images`" section in the | 947 | ":ref:`overview-manual/concepts:images`" section in the |
| @@ -1330,7 +1329,7 @@ packages such as ``kernel-vmlinux``. | |||
| 1330 | The ``kernel`` class contains logic that allows you to embed an initial | 1329 | The ``kernel`` class contains logic that allows you to embed an initial |
| 1331 | RAM filesystem (initramfs) image when you build the kernel image. For | 1330 | RAM filesystem (initramfs) image when you build the kernel image. For |
| 1332 | information on how to build an initramfs, see the | 1331 | information on how to build an initramfs, see the |
| 1333 | ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section in | 1332 | ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section in |
| 1334 | the Yocto Project Development Tasks Manual. | 1333 | the Yocto Project Development Tasks Manual. |
| 1335 | 1334 | ||
| 1336 | Various other classes are used by the ``kernel`` and ``module`` classes | 1335 | Various other classes are used by the ``kernel`` and ``module`` classes |
| @@ -1629,7 +1628,7 @@ different target optimizations or target architectures and installing | |||
| 1629 | them side-by-side in the same image. | 1628 | them side-by-side in the same image. |
| 1630 | 1629 | ||
| 1631 | For more information on using the Multilib feature, see the | 1630 | For more information on using the Multilib feature, see the |
| 1632 | ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" | 1631 | ":ref:`dev-manual/libraries:combining multiple versions of library files into one image`" |
| 1633 | section in the Yocto Project Development Tasks Manual. | 1632 | section in the Yocto Project Development Tasks Manual. |
| 1634 | 1633 | ||
| 1635 | .. _ref-classes-native: | 1634 | .. _ref-classes-native: |
| @@ -1737,7 +1736,7 @@ package manager (NPM) <https://en.wikipedia.org/wiki/Npm_(software)>`__. | |||
| 1737 | fetcher to have dependencies fetched and packaged automatically. | 1736 | fetcher to have dependencies fetched and packaged automatically. |
| 1738 | 1737 | ||
| 1739 | For information on how to create NPM packages, see the | 1738 | For information on how to create NPM packages, see the |
| 1740 | ":ref:`dev-manual/common-tasks:creating node package manager (npm) packages`" | 1739 | ":ref:`dev-manual/packages:creating node package manager (npm) packages`" |
| 1741 | section in the Yocto Project Development Tasks Manual. | 1740 | section in the Yocto Project Development Tasks Manual. |
| 1742 | 1741 | ||
| 1743 | .. _ref-classes-oelint: | 1742 | .. _ref-classes-oelint: |
| @@ -1915,7 +1914,7 @@ If you take the optional step to set up a repository (package feed) on | |||
| 1915 | the development host that can be used by DNF, you can install packages | 1914 | the development host that can be used by DNF, you can install packages |
| 1916 | from the feed while you are running the image on the target (i.e. | 1915 | from the feed while you are running the image on the target (i.e. |
| 1917 | runtime installation of packages). For more information, see the | 1916 | runtime installation of packages). For more information, see the |
| 1918 | ":ref:`dev-manual/common-tasks:using runtime package management`" | 1917 | ":ref:`dev-manual/packages:using runtime package management`" |
| 1919 | section in the Yocto Project Development Tasks Manual. | 1918 | section in the Yocto Project Development Tasks Manual. |
| 1920 | 1919 | ||
| 1921 | The package-specific class you choose can affect build-time performance | 1920 | The package-specific class you choose can affect build-time performance |
| @@ -2034,7 +2033,7 @@ so forth). It is highly recommended that all package group recipes | |||
| 2034 | inherit this class. | 2033 | inherit this class. |
| 2035 | 2034 | ||
| 2036 | For information on how to use this class, see the | 2035 | For information on how to use this class, see the |
| 2037 | ":ref:`dev-manual/common-tasks:customizing images using custom package groups`" | 2036 | ":ref:`dev-manual/customizing-images:customizing images using custom package groups`" |
| 2038 | section in the Yocto Project Development Tasks Manual. | 2037 | section in the Yocto Project Development Tasks Manual. |
| 2039 | 2038 | ||
| 2040 | Previously, this class was called the ``task`` class. | 2039 | Previously, this class was called the ``task`` class. |
| @@ -2250,8 +2249,8 @@ The ``primport`` class provides functionality for importing | |||
| 2250 | ``prserv.bbclass`` | 2249 | ``prserv.bbclass`` |
| 2251 | ================== | 2250 | ================== |
| 2252 | 2251 | ||
| 2253 | The ``prserv`` class provides functionality for using a :ref:`PR | 2252 | The :ref:`ref-classes-prserv` class provides functionality for using a :ref:`PR |
| 2254 | service <dev-manual/common-tasks:working with a pr service>` in order to | 2253 | service <dev-manual/packages:working with a pr service>` in order to |
| 2255 | automatically manage the incrementing of the :term:`PR` | 2254 | automatically manage the incrementing of the :term:`PR` |
| 2256 | variable for each recipe. | 2255 | variable for each recipe. |
| 2257 | 2256 | ||
| @@ -2271,7 +2270,7 @@ runtime tests for recipes that build software that provides these tests. | |||
| 2271 | This class is intended to be inherited by individual recipes. However, | 2270 | This class is intended to be inherited by individual recipes. However, |
| 2272 | the class' functionality is largely disabled unless "ptest" appears in | 2271 | the class' functionality is largely disabled unless "ptest" appears in |
| 2273 | :term:`DISTRO_FEATURES`. See the | 2272 | :term:`DISTRO_FEATURES`. See the |
| 2274 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" | 2273 | ":ref:`dev-manual/packages:testing packages with ptest`" |
| 2275 | section in the Yocto Project Development Tasks Manual for more information | 2274 | section in the Yocto Project Development Tasks Manual for more information |
| 2276 | on ptest. | 2275 | on ptest. |
| 2277 | 2276 | ||
| @@ -2284,7 +2283,7 @@ Enables package tests (ptests) specifically for GNOME packages, which | |||
| 2284 | have tests intended to be executed with ``gnome-desktop-testing``. | 2283 | have tests intended to be executed with ``gnome-desktop-testing``. |
| 2285 | 2284 | ||
| 2286 | For information on setting up and running ptests, see the | 2285 | For information on setting up and running ptests, see the |
| 2287 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" | 2286 | ":ref:`dev-manual/packages:testing packages with ptest`" |
| 2288 | section in the Yocto Project Development Tasks Manual. | 2287 | section in the Yocto Project Development Tasks Manual. |
| 2289 | 2288 | ||
| 2290 | .. _ref-classes-python3-dir: | 2289 | .. _ref-classes-python3-dir: |
| @@ -2371,8 +2370,8 @@ override the removal by setting ``REMOVE_LIBTOOL_LA`` to "0" as follows:: | |||
| 2371 | ``report-error.bbclass`` | 2370 | ``report-error.bbclass`` |
| 2372 | ======================== | 2371 | ======================== |
| 2373 | 2372 | ||
| 2374 | The ``report-error`` class supports enabling the :ref:`error reporting | 2373 | The :ref:`ref-classes-report-error` class supports enabling the :ref:`error reporting |
| 2375 | tool <dev-manual/common-tasks:using the error reporting tool>`", | 2374 | tool <dev-manual/error-reporting-tool:using the error reporting tool>`", |
| 2376 | which allows you to submit build error information to a central database. | 2375 | which allows you to submit build error information to a central database. |
| 2377 | 2376 | ||
| 2378 | The class collects debug information for recipe, recipe version, task, | 2377 | The class collects debug information for recipe, recipe version, task, |
| @@ -2776,8 +2775,8 @@ Services are set up to start on boot automatically | |||
| 2776 | unless you have set | 2775 | unless you have set |
| 2777 | :term:`SYSTEMD_AUTO_ENABLE` to "disable". | 2776 | :term:`SYSTEMD_AUTO_ENABLE` to "disable". |
| 2778 | 2777 | ||
| 2779 | For more information on ``systemd``, see the | 2778 | For more information on :ref:`ref-classes-systemd`, see the |
| 2780 | ":ref:`dev-manual/common-tasks:selecting an initialization manager`" | 2779 | ":ref:`dev-manual/init-manager:selecting an initialization manager`" |
| 2781 | section in the Yocto Project Development Tasks Manual. | 2780 | section in the Yocto Project Development Tasks Manual. |
| 2782 | 2781 | ||
| 2783 | .. _ref-classes-systemd-boot: | 2782 | .. _ref-classes-systemd-boot: |
| @@ -2853,7 +2852,7 @@ runs tests on an image after the image is constructed (i.e. | |||
| 2853 | :term:`TESTIMAGE_AUTO` must be set to "1"). | 2852 | :term:`TESTIMAGE_AUTO` must be set to "1"). |
| 2854 | 2853 | ||
| 2855 | For information on how to enable, run, and create new tests, see the | 2854 | For information on how to enable, run, and create new tests, see the |
| 2856 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 2855 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
| 2857 | section in the Yocto Project Development Tasks Manual. | 2856 | section in the Yocto Project Development Tasks Manual. |
| 2858 | 2857 | ||
| 2859 | .. _ref-classes-testsdk: | 2858 | .. _ref-classes-testsdk: |
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index a1a8bcdc98..ba0385c4c8 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst | |||
| @@ -411,7 +411,7 @@ Upgrading a Recipe | |||
| 411 | As software matures, upstream recipes are upgraded to newer versions. As | 411 | As software matures, upstream recipes are upgraded to newer versions. As |
| 412 | a developer, you need to keep your local recipes up-to-date with the | 412 | a developer, you need to keep your local recipes up-to-date with the |
| 413 | upstream version releases. There are several ways of upgrading recipes. | 413 | upstream version releases. There are several ways of upgrading recipes. |
| 414 | You can read about them in the ":ref:`dev-manual/common-tasks:upgrading recipes`" | 414 | You can read about them in the ":ref:`dev-manual/upgrading-recipes:upgrading recipes`" |
| 415 | section of the Yocto Project Development Tasks Manual. This section | 415 | section of the Yocto Project Development Tasks Manual. This section |
| 416 | overviews the ``devtool upgrade`` command. | 416 | overviews the ``devtool upgrade`` command. |
| 417 | 417 | ||
| @@ -439,7 +439,7 @@ You can read more on the ``devtool upgrade`` workflow in the | |||
| 439 | ":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" | 439 | ":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" |
| 440 | section in the Yocto Project Application Development and the Extensible | 440 | section in the Yocto Project Application Development and the Extensible |
| 441 | Software Development Kit (eSDK) manual. You can also see an example of | 441 | Software Development Kit (eSDK) manual. You can also see an example of |
| 442 | how to use ``devtool upgrade`` in the ":ref:`dev-manual/common-tasks:using \`\`devtool upgrade\`\``" | 442 | how to use ``devtool upgrade`` in the ":ref:`dev-manual/upgrading-recipes:using \`\`devtool upgrade\`\``" |
| 443 | section in the Yocto Project Development Tasks Manual. | 443 | section in the Yocto Project Development Tasks Manual. |
| 444 | 444 | ||
| 445 | .. _devtool-resetting-a-recipe: | 445 | .. _devtool-resetting-a-recipe: |
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index e06b5e6caa..b428dc2db6 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst | |||
| @@ -45,7 +45,7 @@ section for steps on how to update your build tools. | |||
| 45 | **A:** Support for an additional board is added by creating a Board | 45 | **A:** Support for an additional board is added by creating a Board |
| 46 | Support Package (BSP) layer for it. For more information on how to | 46 | Support Package (BSP) layer for it. For more information on how to |
| 47 | create a BSP layer, see the | 47 | create a BSP layer, see the |
| 48 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 48 | ":ref:`dev-manual/layers:understanding and creating layers`" |
| 49 | section in the Yocto Project Development Tasks Manual and the | 49 | section in the Yocto Project Development Tasks Manual and the |
| 50 | :doc:`/bsp-guide/index`. | 50 | :doc:`/bsp-guide/index`. |
| 51 | 51 | ||
| @@ -73,7 +73,7 @@ device. | |||
| 73 | 73 | ||
| 74 | **A:** To add a package, you need to create a BitBake recipe. For | 74 | **A:** To add a package, you need to create a BitBake recipe. For |
| 75 | information on how to create a BitBake recipe, see the | 75 | information on how to create a BitBake recipe, see the |
| 76 | ":ref:`dev-manual/common-tasks:writing a new recipe`" | 76 | ":ref:`dev-manual/new-recipe:writing a new recipe`" |
| 77 | section in the Yocto Project Development Tasks Manual. | 77 | section in the Yocto Project Development Tasks Manual. |
| 78 | 78 | ||
| 79 | **Q:** Do I have to reflash my entire board with a new Yocto Project | 79 | **Q:** Do I have to reflash my entire board with a new Yocto Project |
| @@ -201,7 +201,7 @@ You can find more information on licensing in the | |||
| 201 | ":ref:`overview-manual/development-environment:licensing`" | 201 | ":ref:`overview-manual/development-environment:licensing`" |
| 202 | section in the Yocto | 202 | section in the Yocto |
| 203 | Project Overview and Concepts Manual and also in the | 203 | Project Overview and Concepts Manual and also in the |
| 204 | ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" | 204 | ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" |
| 205 | section in the Yocto Project Development Tasks Manual. | 205 | section in the Yocto Project Development Tasks Manual. |
| 206 | 206 | ||
| 207 | **Q:** How do I disable the cursor on my touchscreen device? | 207 | **Q:** How do I disable the cursor on my touchscreen device? |
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst index 89aeb989c1..a7078c7f3a 100644 --- a/documentation/ref-manual/features.rst +++ b/documentation/ref-manual/features.rst | |||
| @@ -157,7 +157,7 @@ metadata: | |||
| 157 | 157 | ||
| 158 | - *ptest:* Enables building the package tests where supported by | 158 | - *ptest:* Enables building the package tests where supported by |
| 159 | individual recipes. For more information on package tests, see the | 159 | individual recipes. For more information on package tests, see the |
| 160 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" section | 160 | ":ref:`dev-manual/packages:testing packages with ptest`" section |
| 161 | in the Yocto Project Development Tasks Manual. | 161 | in the Yocto Project Development Tasks Manual. |
| 162 | 162 | ||
| 163 | - *smbfs:* Include SMB networks client support (for mounting | 163 | - *smbfs:* Include SMB networks client support (for mounting |
| @@ -241,7 +241,7 @@ Here are the image features available for all images: | |||
| 241 | 241 | ||
| 242 | - *read-only-rootfs:* Creates an image whose root filesystem is | 242 | - *read-only-rootfs:* Creates an image whose root filesystem is |
| 243 | read-only. See the | 243 | read-only. See the |
| 244 | ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" | 244 | ":ref:`dev-manual/read-only-rootfs:creating a read-only root filesystem`" |
| 245 | section in the Yocto Project Development Tasks Manual for more | 245 | section in the Yocto Project Development Tasks Manual for more |
| 246 | information. | 246 | information. |
| 247 | 247 | ||
| @@ -278,7 +278,7 @@ these valid features is as follows: | |||
| 278 | 278 | ||
| 279 | - *tools-debug:* Installs debugging tools such as ``strace`` and | 279 | - *tools-debug:* Installs debugging tools such as ``strace`` and |
| 280 | ``gdb``. For information on GDB, see the | 280 | ``gdb``. For information on GDB, see the |
| 281 | ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section | 281 | ":ref:`dev-manual/debugging:debugging with the gnu project debugger (gdb) remotely`" section |
| 282 | in the Yocto Project Development Tasks Manual. For information on | 282 | in the Yocto Project Development Tasks Manual. For information on |
| 283 | tracing and profiling, see the :doc:`/profile-manual/index`. | 283 | tracing and profiling, see the :doc:`/profile-manual/index`. |
| 284 | 284 | ||
diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst index 33e5b53d9f..da27512855 100644 --- a/documentation/ref-manual/images.rst +++ b/documentation/ref-manual/images.rst | |||
| @@ -119,7 +119,7 @@ Following is a list of supported recipes: | |||
| 119 | deployed to a separate partition so that you can boot into it and use | 119 | deployed to a separate partition so that you can boot into it and use |
| 120 | it to deploy a second image to be tested. You can find more | 120 | it to deploy a second image to be tested. You can find more |
| 121 | information about runtime testing in the | 121 | information about runtime testing in the |
| 122 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 122 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
| 123 | section in the Yocto Project Development Tasks Manual. | 123 | section in the Yocto Project Development Tasks Manual. |
| 124 | 124 | ||
| 125 | - ``core-image-testmaster-initramfs``: A RAM-based Initial Root | 125 | - ``core-image-testmaster-initramfs``: A RAM-based Initial Root |
| @@ -129,7 +129,7 @@ Following is a list of supported recipes: | |||
| 129 | - ``core-image-weston``: A very basic Wayland image with a terminal. | 129 | - ``core-image-weston``: A very basic Wayland image with a terminal. |
| 130 | This image provides the Wayland protocol libraries and the reference | 130 | This image provides the Wayland protocol libraries and the reference |
| 131 | Weston compositor. For more information, see the | 131 | Weston compositor. For more information, see the |
| 132 | ":ref:`dev-manual/common-tasks:using wayland and weston`" | 132 | ":ref:`dev-manual/wayland:using wayland and weston`" |
| 133 | section in the Yocto Project Development Tasks Manual. | 133 | section in the Yocto Project Development Tasks Manual. |
| 134 | 134 | ||
| 135 | - ``core-image-x11``: A very basic X11 image with a terminal. | 135 | - ``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 d82da0ee75..c7766a2dfd 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 d376d51bd2..bf803a3db1 100644 --- a/documentation/ref-manual/release-process.rst +++ b/documentation/ref-manual/release-process.rst | |||
| @@ -143,7 +143,7 @@ Additionally, because the test strategies are visible to you as a | |||
| 143 | developer, you can validate your projects. This section overviews the | 143 | developer, you can validate your projects. This section overviews the |
| 144 | available test infrastructure used in the Yocto Project. For information | 144 | available test infrastructure used in the Yocto Project. For information |
| 145 | on how to run available tests on your projects, see the | 145 | on how to run available tests on your projects, see the |
| 146 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 146 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
| 147 | section in the Yocto Project Development Tasks Manual. | 147 | section in the Yocto Project Development Tasks Manual. |
| 148 | 148 | ||
| 149 | The QA/testing infrastructure is woven into the project to the point | 149 | The QA/testing infrastructure is woven into the project to the point |
| @@ -170,7 +170,7 @@ consists of the following pieces: | |||
| 170 | operation and functions. However, the test can also use the IP | 170 | operation and functions. However, the test can also use the IP |
| 171 | address of a machine to test. | 171 | address of a machine to test. |
| 172 | 172 | ||
| 173 | - :ref:`ptest <dev-manual/common-tasks:testing packages with ptest>`: | 173 | - :ref:`ptest <dev-manual/packages:testing packages with ptest>`: |
| 174 | Runs tests against packages produced during the build for a given | 174 | Runs tests against packages produced during the build for a given |
| 175 | piece of software. The test allows the packages to be run within a | 175 | piece of software. The test allows the packages to be run within a |
| 176 | target image. | 176 | target image. |
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 262b041ea6..d21134fd7f 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
| @@ -175,7 +175,7 @@ within the :term:`Source Directory`. If you design a | |||
| 175 | custom distribution, you can include your own version of this | 175 | custom distribution, you can include your own version of this |
| 176 | configuration file to mention the targets defined by your distribution. | 176 | configuration file to mention the targets defined by your distribution. |
| 177 | See the | 177 | See the |
| 178 | ":ref:`dev-manual/common-tasks:creating a custom template configuration directory`" | 178 | ":ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory`" |
| 179 | section in the Yocto Project Development Tasks Manual for more | 179 | section in the Yocto Project Development Tasks Manual for more |
| 180 | information. | 180 | information. |
| 181 | 181 | ||
| @@ -191,7 +191,7 @@ Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`:: | |||
| 191 | The OpenEmbedded build system uses the template configuration files, which | 191 | The OpenEmbedded build system uses the template configuration files, which |
| 192 | are found by default in the ``meta-poky/conf/`` directory in the Source | 192 | are found by default in the ``meta-poky/conf/`` directory in the Source |
| 193 | Directory. See the | 193 | Directory. See the |
| 194 | ":ref:`dev-manual/common-tasks:creating a custom template configuration directory`" | 194 | ":ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory`" |
| 195 | section in the Yocto Project Development Tasks Manual for more | 195 | section in the Yocto Project Development Tasks Manual for more |
| 196 | information. | 196 | information. |
| 197 | 197 | ||
| @@ -234,7 +234,7 @@ The OpenEmbedded build system creates this directory when you enable | |||
| 234 | build history via the :ref:`buildhistory <ref-classes-buildhistory>` class file. The directory | 234 | build history via the :ref:`buildhistory <ref-classes-buildhistory>` class file. The directory |
| 235 | organizes build information into image, packages, and SDK | 235 | organizes build information into image, packages, and SDK |
| 236 | subdirectories. For information on the build history feature, see the | 236 | subdirectories. For information on the build history feature, see the |
| 237 | ":ref:`dev-manual/common-tasks:maintaining build output quality`" | 237 | ":ref:`dev-manual/build-quality:maintaining build output quality`" |
| 238 | section in the Yocto Project Development Tasks Manual. | 238 | section in the Yocto Project Development Tasks Manual. |
| 239 | 239 | ||
| 240 | .. _structure-build-conf-local.conf: | 240 | .. _structure-build-conf-local.conf: |
| @@ -289,7 +289,7 @@ file, it uses ``sed`` to substitute final | |||
| 289 | ---------------------------- | 289 | ---------------------------- |
| 290 | 290 | ||
| 291 | This configuration file defines | 291 | This configuration file defines |
| 292 | :ref:`layers <dev-manual/common-tasks:understanding and creating layers>`, | 292 | :ref:`layers <dev-manual/layers:understanding and creating layers>`, |
| 293 | which are directory trees, traversed (or walked) by BitBake. The | 293 | which are directory trees, traversed (or walked) by BitBake. The |
| 294 | ``bblayers.conf`` file uses the :term:`BBLAYERS` | 294 | ``bblayers.conf`` file uses the :term:`BBLAYERS` |
| 295 | variable to list the layers BitBake tries to find. | 295 | variable to list the layers BitBake tries to find. |
| @@ -434,7 +434,7 @@ directory contains sub-directories for ``bash``, ``busybox``, and | |||
| 434 | ``glibc`` (among others) that in turn contain appropriate ``COPYING`` | 434 | ``glibc`` (among others) that in turn contain appropriate ``COPYING`` |
| 435 | license files with other licensing information. For information on | 435 | license files with other licensing information. For information on |
| 436 | licensing, see the | 436 | licensing, see the |
| 437 | ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" | 437 | ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" |
| 438 | section in the Yocto Project Development Tasks Manual. | 438 | section in the Yocto Project Development Tasks Manual. |
| 439 | 439 | ||
| 440 | .. _structure-build-tmp-deploy-images: | 440 | .. _structure-build-tmp-deploy-images: |
| @@ -571,7 +571,7 @@ built within the Yocto Project. For this package, a work directory of | |||
| 571 | ``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred | 571 | ``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred |
| 572 | to as the :term:`WORKDIR`, is created. Within this directory, the source is | 572 | to as the :term:`WORKDIR`, is created. Within this directory, the source is |
| 573 | unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. | 573 | unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. |
| 574 | (See the ":ref:`dev-manual/common-tasks:using quilt in your workflow`" section in | 574 | (See the ":ref:`dev-manual/quilt:using quilt in your workflow`" section in |
| 575 | the Yocto Project Development Tasks Manual for more information.) Within | 575 | the Yocto Project Development Tasks Manual for more information.) Within |
| 576 | the ``linux-qemux86-standard-build`` directory, standard Quilt | 576 | the ``linux-qemux86-standard-build`` directory, standard Quilt |
| 577 | directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and | 577 | directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and |
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index a2b8763e7c..e61f6659eb 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 | ||
| @@ -597,7 +597,7 @@ information on how the root filesystem is created. | |||
| 597 | 597 | ||
| 598 | Boots an image and performs runtime tests within the image. For | 598 | Boots an image and performs runtime tests within the image. For |
| 599 | information on automatically testing images, see the | 599 | information on automatically testing images, see the |
| 600 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 600 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
| 601 | section in the Yocto Project Development Tasks Manual. | 601 | section in the Yocto Project Development Tasks Manual. |
| 602 | 602 | ||
| 603 | .. _ref-tasks-testimage_auto: | 603 | .. _ref-tasks-testimage_auto: |
| @@ -610,7 +610,7 @@ after it has been built. This task is enabled when you set | |||
| 610 | :term:`TESTIMAGE_AUTO` equal to "1". | 610 | :term:`TESTIMAGE_AUTO` equal to "1". |
| 611 | 611 | ||
| 612 | For information on automatically testing images, see the | 612 | For information on automatically testing images, see the |
| 613 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 613 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
| 614 | section in the Yocto Project Development Tasks Manual. | 614 | section in the Yocto Project Development Tasks Manual. |
| 615 | 615 | ||
| 616 | Kernel-Related Tasks | 616 | Kernel-Related Tasks |
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index a7ae8e1801..2a5baa4cbf 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 |
| @@ -247,7 +247,7 @@ universal, the list includes them just in case: | |||
| 247 | ":ref:`overview-manual/yp-intro:The Yocto Project Layer | 247 | ":ref:`overview-manual/yp-intro:The Yocto Project Layer |
| 248 | Model`" section in the Yocto Project Overview and Concepts Manual. For | 248 | Model`" section in the Yocto Project Overview and Concepts Manual. For |
| 249 | more detailed information on layers, see the | 249 | more detailed information on layers, see the |
| 250 | ":ref:`dev-manual/common-tasks:Understanding and Creating | 250 | ":ref:`dev-manual/layers:Understanding and Creating |
| 251 | Layers`" section in the Yocto Project Development Tasks Manual. For a | 251 | Layers`" section in the Yocto Project Development Tasks Manual. For a |
| 252 | discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:BSP | 252 | discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:BSP |
| 253 | Layers`" section in the Yocto Project Board Support Packages (BSP) | 253 | Layers`" section in the Yocto Project Board Support Packages (BSP) |
| @@ -391,7 +391,7 @@ universal, the list includes them just in case: | |||
| 391 | 391 | ||
| 392 | The OpenEmbedded Build System can generate such documentation for your | 392 | The OpenEmbedded Build System can generate such documentation for your |
| 393 | project, in :term:`SPDX` format, based on all the metadata it used to | 393 | project, in :term:`SPDX` format, based on all the metadata it used to |
| 394 | build the software images. See the ":ref:`dev-manual/common-tasks:creating | 394 | build the software images. See the ":ref:`dev-manual/sbom:creating |
| 395 | a software bill of materials`" section of the Development Tasks manual. | 395 | a software bill of materials`" section of the Development Tasks manual. |
| 396 | 396 | ||
| 397 | :term:`Source Directory` | 397 | :term:`Source Directory` |
| @@ -462,7 +462,7 @@ universal, the list includes them just in case: | |||
| 462 | provide an :term:`SBOM` associated to each software image. | 462 | provide an :term:`SBOM` associated to each software image. |
| 463 | 463 | ||
| 464 | For details, see Wikipedia's :wikipedia:`SPDX page <Software_Package_Data_Exchange>` | 464 | For details, see Wikipedia's :wikipedia:`SPDX page <Software_Package_Data_Exchange>` |
| 465 | and the ":ref:`dev-manual/common-tasks:creating a software bill of materials`" | 465 | and the ":ref:`dev-manual/sbom:creating a software bill of materials`" |
| 466 | section of the Development Tasks manual. | 466 | section of the Development Tasks manual. |
| 467 | 467 | ||
| 468 | :term:`Task` | 468 | :term:`Task` |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 78cad25ca3..a043d20494 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -223,7 +223,7 @@ system and gives an overview of their function and contents. | |||
| 223 | so that it does contain ``${SRCPV}``. | 223 | so that it does contain ``${SRCPV}``. |
| 224 | 224 | ||
| 225 | For more information see the | 225 | For more information see the |
| 226 | ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" | 226 | ":ref:`dev-manual/packages:automatically incrementing a package version number`" |
| 227 | section in the Yocto Project Development Tasks Manual. | 227 | section in the Yocto Project Development Tasks Manual. |
| 228 | 228 | ||
| 229 | :term:`AUTO_SYSLINUXMENU` | 229 | :term:`AUTO_SYSLINUXMENU` |
| @@ -239,7 +239,7 @@ system and gives an overview of their function and contents. | |||
| 239 | The list simply presents the tunes that are available. Not all tunes | 239 | The list simply presents the tunes that are available. Not all tunes |
| 240 | may be compatible with a particular machine configuration, or with | 240 | may be compatible with a particular machine configuration, or with |
| 241 | each other in a | 241 | each other in a |
| 242 | :ref:`Multilib <dev-manual/common-tasks:combining multiple versions of library files into one image>` | 242 | :ref:`Multilib <dev-manual/libraries:combining multiple versions of library files into one image>` |
| 243 | configuration. | 243 | configuration. |
| 244 | 244 | ||
| 245 | To add a tune to the list, be sure to append it with spaces using the | 245 | To add a tune to the list, be sure to append it with spaces using the |
| @@ -304,7 +304,7 @@ system and gives an overview of their function and contents. | |||
| 304 | :term:`BASE_LIB` | 304 | :term:`BASE_LIB` |
| 305 | The library directory name for the CPU or Application Binary | 305 | The library directory name for the CPU or Application Binary |
| 306 | Interface (ABI) tune. The :term:`BASE_LIB` applies only in the Multilib | 306 | Interface (ABI) tune. The :term:`BASE_LIB` applies only in the Multilib |
| 307 | context. See the ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" | 307 | context. See the ":ref:`dev-manual/libraries:combining multiple versions of library files into one image`" |
| 308 | section in the Yocto Project Development Tasks Manual for information | 308 | section in the Yocto Project Development Tasks Manual for information |
| 309 | on Multilib. | 309 | on Multilib. |
| 310 | 310 | ||
| @@ -528,7 +528,7 @@ system and gives an overview of their function and contents. | |||
| 528 | is not set higher than "20". | 528 | is not set higher than "20". |
| 529 | 529 | ||
| 530 | For more information on speeding up builds, see the | 530 | For more information on speeding up builds, see the |
| 531 | ":ref:`dev-manual/common-tasks:speeding up a build`" | 531 | ":ref:`dev-manual/speeding-up-build:speeding up a build`" |
| 532 | section in the Yocto Project Development Tasks Manual. | 532 | section in the Yocto Project Development Tasks Manual. |
| 533 | 533 | ||
| 534 | :term:`BB_SERVER_TIMEOUT` | 534 | :term:`BB_SERVER_TIMEOUT` |
| @@ -725,7 +725,7 @@ system and gives an overview of their function and contents. | |||
| 725 | 725 | ||
| 726 | For information on how to use :term:`BBMULTICONFIG` in an environment | 726 | For information on how to use :term:`BBMULTICONFIG` in an environment |
| 727 | that supports building targets with multiple configurations, see the | 727 | that supports building targets with multiple configurations, see the |
| 728 | ":ref:`dev-manual/common-tasks:building images for multiple targets using multiple configurations`" | 728 | ":ref:`dev-manual/building:building images for multiple targets using multiple configurations`" |
| 729 | section in the Yocto Project Development Tasks Manual. | 729 | section in the Yocto Project Development Tasks Manual. |
| 730 | 730 | ||
| 731 | :term:`BBPATH` | 731 | :term:`BBPATH` |
| @@ -971,7 +971,7 @@ system and gives an overview of their function and contents. | |||
| 971 | When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` | 971 | When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` |
| 972 | class, this variable specifies the build history features to be | 972 | class, this variable specifies the build history features to be |
| 973 | enabled. For more information on how build history works, see the | 973 | enabled. For more information on how build history works, see the |
| 974 | ":ref:`dev-manual/common-tasks:maintaining build output quality`" | 974 | ":ref:`dev-manual/build-quality:maintaining build output quality`" |
| 975 | section in the Yocto Project Development Tasks Manual. | 975 | section in the Yocto Project Development Tasks Manual. |
| 976 | 976 | ||
| 977 | You can specify these features in the form of a space-separated list: | 977 | You can specify these features in the form of a space-separated list: |
| @@ -1294,8 +1294,8 @@ system and gives an overview of their function and contents. | |||
| 1294 | If you specify multiple directories and files, the initramfs image | 1294 | If you specify multiple directories and files, the initramfs image |
| 1295 | will be the aggregate of all of them. | 1295 | will be the aggregate of all of them. |
| 1296 | 1296 | ||
| 1297 | For information on creating an initramfs, see the | 1297 | For information on creating an :term:`Initramfs`, see the |
| 1298 | ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section | 1298 | ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section |
| 1299 | in the Yocto Project Development Tasks Manual. | 1299 | in the Yocto Project Development Tasks Manual. |
| 1300 | 1300 | ||
| 1301 | :term:`CONFIG_SITE` | 1301 | :term:`CONFIG_SITE` |
| @@ -1330,7 +1330,7 @@ system and gives an overview of their function and contents. | |||
| 1330 | newly installed packages to an image, which might be most suitable for | 1330 | newly installed packages to an image, which might be most suitable for |
| 1331 | read-only filesystems that cannot be upgraded. See the | 1331 | read-only filesystems that cannot be upgraded. See the |
| 1332 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. | 1332 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. |
| 1333 | You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" | 1333 | You can also reference the ":ref:`dev-manual/licenses:providing license text`" |
| 1334 | section in the Yocto Project Development Tasks Manual for | 1334 | section in the Yocto Project Development Tasks Manual for |
| 1335 | information on providing license text. | 1335 | information on providing license text. |
| 1336 | 1336 | ||
| @@ -1346,7 +1346,7 @@ system and gives an overview of their function and contents. | |||
| 1346 | newly installed packages to an image, which might be most suitable for | 1346 | newly installed packages to an image, which might be most suitable for |
| 1347 | read-only filesystems that cannot be upgraded. See the | 1347 | read-only filesystems that cannot be upgraded. See the |
| 1348 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. | 1348 | :term:`LICENSE_CREATE_PACKAGE` variable for additional information. |
| 1349 | You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" | 1349 | You can also reference the ":ref:`dev-manual/licenses:providing license text`" |
| 1350 | section in the Yocto Project Development Tasks Manual for | 1350 | section in the Yocto Project Development Tasks Manual for |
| 1351 | information on providing license text. | 1351 | information on providing license text. |
| 1352 | 1352 | ||
| @@ -2091,11 +2091,10 @@ system and gives an overview of their function and contents. | |||
| 2091 | less). | 2091 | less). |
| 2092 | 2092 | ||
| 2093 | :term:`ERR_REPORT_DIR` | 2093 | :term:`ERR_REPORT_DIR` |
| 2094 | When used with the :ref:`report-error <ref-classes-report-error>` | 2094 | When used with the :ref:`ref-classes-report-error` class, specifies the |
| 2095 | class, specifies the path used for storing the debug files created by | 2095 | path used for storing the debug files created by the :ref:`error reporting |
| 2096 | the :ref:`error reporting | 2096 | tool <dev-manual/error-reporting-tool:using the error reporting tool>`, |
| 2097 | tool <dev-manual/common-tasks:using the error reporting tool>`, which | 2097 | which allows you to submit build errors you encounter to a central |
| 2098 | allows you to submit build errors you encounter to a central | ||
| 2099 | database. By default, the value of this variable is | 2098 | database. By default, the value of this variable is |
| 2100 | ``${``\ :term:`LOG_DIR`\ ``}/error-report``. | 2099 | ``${``\ :term:`LOG_DIR`\ ``}/error-report``. |
| 2101 | 2100 | ||
| @@ -2258,7 +2257,7 @@ system and gives an overview of their function and contents. | |||
| 2258 | 2257 | ||
| 2259 | See the ":ref:`ref-classes-externalsrc`" section for details. You | 2258 | See the ":ref:`ref-classes-externalsrc`" section for details. You |
| 2260 | can also find information on how to use this variable in the | 2259 | can also find information on how to use this variable in the |
| 2261 | ":ref:`dev-manual/common-tasks:building software from an external source`" | 2260 | ":ref:`dev-manual/building:building software from an external source`" |
| 2262 | section in the Yocto Project Development Tasks Manual. | 2261 | section in the Yocto Project Development Tasks Manual. |
| 2263 | 2262 | ||
| 2264 | :term:`EXTERNALSRC_BUILD` | 2263 | :term:`EXTERNALSRC_BUILD` |
| @@ -2271,11 +2270,11 @@ system and gives an overview of their function and contents. | |||
| 2271 | 2270 | ||
| 2272 | See the ":ref:`ref-classes-externalsrc`" section for details. You | 2271 | See the ":ref:`ref-classes-externalsrc`" section for details. You |
| 2273 | can also find information on how to use this variable in the | 2272 | can also find information on how to use this variable in the |
| 2274 | ":ref:`dev-manual/common-tasks:building software from an external source`" | 2273 | ":ref:`dev-manual/building:building software from an external source`" |
| 2275 | section in the Yocto Project Development Tasks Manual. | 2274 | section in the Yocto Project Development Tasks Manual. |
| 2276 | 2275 | ||
| 2277 | :term:`EXTRA_AUTORECONF` | 2276 | :term:`EXTRA_AUTORECONF` |
| 2278 | For recipes inheriting the :ref:`autotools <ref-classes-autotools>` | 2277 | For recipes inheriting the :ref:`ref-classes-autotools` |
| 2279 | class, you can use :term:`EXTRA_AUTORECONF` to specify extra options to | 2278 | class, you can use :term:`EXTRA_AUTORECONF` to specify extra options to |
| 2280 | pass to the ``autoreconf`` command that is executed during the | 2279 | pass to the ``autoreconf`` command that is executed during the |
| 2281 | :ref:`ref-tasks-configure` task. | 2280 | :ref:`ref-tasks-configure` task. |
| @@ -2309,7 +2308,7 @@ system and gives an overview of their function and contents. | |||
| 2309 | useful if you want to develop against the libraries in the image. | 2308 | useful if you want to develop against the libraries in the image. |
| 2310 | - "read-only-rootfs" - Creates an image whose root filesystem is | 2309 | - "read-only-rootfs" - Creates an image whose root filesystem is |
| 2311 | read-only. See the | 2310 | read-only. See the |
| 2312 | ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" | 2311 | ":ref:`dev-manual/read-only-rootfs:creating a read-only root filesystem`" |
| 2313 | section in the Yocto Project Development Tasks Manual for more | 2312 | section in the Yocto Project Development Tasks Manual for more |
| 2314 | information | 2313 | information |
| 2315 | - "tools-debug" - Adds debugging tools such as gdb and strace. | 2314 | - "tools-debug" - Adds debugging tools such as gdb and strace. |
| @@ -2322,7 +2321,7 @@ system and gives an overview of their function and contents. | |||
| 2322 | Project, see the ":ref:`ref-features-image`" section. | 2321 | Project, see the ":ref:`ref-features-image`" section. |
| 2323 | 2322 | ||
| 2324 | For an example that shows how to customize your image by using this | 2323 | For an example that shows how to customize your image by using this |
| 2325 | variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" | 2324 | variable, see the ":ref:`dev-manual/customizing-images:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" |
| 2326 | section in the Yocto Project Development Tasks Manual. | 2325 | section in the Yocto Project Development Tasks Manual. |
| 2327 | 2326 | ||
| 2328 | :term:`EXTRA_IMAGECMD` | 2327 | :term:`EXTRA_IMAGECMD` |
| @@ -2681,7 +2680,7 @@ system and gives an overview of their function and contents. | |||
| 2681 | You can find out more about the patching process in the | 2680 | You can find out more about the patching process in the |
| 2682 | ":ref:`overview-manual/concepts:patching`" section | 2681 | ":ref:`overview-manual/concepts:patching`" section |
| 2683 | in the Yocto Project Overview and Concepts Manual and the | 2682 | in the Yocto Project Overview and Concepts Manual and the |
| 2684 | ":ref:`dev-manual/common-tasks:patching code`" section in | 2683 | ":ref:`dev-manual/new-recipe:patching code`" section in |
| 2685 | the Yocto Project Development Tasks Manual. See the | 2684 | the Yocto Project Development Tasks Manual. See the |
| 2686 | :ref:`ref-tasks-patch` task as well. | 2685 | :ref:`ref-tasks-patch` task as well. |
| 2687 | 2686 | ||
| @@ -2813,7 +2812,7 @@ system and gives an overview of their function and contents. | |||
| 2813 | Allows to specify an extra search path for ``.so`` files | 2812 | Allows to specify an extra search path for ``.so`` files |
| 2814 | in GLib related recipes using GObject introspection, | 2813 | in GLib related recipes using GObject introspection, |
| 2815 | and which do not compile without this setting. | 2814 | and which do not compile without this setting. |
| 2816 | See the ":ref:`dev-manual/common-tasks:enabling gobject introspection support`" | 2815 | See the ":ref:`dev-manual/gobject-introspection:enabling gobject introspection support`" |
| 2817 | section for details. | 2816 | section for details. |
| 2818 | 2817 | ||
| 2819 | :term:`GITDIR` | 2818 | :term:`GITDIR` |
| @@ -3098,7 +3097,7 @@ system and gives an overview of their function and contents. | |||
| 3098 | the same files into a ``boot`` directory within the target partition. | 3097 | the same files into a ``boot`` directory within the target partition. |
| 3099 | 3098 | ||
| 3100 | You can find information on how to use the Wic tool in the | 3099 | You can find information on how to use the Wic tool in the |
| 3101 | ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" | 3100 | ":ref:`dev-manual/wic:creating partitioned images using wic`" |
| 3102 | section of the Yocto Project Development Tasks Manual. Reference | 3101 | section of the Yocto Project Development Tasks Manual. Reference |
| 3103 | material for Wic is located in the | 3102 | material for Wic is located in the |
| 3104 | ":doc:`/ref-manual/kickstart`" chapter. | 3103 | ":doc:`/ref-manual/kickstart`" chapter. |
| @@ -3170,7 +3169,7 @@ system and gives an overview of their function and contents. | |||
| 3170 | the same files into a ``boot`` directory within the target partition. | 3169 | the same files into a ``boot`` directory within the target partition. |
| 3171 | 3170 | ||
| 3172 | You can find information on how to use the Wic tool in the | 3171 | You can find information on how to use the Wic tool in the |
| 3173 | ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" | 3172 | ":ref:`dev-manual/wic:creating partitioned images using wic`" |
| 3174 | section of the Yocto Project Development Tasks Manual. Reference | 3173 | section of the Yocto Project Development Tasks Manual. Reference |
| 3175 | material for Wic is located in the | 3174 | material for Wic is located in the |
| 3176 | ":doc:`/ref-manual/kickstart`" chapter. | 3175 | ":doc:`/ref-manual/kickstart`" chapter. |
| @@ -3191,7 +3190,7 @@ system and gives an overview of their function and contents. | |||
| 3191 | the ":ref:`ref-features-image`" section. | 3190 | the ":ref:`ref-features-image`" section. |
| 3192 | 3191 | ||
| 3193 | For an example that shows how to customize your image by using this | 3192 | For an example that shows how to customize your image by using this |
| 3194 | variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" | 3193 | variable, see the ":ref:`dev-manual/customizing-images:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" |
| 3195 | section in the Yocto Project Development Tasks Manual. | 3194 | section in the Yocto Project Development Tasks Manual. |
| 3196 | 3195 | ||
| 3197 | :term:`IMAGE_FSTYPES` | 3196 | :term:`IMAGE_FSTYPES` |
| @@ -3246,8 +3245,8 @@ system and gives an overview of their function and contents. | |||
| 3246 | :term:`PACKAGE_INSTALL` variable, which | 3245 | :term:`PACKAGE_INSTALL` variable, which |
| 3247 | allows the initial RAM filesystem (initramfs) recipe to use a | 3246 | allows the initial RAM filesystem (initramfs) recipe to use a |
| 3248 | fixed set of packages and not be affected by :term:`IMAGE_INSTALL`. | 3247 | fixed set of packages and not be affected by :term:`IMAGE_INSTALL`. |
| 3249 | For information on creating an initramfs, see the | 3248 | For information on creating an :term:`Initramfs`, see the |
| 3250 | ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" | 3249 | ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" |
| 3251 | section in the Yocto Project Development Tasks Manual. | 3250 | section in the Yocto Project Development Tasks Manual. |
| 3252 | 3251 | ||
| 3253 | - Using :term:`IMAGE_INSTALL` with the | 3252 | - Using :term:`IMAGE_INSTALL` with the |
| @@ -3749,8 +3748,8 @@ system and gives an overview of their function and contents. | |||
| 3749 | For more information, you can also see the | 3748 | For more information, you can also see the |
| 3750 | :term:`INITRAMFS_IMAGE_BUNDLE` | 3749 | :term:`INITRAMFS_IMAGE_BUNDLE` |
| 3751 | variable, which allows the generated image to be bundled inside the | 3750 | variable, which allows the generated image to be bundled inside the |
| 3752 | kernel image. Additionally, for information on creating an initramfs | 3751 | kernel image. Additionally, for information on creating an :term:`Initramfs` |
| 3753 | image, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section | 3752 | image, see the ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section |
| 3754 | in the Yocto Project Development Tasks Manual. | 3753 | in the Yocto Project Development Tasks Manual. |
| 3755 | 3754 | ||
| 3756 | :term:`INITRAMFS_IMAGE_BUNDLE` | 3755 | :term:`INITRAMFS_IMAGE_BUNDLE` |
| @@ -3802,7 +3801,7 @@ system and gives an overview of their function and contents. | |||
| 3802 | See the | 3801 | See the |
| 3803 | :yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/local.conf.sample.extended>` | 3802 | :yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/local.conf.sample.extended>` |
| 3804 | file for additional information. Also, for information on creating an | 3803 | file for additional information. Also, for information on creating an |
| 3805 | initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section | 3804 | :term:`Initramfs`, see the ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section |
| 3806 | in the Yocto Project Development Tasks Manual. | 3805 | in the Yocto Project Development Tasks Manual. |
| 3807 | 3806 | ||
| 3808 | :term:`INITRAMFS_LINK_NAME` | 3807 | :term:`INITRAMFS_LINK_NAME` |
| @@ -3827,8 +3826,8 @@ system and gives an overview of their function and contents. | |||
| 3827 | This allows the kernel to bundle an :term:`INITRAMFS_IMAGE` coming from | 3826 | This allows the kernel to bundle an :term:`INITRAMFS_IMAGE` coming from |
| 3828 | a separate multiconfig, this is meant to be used in addition to :term:`INITRAMFS_DEPLOY_DIR_IMAGE`. | 3827 | a separate multiconfig, this is meant to be used in addition to :term:`INITRAMFS_DEPLOY_DIR_IMAGE`. |
| 3829 | 3828 | ||
| 3830 | For more information on how to bundle an initramfs image from a separate | 3829 | For more information on how to bundle an :term:`Initramfs` image from a separate |
| 3831 | multiconfig see the ":ref:`dev-manual/common-tasks:Bundling an Initramfs Image From a Separate Multiconfig`" | 3830 | multiconfig see the ":ref:`dev-manual/building:Bundling an Initramfs Image From a Separate Multiconfig`" |
| 3832 | section in the Yocto Project Development Tasks Manual. | 3831 | section in the Yocto Project Development Tasks Manual. |
| 3833 | 3832 | ||
| 3834 | :term:`INITRAMFS_NAME` | 3833 | :term:`INITRAMFS_NAME` |
| @@ -4422,7 +4421,7 @@ system and gives an overview of their function and contents. | |||
| 4422 | The OpenEmbedded build system produces a warning if the variable | 4421 | The OpenEmbedded build system produces a warning if the variable |
| 4423 | is not set for any given layer. | 4422 | is not set for any given layer. |
| 4424 | 4423 | ||
| 4425 | See the ":ref:`dev-manual/common-tasks:creating your own layer`" | 4424 | See the ":ref:`dev-manual/layers:creating your own layer`" |
| 4426 | section in the Yocto Project Development Tasks Manual. | 4425 | section in the Yocto Project Development Tasks Manual. |
| 4427 | 4426 | ||
| 4428 | :term:`LAYERVERSION` | 4427 | :term:`LAYERVERSION` |
| @@ -4471,7 +4470,7 @@ system and gives an overview of their function and contents. | |||
| 4471 | This variable must be defined for all recipes (unless | 4470 | This variable must be defined for all recipes (unless |
| 4472 | :term:`LICENSE` is set to "CLOSED"). | 4471 | :term:`LICENSE` is set to "CLOSED"). |
| 4473 | 4472 | ||
| 4474 | For more information, see the ":ref:`dev-manual/common-tasks:tracking license changes`" | 4473 | For more information, see the ":ref:`dev-manual/licenses:tracking license changes`" |
| 4475 | section in the Yocto Project Development Tasks Manual. | 4474 | section in the Yocto Project Development Tasks Manual. |
| 4476 | 4475 | ||
| 4477 | :term:`LICENSE` | 4476 | :term:`LICENSE` |
| @@ -4535,7 +4534,7 @@ system and gives an overview of their function and contents. | |||
| 4535 | For related information on providing license text, see the | 4534 | For related information on providing license text, see the |
| 4536 | :term:`COPY_LIC_DIRS` variable, the | 4535 | :term:`COPY_LIC_DIRS` variable, the |
| 4537 | :term:`COPY_LIC_MANIFEST` variable, and the | 4536 | :term:`COPY_LIC_MANIFEST` variable, and the |
| 4538 | ":ref:`dev-manual/common-tasks:providing license text`" | 4537 | ":ref:`dev-manual/licenses:providing license text`" |
| 4539 | section in the Yocto Project Development Tasks Manual. | 4538 | section in the Yocto Project Development Tasks Manual. |
| 4540 | 4539 | ||
| 4541 | :term:`LICENSE_FLAGS` | 4540 | :term:`LICENSE_FLAGS` |
| @@ -4548,14 +4547,14 @@ system and gives an overview of their function and contents. | |||
| 4548 | typically used to mark recipes that might require additional licenses | 4547 | typically used to mark recipes that might require additional licenses |
| 4549 | in order to be used in a commercial product. For more information, | 4548 | in order to be used in a commercial product. For more information, |
| 4550 | see the | 4549 | see the |
| 4551 | ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" | 4550 | ":ref:`dev-manual/licenses:enabling commercially licensed recipes`" |
| 4552 | section in the Yocto Project Development Tasks Manual. | 4551 | section in the Yocto Project Development Tasks Manual. |
| 4553 | 4552 | ||
| 4554 | :term:`LICENSE_FLAGS_ACCEPTED` | 4553 | :term:`LICENSE_FLAGS_ACCEPTED` |
| 4555 | Lists license flags that when specified in | 4554 | Lists license flags that when specified in |
| 4556 | :term:`LICENSE_FLAGS` within a recipe should not | 4555 | :term:`LICENSE_FLAGS` within a recipe should not |
| 4557 | prevent that recipe from being built. For more information, see the | 4556 | prevent that recipe from being built. For more information, see the |
| 4558 | ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" | 4557 | ":ref:`dev-manual/licenses:enabling commercially licensed recipes`" |
| 4559 | section in the Yocto Project Development Tasks Manual. | 4558 | section in the Yocto Project Development Tasks Manual. |
| 4560 | 4559 | ||
| 4561 | :term:`LICENSE_PATH` | 4560 | :term:`LICENSE_PATH` |
| @@ -5115,7 +5114,7 @@ system and gives an overview of their function and contents. | |||
| 5115 | Controls how the OpenEmbedded build system spawns interactive | 5114 | Controls how the OpenEmbedded build system spawns interactive |
| 5116 | terminals on the host development system (e.g. using the BitBake | 5115 | terminals on the host development system (e.g. using the BitBake |
| 5117 | command with the ``-c devshell`` command-line option). For more | 5116 | command with the ``-c devshell`` command-line option). For more |
| 5118 | information, see the ":ref:`dev-manual/common-tasks:using a development shell`" section in | 5117 | information, see the ":ref:`dev-manual/development-shell:using a development shell`" section in |
| 5119 | the Yocto Project Development Tasks Manual. | 5118 | the Yocto Project Development Tasks Manual. |
| 5120 | 5119 | ||
| 5121 | You can use the following values for the :term:`OE_TERMINAL` variable: | 5120 | You can use the following values for the :term:`OE_TERMINAL` variable: |
| @@ -5182,7 +5181,7 @@ system and gives an overview of their function and contents. | |||
| 5182 | 5181 | ||
| 5183 | An easy way to see what overrides apply is to search for :term:`OVERRIDES` | 5182 | An easy way to see what overrides apply is to search for :term:`OVERRIDES` |
| 5184 | in the output of the ``bitbake -e`` command. See the | 5183 | in the output of the ``bitbake -e`` command. See the |
| 5185 | ":ref:`dev-manual/common-tasks:viewing variable values`" section in the Yocto | 5184 | ":ref:`dev-manual/debugging:viewing variable values`" section in the Yocto |
| 5186 | Project Development Tasks Manual for more information. | 5185 | Project Development Tasks Manual for more information. |
| 5187 | 5186 | ||
| 5188 | :term:`P` | 5187 | :term:`P` |
| @@ -5203,7 +5202,7 @@ system and gives an overview of their function and contents. | |||
| 5203 | specific by using the package name as a suffix. | 5202 | specific by using the package name as a suffix. |
| 5204 | 5203 | ||
| 5205 | You can find out more about applying this variable in the | 5204 | You can find out more about applying this variable in the |
| 5206 | ":ref:`dev-manual/common-tasks:adding custom metadata to packages`" | 5205 | ":ref:`dev-manual/packages:adding custom metadata to packages`" |
| 5207 | section in the Yocto Project Development Tasks Manual. | 5206 | section in the Yocto Project Development Tasks Manual. |
| 5208 | 5207 | ||
| 5209 | :term:`PACKAGE_ARCH` | 5208 | :term:`PACKAGE_ARCH` |
| @@ -5310,7 +5309,7 @@ system and gives an overview of their function and contents. | |||
| 5310 | use of the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable. | 5309 | use of the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable. |
| 5311 | 5310 | ||
| 5312 | You can find out more about debugging using GDB by reading the | 5311 | You can find out more about debugging using GDB by reading the |
| 5313 | ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section | 5312 | ":ref:`dev-manual/debugging:debugging with the gnu project debugger (gdb) remotely`" section |
| 5314 | in the Yocto Project Development Tasks Manual. | 5313 | in the Yocto Project Development Tasks Manual. |
| 5315 | 5314 | ||
| 5316 | :term:`PACKAGE_EXCLUDE` | 5315 | :term:`PACKAGE_EXCLUDE` |
| @@ -5469,7 +5468,7 @@ system and gives an overview of their function and contents. | |||
| 5469 | the :ref:`core-image-minimal-initramfs <ref-manual/images:images>` | 5468 | the :ref:`core-image-minimal-initramfs <ref-manual/images:images>` |
| 5470 | image. When working with an initial RAM filesystem (initramfs) image, | 5469 | image. When working with an initial RAM filesystem (initramfs) image, |
| 5471 | use the :term:`PACKAGE_INSTALL` variable. For information on creating an | 5470 | use the :term:`PACKAGE_INSTALL` variable. For information on creating an |
| 5472 | initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section | 5471 | :term:`Initramfs`, see the ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section |
| 5473 | in the Yocto Project Development Tasks Manual. | 5472 | in the Yocto Project Development Tasks Manual. |
| 5474 | 5473 | ||
| 5475 | :term:`PACKAGE_INSTALL_ATTEMPTONLY` | 5474 | :term:`PACKAGE_INSTALL_ATTEMPTONLY` |
| @@ -5492,7 +5491,7 @@ system and gives an overview of their function and contents. | |||
| 5492 | :term:`PACKAGE_WRITE_DEPS`. | 5491 | :term:`PACKAGE_WRITE_DEPS`. |
| 5493 | 5492 | ||
| 5494 | For information on running post-installation scripts, see the | 5493 | For information on running post-installation scripts, see the |
| 5495 | ":ref:`dev-manual/common-tasks:post-installation scripts`" | 5494 | ":ref:`dev-manual/new-recipe:post-installation scripts`" |
| 5496 | section in the Yocto Project Development Tasks Manual. | 5495 | section in the Yocto Project Development Tasks Manual. |
| 5497 | 5496 | ||
| 5498 | :term:`PACKAGECONFIG` | 5497 | :term:`PACKAGECONFIG` |
| @@ -5643,7 +5642,7 @@ system and gives an overview of their function and contents. | |||
| 5643 | 5642 | ||
| 5644 | For an example of how to use the :term:`PACKAGES_DYNAMIC` variable when | 5643 | For an example of how to use the :term:`PACKAGES_DYNAMIC` variable when |
| 5645 | you are splitting packages, see the | 5644 | you are splitting packages, see the |
| 5646 | ":ref:`dev-manual/common-tasks:handling optional module packaging`" | 5645 | ":ref:`dev-manual/packages:handling optional module packaging`" |
| 5647 | section in the Yocto Project Development Tasks Manual. | 5646 | section in the Yocto Project Development Tasks Manual. |
| 5648 | 5647 | ||
| 5649 | :term:`PACKAGESPLITFUNCS` | 5648 | :term:`PACKAGESPLITFUNCS` |
| @@ -5678,7 +5677,7 @@ system and gives an overview of their function and contents. | |||
| 5678 | the ``do_compile`` task that result in race conditions, you can clear | 5677 | the ``do_compile`` task that result in race conditions, you can clear |
| 5679 | the :term:`PARALLEL_MAKE` variable within the recipe as a workaround. For | 5678 | the :term:`PARALLEL_MAKE` variable within the recipe as a workaround. For |
| 5680 | information on addressing race conditions, see the | 5679 | information on addressing race conditions, see the |
| 5681 | ":ref:`dev-manual/common-tasks:debugging parallel make races`" | 5680 | ":ref:`dev-manual/debugging:debugging parallel make races`" |
| 5682 | section in the Yocto Project Development Tasks Manual. | 5681 | section in the Yocto Project Development Tasks Manual. |
| 5683 | 5682 | ||
| 5684 | For single socket systems (i.e. one CPU), you should not have to | 5683 | For single socket systems (i.e. one CPU), you should not have to |
| @@ -5688,7 +5687,7 @@ system and gives an overview of their function and contents. | |||
| 5688 | not set higher than "-j 20". | 5687 | not set higher than "-j 20". |
| 5689 | 5688 | ||
| 5690 | For more information on speeding up builds, see the | 5689 | For more information on speeding up builds, see the |
| 5691 | ":ref:`dev-manual/common-tasks:speeding up a build`" | 5690 | ":ref:`dev-manual/speeding-up-build:speeding up a build`" |
| 5692 | section in the Yocto Project Development Tasks Manual. | 5691 | section in the Yocto Project Development Tasks Manual. |
| 5693 | 5692 | ||
| 5694 | :term:`PARALLEL_MAKEINST` | 5693 | :term:`PARALLEL_MAKEINST` |
| @@ -5708,7 +5707,7 @@ system and gives an overview of their function and contents. | |||
| 5708 | the ``do_install`` task that result in race conditions, you can | 5707 | the ``do_install`` task that result in race conditions, you can |
| 5709 | clear the :term:`PARALLEL_MAKEINST` variable within the recipe as a | 5708 | clear the :term:`PARALLEL_MAKEINST` variable within the recipe as a |
| 5710 | workaround. For information on addressing race conditions, see the | 5709 | workaround. For information on addressing race conditions, see the |
| 5711 | ":ref:`dev-manual/common-tasks:debugging parallel make races`" | 5710 | ":ref:`dev-manual/debugging:debugging parallel make races`" |
| 5712 | section in the Yocto Project Development Tasks Manual. | 5711 | section in the Yocto Project Development Tasks Manual. |
| 5713 | 5712 | ||
| 5714 | :term:`PATCHRESOLVE` | 5713 | :term:`PATCHRESOLVE` |
| @@ -5808,7 +5807,7 @@ system and gives an overview of their function and contents. | |||
| 5808 | For examples of how this data is used, see the | 5807 | For examples of how this data is used, see the |
| 5809 | ":ref:`overview-manual/concepts:automatically added runtime dependencies`" | 5808 | ":ref:`overview-manual/concepts:automatically added runtime dependencies`" |
| 5810 | section in the Yocto Project Overview and Concepts Manual and the | 5809 | section in the Yocto Project Overview and Concepts Manual and the |
| 5811 | ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" | 5810 | ":ref:`dev-manual/debugging:viewing package information with \`\`oe-pkgdata-util\`\``" |
| 5812 | section in the Yocto Project Development Tasks Manual. For more | 5811 | section in the Yocto Project Development Tasks Manual. For more |
| 5813 | information on the shared, global-state directory, see | 5812 | information on the shared, global-state directory, see |
| 5814 | :term:`STAGING_DIR_HOST`. | 5813 | :term:`STAGING_DIR_HOST`. |
| @@ -5924,7 +5923,7 @@ system and gives an overview of their function and contents. | |||
| 5924 | 5923 | ||
| 5925 | Because manually managing :term:`PR` can be cumbersome and error-prone, | 5924 | Because manually managing :term:`PR` can be cumbersome and error-prone, |
| 5926 | an automated solution exists. See the | 5925 | an automated solution exists. See the |
| 5927 | ":ref:`dev-manual/common-tasks:working with a pr service`" section | 5926 | ":ref:`dev-manual/packages:working with a pr service`" section |
| 5928 | in the Yocto Project Development Tasks Manual for more information. | 5927 | in the Yocto Project Development Tasks Manual for more information. |
| 5929 | 5928 | ||
| 5930 | :term:`PREFERRED_PROVIDER` | 5929 | :term:`PREFERRED_PROVIDER` |
| @@ -5947,7 +5946,7 @@ system and gives an overview of their function and contents. | |||
| 5947 | PREFERRED_PROVIDER_virtual/libgl ?= "mesa" | 5946 | PREFERRED_PROVIDER_virtual/libgl ?= "mesa" |
| 5948 | 5947 | ||
| 5949 | For more | 5948 | For more |
| 5950 | information, see the ":ref:`dev-manual/common-tasks:using virtual providers`" | 5949 | information, see the ":ref:`dev-manual/new-recipe:using virtual providers`" |
| 5951 | section in the Yocto Project Development Tasks Manual. | 5950 | section in the Yocto Project Development Tasks Manual. |
| 5952 | 5951 | ||
| 5953 | .. note:: | 5952 | .. note:: |
| @@ -6147,7 +6146,7 @@ system and gives an overview of their function and contents. | |||
| 6147 | 6146 | ||
| 6148 | You must | 6147 | You must |
| 6149 | set the variable if you want to automatically start a local :ref:`PR | 6148 | set the variable if you want to automatically start a local :ref:`PR |
| 6150 | service <dev-manual/common-tasks:working with a pr service>`. You can | 6149 | service <dev-manual/packages:working with a pr service>`. You can |
| 6151 | set :term:`PRSERV_HOST` to other values to use a remote PR service. | 6150 | set :term:`PRSERV_HOST` to other values to use a remote PR service. |
| 6152 | 6151 | ||
| 6153 | 6152 | ||
| @@ -6161,7 +6160,7 @@ system and gives an overview of their function and contents. | |||
| 6161 | 6160 | ||
| 6162 | :term:`PTEST_ENABLED` | 6161 | :term:`PTEST_ENABLED` |
| 6163 | Specifies whether or not :ref:`Package | 6162 | Specifies whether or not :ref:`Package |
| 6164 | Test <dev-manual/common-tasks:testing packages with ptest>` (ptest) | 6163 | Test <dev-manual/packages:testing packages with ptest>` (ptest) |
| 6165 | functionality is enabled when building a recipe. You should not set | 6164 | functionality is enabled when building a recipe. You should not set |
| 6166 | this variable directly. Enabling and disabling building Package Tests | 6165 | this variable directly. Enabling and disabling building Package Tests |
| 6167 | at build time should be done by adding "ptest" to (or removing it | 6166 | at build time should be done by adding "ptest" to (or removing it |
| @@ -7273,7 +7272,7 @@ system and gives an overview of their function and contents. | |||
| 7273 | various ``SPL_*`` variables used by the OpenEmbedded build system. | 7272 | various ``SPL_*`` variables used by the OpenEmbedded build system. |
| 7274 | 7273 | ||
| 7275 | See the BeagleBone machine configuration example in the | 7274 | See the BeagleBone machine configuration example in the |
| 7276 | ":ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" | 7275 | ":ref:`dev-manual/layers:adding a layer using the \`\`bitbake-layers\`\` script`" |
| 7277 | section in the Yocto Project Board Support Package Developer's Guide | 7276 | section in the Yocto Project Board Support Package Developer's Guide |
| 7278 | for additional information. | 7277 | for additional information. |
| 7279 | 7278 | ||
| @@ -7397,7 +7396,7 @@ system and gives an overview of their function and contents. | |||
| 7397 | For information on limitations when inheriting the latest revision | 7396 | For information on limitations when inheriting the latest revision |
| 7398 | of software using :term:`SRCREV`, see the :term:`AUTOREV` variable | 7397 | of software using :term:`SRCREV`, see the :term:`AUTOREV` variable |
| 7399 | description and the | 7398 | description and the |
| 7400 | ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" | 7399 | ":ref:`dev-manual/packages:automatically incrementing a package version number`" |
| 7401 | section, which is in the Yocto Project Development Tasks Manual. | 7400 | section, which is in the Yocto Project Development Tasks Manual. |
| 7402 | 7401 | ||
| 7403 | :term:`SRCTREECOVEREDTASKS` | 7402 | :term:`SRCTREECOVEREDTASKS` |
| @@ -7899,8 +7898,7 @@ system and gives an overview of their function and contents. | |||
| 7899 | SYSTEMD_SERVICE:${PN} = "connman.service" | 7898 | SYSTEMD_SERVICE:${PN} = "connman.service" |
| 7900 | 7899 | ||
| 7901 | :term:`SYSVINIT_ENABLED_GETTYS` | 7900 | :term:`SYSVINIT_ENABLED_GETTYS` |
| 7902 | When using | 7901 | When using :ref:`SysVinit <dev-manual/new-recipe:enabling system services>`, |
| 7903 | :ref:`SysVinit <dev-manual/common-tasks:enabling system services>`, | ||
| 7904 | specifies a space-separated list of the virtual terminals that should | 7902 | specifies a space-separated list of the virtual terminals that should |
| 7905 | run a `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ | 7903 | run a `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ |
| 7906 | (allowing login), assuming :term:`USE_VT` is not set to | 7904 | (allowing login), assuming :term:`USE_VT` is not set to |
| @@ -8182,7 +8180,7 @@ system and gives an overview of their function and contents. | |||
| 8182 | file. | 8180 | file. |
| 8183 | 8181 | ||
| 8184 | For more information on testing images, see the | 8182 | For more information on testing images, see the |
| 8185 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 8183 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
| 8186 | section in the Yocto Project Development Tasks Manual. | 8184 | section in the Yocto Project Development Tasks Manual. |
| 8187 | 8185 | ||
| 8188 | :term:`TEST_SERIALCONTROL_CMD` | 8186 | :term:`TEST_SERIALCONTROL_CMD` |
| @@ -8255,7 +8253,7 @@ system and gives an overview of their function and contents. | |||
| 8255 | TEST_SUITES = "test_A test_B" | 8253 | TEST_SUITES = "test_A test_B" |
| 8256 | 8254 | ||
| 8257 | For more information on testing images, see the | 8255 | For more information on testing images, see the |
| 8258 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 8256 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
| 8259 | section in the Yocto Project Development Tasks Manual. | 8257 | section in the Yocto Project Development Tasks Manual. |
| 8260 | 8258 | ||
| 8261 | :term:`TEST_TARGET` | 8259 | :term:`TEST_TARGET` |
| @@ -8274,7 +8272,7 @@ system and gives an overview of their function and contents. | |||
| 8274 | You can provide the following arguments with :term:`TEST_TARGET`: | 8272 | You can provide the following arguments with :term:`TEST_TARGET`: |
| 8275 | 8273 | ||
| 8276 | - *"qemu":* Boots a QEMU image and runs the tests. See the | 8274 | - *"qemu":* Boots a QEMU image and runs the tests. See the |
| 8277 | ":ref:`dev-manual/common-tasks:enabling runtime tests on qemu`" section | 8275 | ":ref:`dev-manual/runtime-testing:enabling runtime tests on qemu`" section |
| 8278 | in the Yocto Project Development Tasks Manual for more | 8276 | in the Yocto Project Development Tasks Manual for more |
| 8279 | information. | 8277 | information. |
| 8280 | 8278 | ||
| @@ -8290,7 +8288,7 @@ system and gives an overview of their function and contents. | |||
| 8290 | ``meta/lib/oeqa/controllers/simpleremote.py``. | 8288 | ``meta/lib/oeqa/controllers/simpleremote.py``. |
| 8291 | 8289 | ||
| 8292 | For information on running tests on hardware, see the | 8290 | For information on running tests on hardware, see the |
| 8293 | ":ref:`dev-manual/common-tasks:enabling runtime tests on hardware`" | 8291 | ":ref:`dev-manual/runtime-testing:enabling runtime tests on hardware`" |
| 8294 | section in the Yocto Project Development Tasks Manual. | 8292 | section in the Yocto Project Development Tasks Manual. |
| 8295 | 8293 | ||
| 8296 | :term:`TEST_TARGET_IP` | 8294 | :term:`TEST_TARGET_IP` |
| @@ -8327,7 +8325,7 @@ system and gives an overview of their function and contents. | |||
| 8327 | 8325 | ||
| 8328 | For more information | 8326 | For more information |
| 8329 | on enabling, running, and writing these tests, see the | 8327 | on enabling, running, and writing these tests, see the |
| 8330 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" | 8328 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" |
| 8331 | section in the Yocto Project Development Tasks Manual and the | 8329 | section in the Yocto Project Development Tasks Manual and the |
| 8332 | ":ref:`ref-classes-testimage*`" section. | 8330 | ":ref:`ref-classes-testimage*`" section. |
| 8333 | 8331 | ||
| @@ -8786,16 +8784,15 @@ system and gives an overview of their function and contents. | |||
| 8786 | specifically set. Typically, you would set :term:`USE_DEVFS` to "0" for a | 8784 | specifically set. Typically, you would set :term:`USE_DEVFS` to "0" for a |
| 8787 | statically populated ``/dev`` directory. | 8785 | statically populated ``/dev`` directory. |
| 8788 | 8786 | ||
| 8789 | See the ":ref:`dev-manual/common-tasks:selecting a device manager`" section in | 8787 | See the ":ref:`dev-manual/device-manager:selecting a device manager`" section in |
| 8790 | the Yocto Project Development Tasks Manual for information on how to | 8788 | the Yocto Project Development Tasks Manual for information on how to |
| 8791 | use this variable. | 8789 | use this variable. |
| 8792 | 8790 | ||
| 8793 | :term:`USE_VT` | 8791 | :term:`USE_VT` |
| 8794 | When using | 8792 | When using |
| 8795 | :ref:`SysVinit <dev-manual/common-tasks:enabling system services>`, | 8793 | :ref:`SysVinit <dev-manual/new-recipe:enabling system services>`, |
| 8796 | determines whether or not to run a | 8794 | determines whether or not to run a :wikipedia:`getty <Getty_(Unix)>` |
| 8797 | `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any | 8795 | on any virtual terminals in order to enable logging in through those |
| 8798 | virtual terminals in order to enable logging in through those | ||
| 8799 | terminals. | 8796 | terminals. |
| 8800 | 8797 | ||
| 8801 | The default value used for :term:`USE_VT` is "1" when no default value is | 8798 | The default value used for :term:`USE_VT` is "1" when no default value is |
| @@ -8960,7 +8957,7 @@ system and gives an overview of their function and contents. | |||
| 8960 | OpenEmbedded build system to create a partitioned image | 8957 | OpenEmbedded build system to create a partitioned image |
| 8961 | (``image.wic``). For information on how to create a partitioned | 8958 | (``image.wic``). For information on how to create a partitioned |
| 8962 | image, see the | 8959 | image, see the |
| 8963 | ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" | 8960 | ":ref:`dev-manual/wic:creating partitioned images using wic`" |
| 8964 | section in the Yocto Project Development Tasks Manual. For details on | 8961 | section in the Yocto Project Development Tasks Manual. For details on |
| 8965 | the kickstart file format, see the ":doc:`/ref-manual/kickstart`" Chapter. | 8962 | the kickstart file format, see the ":doc:`/ref-manual/kickstart`" Chapter. |
| 8966 | 8963 | ||
