diff options
Diffstat (limited to 'documentation/ref-manual/ref-classes.rst')
-rw-r--r-- | documentation/ref-manual/ref-classes.rst | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst index e0cdbe87fa..4147044ea3 100644 --- a/documentation/ref-manual/ref-classes.rst +++ b/documentation/ref-manual/ref-classes.rst | |||
@@ -68,7 +68,7 @@ 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 archiver, see the |
71 | ":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" | 71 | ":ref:`dev-manual/common-tasks: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/dev-manual-common-tasks:autotooled package`" section | 89 | ":ref:`dev-manual/common-tasks: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. |
@@ -236,7 +236,7 @@ The ``buildhistory`` class records a history of build output metadata, | |||
236 | which can be used to detect possible regressions as well as used for | 236 | which can be used to detect possible regressions as well as used for |
237 | analysis of the build output. For more information on using Build | 237 | analysis of the build output. For more information on using Build |
238 | History, see the | 238 | History, see the |
239 | ":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" | 239 | ":ref:`dev-manual/common-tasks:maintaining build output quality`" |
240 | section in the Yocto Project Development Tasks Manual. | 240 | section in the Yocto Project Development Tasks Manual. |
241 | 241 | ||
242 | .. _ref-classes-buildstats: | 242 | .. _ref-classes-buildstats: |
@@ -458,7 +458,7 @@ staging the files from ``DEPLOYDIR`` to ``DEPLOY_DIR_IMAGE``. | |||
458 | ==================== | 458 | ==================== |
459 | 459 | ||
460 | The ``devshell`` class adds the ``do_devshell`` task. Distribution | 460 | The ``devshell`` class adds the ``do_devshell`` task. Distribution |
461 | policy dictates whether to include this class. See the ":ref:`dev-manual/dev-manual-common-tasks:using a development shell`" | 461 | policy dictates whether to include this class. See the ":ref:`dev-manual/common-tasks:using a development shell`" |
462 | section in the Yocto Project Development Tasks Manual for more | 462 | section in the Yocto Project Development Tasks Manual for more |
463 | information about using ``devshell``. | 463 | information about using ``devshell``. |
464 | 464 | ||
@@ -586,7 +586,7 @@ For more information on the ``externalsrc`` class, see the comments in | |||
586 | ``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`. | 586 | ``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`. |
587 | For information on how to use the | 587 | For information on how to use the |
588 | ``externalsrc`` class, see the | 588 | ``externalsrc`` class, see the |
589 | ":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`" | 589 | ":ref:`dev-manual/common-tasks:building software from an external source`" |
590 | section in the Yocto Project Development Tasks Manual. | 590 | section in the Yocto Project Development Tasks Manual. |
591 | 591 | ||
592 | .. _ref-classes-extrausers: | 592 | .. _ref-classes-extrausers: |
@@ -927,7 +927,7 @@ then one or more image files are created. | |||
927 | install into the image. | 927 | install into the image. |
928 | 928 | ||
929 | For information on customizing images, see the | 929 | For information on customizing images, see the |
930 | ":ref:`dev-manual/dev-manual-common-tasks:customizing images`" section | 930 | ":ref:`dev-manual/common-tasks:customizing images`" section |
931 | in the Yocto Project Development Tasks Manual. For information on how | 931 | in the Yocto Project Development Tasks Manual. For information on how |
932 | images are created, see the | 932 | images are created, see the |
933 | ":ref:`overview-manual/overview-manual-concepts:images`" section in the | 933 | ":ref:`overview-manual/overview-manual-concepts:images`" section in the |
@@ -1344,7 +1344,7 @@ packages such as ``kernel-vmlinux``. | |||
1344 | The ``kernel`` class contains logic that allows you to embed an initial | 1344 | The ``kernel`` class contains logic that allows you to embed an initial |
1345 | RAM filesystem (initramfs) image when you build the kernel image. For | 1345 | RAM filesystem (initramfs) image when you build the kernel image. For |
1346 | information on how to build an initramfs, see the | 1346 | information on how to build an initramfs, see the |
1347 | ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section in | 1347 | ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section in |
1348 | the Yocto Project Development Tasks Manual. | 1348 | the Yocto Project Development Tasks Manual. |
1349 | 1349 | ||
1350 | Various other classes are used by the ``kernel`` and ``module`` classes | 1350 | Various other classes are used by the ``kernel`` and ``module`` classes |
@@ -1620,7 +1620,7 @@ different target optimizations or target architectures and installing | |||
1620 | them side-by-side in the same image. | 1620 | them side-by-side in the same image. |
1621 | 1621 | ||
1622 | For more information on using the Multilib feature, see the | 1622 | For more information on using the Multilib feature, see the |
1623 | ":ref:`dev-manual/dev-manual-common-tasks:combining multiple versions of library files into one image`" | 1623 | ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" |
1624 | section in the Yocto Project Development Tasks Manual. | 1624 | section in the Yocto Project Development Tasks Manual. |
1625 | 1625 | ||
1626 | .. _ref-classes-native: | 1626 | .. _ref-classes-native: |
@@ -1732,7 +1732,7 @@ package manager (NPM) <https://en.wikipedia.org/wiki/Npm_(software)>`__. | |||
1732 | fetcher to have dependencies fetched and packaged automatically. | 1732 | fetcher to have dependencies fetched and packaged automatically. |
1733 | 1733 | ||
1734 | For information on how to create NPM packages, see the | 1734 | For information on how to create NPM packages, see the |
1735 | ":ref:`dev-manual/dev-manual-common-tasks:creating node package manager (npm) packages`" | 1735 | ":ref:`dev-manual/common-tasks:creating node package manager (npm) packages`" |
1736 | section in the Yocto Project Development Tasks Manual. | 1736 | section in the Yocto Project Development Tasks Manual. |
1737 | 1737 | ||
1738 | .. _ref-classes-oelint: | 1738 | .. _ref-classes-oelint: |
@@ -1802,7 +1802,7 @@ If you take the optional step to set up a repository (package feed) on | |||
1802 | the development host that can be used by DNF, you can install packages | 1802 | the development host that can be used by DNF, you can install packages |
1803 | from the feed while you are running the image on the target (i.e. | 1803 | from the feed while you are running the image on the target (i.e. |
1804 | runtime installation of packages). For more information, see the | 1804 | runtime installation of packages). For more information, see the |
1805 | ":ref:`dev-manual/dev-manual-common-tasks:using runtime package management`" | 1805 | ":ref:`dev-manual/common-tasks:using runtime package management`" |
1806 | section in the Yocto Project Development Tasks Manual. | 1806 | section in the Yocto Project Development Tasks Manual. |
1807 | 1807 | ||
1808 | The package-specific class you choose can affect build-time performance | 1808 | The package-specific class you choose can affect build-time performance |
@@ -1921,7 +1921,7 @@ so forth). It is highly recommended that all package group recipes | |||
1921 | inherit this class. | 1921 | inherit this class. |
1922 | 1922 | ||
1923 | For information on how to use this class, see the | 1923 | For information on how to use this class, see the |
1924 | ":ref:`dev-manual/dev-manual-common-tasks:customizing images using custom package groups`" | 1924 | ":ref:`dev-manual/common-tasks:customizing images using custom package groups`" |
1925 | section in the Yocto Project Development Tasks Manual. | 1925 | section in the Yocto Project Development Tasks Manual. |
1926 | 1926 | ||
1927 | Previously, this class was called the ``task`` class. | 1927 | Previously, this class was called the ``task`` class. |
@@ -2080,7 +2080,7 @@ The ``primport`` class provides functionality for importing | |||
2080 | ================== | 2080 | ================== |
2081 | 2081 | ||
2082 | The ``prserv`` class provides functionality for using a :ref:`PR | 2082 | The ``prserv`` class provides functionality for using a :ref:`PR |
2083 | service <dev-manual/dev-manual-common-tasks:working with a pr service>` in order to | 2083 | service <dev-manual/common-tasks:working with a pr service>` in order to |
2084 | automatically manage the incrementing of the :term:`PR` | 2084 | automatically manage the incrementing of the :term:`PR` |
2085 | variable for each recipe. | 2085 | variable for each recipe. |
2086 | 2086 | ||
@@ -2100,7 +2100,7 @@ runtime tests for recipes that build software that provides these tests. | |||
2100 | This class is intended to be inherited by individual recipes. However, | 2100 | This class is intended to be inherited by individual recipes. However, |
2101 | the class' functionality is largely disabled unless "ptest" appears in | 2101 | the class' functionality is largely disabled unless "ptest" appears in |
2102 | :term:`DISTRO_FEATURES`. See the | 2102 | :term:`DISTRO_FEATURES`. See the |
2103 | ":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" | 2103 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" |
2104 | section in the Yocto Project Development Tasks Manual for more information | 2104 | section in the Yocto Project Development Tasks Manual for more information |
2105 | on ptest. | 2105 | on ptest. |
2106 | 2106 | ||
@@ -2113,7 +2113,7 @@ Enables package tests (ptests) specifically for GNOME packages, which | |||
2113 | have tests intended to be executed with ``gnome-desktop-testing``. | 2113 | have tests intended to be executed with ``gnome-desktop-testing``. |
2114 | 2114 | ||
2115 | For information on setting up and running ptests, see the | 2115 | For information on setting up and running ptests, see the |
2116 | ":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" | 2116 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" |
2117 | section in the Yocto Project Development Tasks Manual. | 2117 | section in the Yocto Project Development Tasks Manual. |
2118 | 2118 | ||
2119 | .. _ref-classes-python-dir: | 2119 | .. _ref-classes-python-dir: |
@@ -2199,7 +2199,7 @@ override the removal by setting ``REMOVE_LIBTOOL_LA`` to "0" as follows: | |||
2199 | ======================== | 2199 | ======================== |
2200 | 2200 | ||
2201 | The ``report-error`` class supports enabling the :ref:`error reporting | 2201 | The ``report-error`` class supports enabling the :ref:`error reporting |
2202 | tool <dev-manual/dev-manual-common-tasks:using the error reporting tool>`", | 2202 | tool <dev-manual/common-tasks:using the error reporting tool>`", |
2203 | which allows you to submit build error information to a central database. | 2203 | which allows you to submit build error information to a central database. |
2204 | 2204 | ||
2205 | The class collects debug information for recipe, recipe version, task, | 2205 | The class collects debug information for recipe, recipe version, task, |
@@ -2554,7 +2554,7 @@ unless you have set | |||
2554 | :term:`SYSTEMD_AUTO_ENABLE` to "disable". | 2554 | :term:`SYSTEMD_AUTO_ENABLE` to "disable". |
2555 | 2555 | ||
2556 | For more information on ``systemd``, see the | 2556 | For more information on ``systemd``, see the |
2557 | ":ref:`dev-manual/dev-manual-common-tasks:selecting an initialization manager`" | 2557 | ":ref:`dev-manual/common-tasks:selecting an initialization manager`" |
2558 | section in the Yocto Project Development Tasks Manual. | 2558 | section in the Yocto Project Development Tasks Manual. |
2559 | 2559 | ||
2560 | .. _ref-classes-systemd-boot: | 2560 | .. _ref-classes-systemd-boot: |
@@ -2631,7 +2631,7 @@ runs tests on an image after the image is constructed (i.e. | |||
2631 | :term:`TESTIMAGE_AUTO` must be set to "1"). | 2631 | :term:`TESTIMAGE_AUTO` must be set to "1"). |
2632 | 2632 | ||
2633 | For information on how to enable, run, and create new tests, see the | 2633 | For information on how to enable, run, and create new tests, see the |
2634 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | 2634 | ":ref:`dev-manual/common-tasks:performing automated runtime testing`" |
2635 | section in the Yocto Project Development Tasks Manual. | 2635 | section in the Yocto Project Development Tasks Manual. |
2636 | 2636 | ||
2637 | .. _ref-classes-testsdk: | 2637 | .. _ref-classes-testsdk: |