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/classes.rst | |
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/classes.rst')
-rw-r--r-- | documentation/ref-manual/classes.rst | 38 |
1 files changed, 19 insertions, 19 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: |