diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-01-18 19:11:14 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-02-03 13:47:50 +0000 |
commit | 3a6185404e241790bd17cb563e33eec4a0a9296a (patch) | |
tree | f7d1b86f5f2b82631491d6ae5f295c948d296e69 /documentation | |
parent | a9fdd010b9382c05a0fd5aefb14280dc125f1808 (diff) | |
download | poky-3a6185404e241790bd17cb563e33eec4a0a9296a.tar.gz |
manuals: improve references to classes
- Simplify references to class sections, by replacing references such as
:ref:`image.bbclass <ref-classes-image>`
by
:ref:`ref-classes-image`
That's equivalent, because the class sections always called <class>.bbclass
- Adding references to class sections, by replacing strings such as
``image.bbclass``
by
:ref:`ref-classes-image`
- Simplifying a few class section links
(From yocto-docs rev: 29d66aaa898390c19f121baf0f4fdcc178e4cd80)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 5 | ||||
-rw-r--r-- | documentation/migration-guides/migration-1.3.rst | 2 | ||||
-rw-r--r-- | documentation/migration-guides/migration-1.5.rst | 4 | ||||
-rw-r--r-- | documentation/migration-guides/migration-2.2.rst | 2 | ||||
-rw-r--r-- | documentation/migration-guides/migration-2.3.rst | 3 | ||||
-rw-r--r-- | documentation/migration-guides/migration-3.5.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/release-process.rst | 6 | ||||
-rw-r--r-- | documentation/ref-manual/structure.rst | 11 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 20 |
9 files changed, 26 insertions, 29 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index f8ee774077..d35b590ee1 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -4393,7 +4393,7 @@ This next example shows how to accomplish the same thing by setting | |||
4393 | locally inherit the :ref:`externalsrc <ref-classes-externalsrc>` | 4393 | locally inherit the :ref:`externalsrc <ref-classes-externalsrc>` |
4394 | class. | 4394 | class. |
4395 | 4395 | ||
4396 | By default, ``externalsrc.bbclass`` builds the source code in a | 4396 | By default, :ref:`ref-classes-externalsrc` builds the source code in a |
4397 | directory separate from the external source directory as specified by | 4397 | directory separate from the external source directory as specified by |
4398 | :term:`EXTERNALSRC`. If you need | 4398 | :term:`EXTERNALSRC`. If you need |
4399 | to have the source built in the same directory in which it resides, or | 4399 | to have the source built in the same directory in which it resides, or |
@@ -6246,8 +6246,7 @@ system to make your images more secure: | |||
6246 | :ref:`extrausers <ref-classes-extrausers>` | 6246 | :ref:`extrausers <ref-classes-extrausers>` |
6247 | class, which is the preferred method. For an example on how to set up | 6247 | class, which is the preferred method. For an example on how to set up |
6248 | both root and user passwords, see the | 6248 | both root and user passwords, see the |
6249 | ":ref:`extrausers.bbclass <ref-classes-extrausers>`" | 6249 | ":ref:`ref-classes-extrausers`" section. |
6250 | section. | ||
6251 | 6250 | ||
6252 | .. note:: | 6251 | .. note:: |
6253 | 6252 | ||
diff --git a/documentation/migration-guides/migration-1.3.rst b/documentation/migration-guides/migration-1.3.rst index 9a1539172e..6a1755d1dc 100644 --- a/documentation/migration-guides/migration-1.3.rst +++ b/documentation/migration-guides/migration-1.3.rst | |||
@@ -110,7 +110,7 @@ references in your own recipes and configurations as they could be | |||
110 | removed in future releases. You should also rename any custom ``task-*`` | 110 | removed in future releases. You should also rename any custom ``task-*`` |
111 | recipes to ``packagegroup-*``, and change them to inherit | 111 | recipes to ``packagegroup-*``, and change them to inherit |
112 | ``packagegroup`` instead of ``task``, as well as taking the opportunity | 112 | ``packagegroup`` instead of ``task``, as well as taking the opportunity |
113 | to remove anything now handled by ``packagegroup.bbclass``, such as | 113 | to remove anything now handled by :ref:`ref-classes-packagegroup`, such as |
114 | providing ``-dev`` and ``-dbg`` packages, setting | 114 | providing ``-dev`` and ``-dbg`` packages, setting |
115 | :term:`LIC_FILES_CHKSUM`, and so forth. See the | 115 | :term:`LIC_FILES_CHKSUM`, and so forth. See the |
116 | :ref:`ref-classes-packagegroup` section for | 116 | :ref:`ref-classes-packagegroup` section for |
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst index 0306b99c65..93db14c3ba 100644 --- a/documentation/migration-guides/migration-1.5.rst +++ b/documentation/migration-guides/migration-1.5.rst | |||
@@ -240,7 +240,7 @@ Automated Image Testing | |||
240 | ----------------------- | 240 | ----------------------- |
241 | 241 | ||
242 | A new automated image testing framework has been added through the | 242 | A new automated image testing framework has been added through the |
243 | :ref:`testimage.bbclass <ref-classes-testimage*>` class. This | 243 | :ref:`ref-classes-testimage*` classes. This |
244 | framework replaces the older ``imagetest-qemu`` framework. | 244 | framework replaces the older ``imagetest-qemu`` framework. |
245 | 245 | ||
246 | You can learn more about performing automated image tests in the | 246 | You can learn more about performing automated image tests in the |
@@ -341,7 +341,7 @@ Following is a list of short entries describing other changes: | |||
341 | 341 | ||
342 | - ``libpam``: Deny all services for the ``OTHER`` entries. | 342 | - ``libpam``: Deny all services for the ``OTHER`` entries. |
343 | 343 | ||
344 | - ``image.bbclass``: Move ``runtime_mapping_rename`` to avoid conflict | 344 | - :ref:`ref-classes-image`: Move ``runtime_mapping_rename`` to avoid conflict |
345 | with ``multilib``. See :yocto_bugs:`YOCTO #4993 </show_bug.cgi?id=4993>` | 345 | with ``multilib``. See :yocto_bugs:`YOCTO #4993 </show_bug.cgi?id=4993>` |
346 | in Bugzilla for more information. | 346 | in Bugzilla for more information. |
347 | 347 | ||
diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst index a6c1a4aa48..3e35b2b8aa 100644 --- a/documentation/migration-guides/migration-2.2.rst +++ b/documentation/migration-guides/migration-2.2.rst | |||
@@ -439,7 +439,7 @@ The following miscellaneous changes have occurred: | |||
439 | 439 | ||
440 | - ``packagegroup-core-tools-testapps``: Removed Piglit. | 440 | - ``packagegroup-core-tools-testapps``: Removed Piglit. |
441 | 441 | ||
442 | - :ref:`image.bbclass <ref-classes-image>`: Renamed COMPRESS(ION) to CONVERSION. This change | 442 | - :ref:`ref-classes-image`: Renamed COMPRESS(ION) to CONVERSION. This change |
443 | means that ``COMPRESSIONTYPES``, ``COMPRESS_DEPENDS`` and | 443 | means that ``COMPRESSIONTYPES``, ``COMPRESS_DEPENDS`` and |
444 | ``COMPRESS_CMD`` are deprecated in favor of ``CONVERSIONTYPES``, | 444 | ``COMPRESS_CMD`` are deprecated in favor of ``CONVERSIONTYPES``, |
445 | ``CONVERSION_DEPENDS`` and ``CONVERSION_CMD``. The ``COMPRESS*`` | 445 | ``CONVERSION_DEPENDS`` and ``CONVERSION_CMD``. The ``COMPRESS*`` |
diff --git a/documentation/migration-guides/migration-2.3.rst b/documentation/migration-guides/migration-2.3.rst index 0b6b33d2cb..59271abbc0 100644 --- a/documentation/migration-guides/migration-2.3.rst +++ b/documentation/migration-guides/migration-2.3.rst | |||
@@ -304,8 +304,7 @@ The following package management changes took place: | |||
304 | This change was made because too many places in DNF/RPM4 stack | 304 | This change was made because too many places in DNF/RPM4 stack |
305 | already make that assumption. Only the filenames and the architecture | 305 | already make that assumption. Only the filenames and the architecture |
306 | tag has changed. Nothing else has changed in OE-core system, | 306 | tag has changed. Nothing else has changed in OE-core system, |
307 | particularly in the :ref:`allarch.bbclass <ref-classes-allarch>` | 307 | particularly in the :ref:`ref-classes-allarch` class. |
308 | class. | ||
309 | 308 | ||
310 | - Signing of remote package feeds using ``PACKAGE_FEED_SIGN`` is not | 309 | - Signing of remote package feeds using ``PACKAGE_FEED_SIGN`` is not |
311 | currently supported. This issue will be fully addressed in a future | 310 | currently supported. This issue will be fully addressed in a future |
diff --git a/documentation/migration-guides/migration-3.5.rst b/documentation/migration-guides/migration-3.5.rst index df15487b10..8c2a7d2c65 100644 --- a/documentation/migration-guides/migration-3.5.rst +++ b/documentation/migration-guides/migration-3.5.rst | |||
@@ -52,5 +52,5 @@ Recipe changes | |||
52 | and :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`. | 52 | and :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`. |
53 | 53 | ||
54 | - :ref:`allarch <ref-classes-allarch>` packagegroups can no longer depend on packages | 54 | - :ref:`allarch <ref-classes-allarch>` packagegroups can no longer depend on packages |
55 | which use :term:`PKG` renaming such as :ref:`debian.bbclass <ref-classes-debian>`. | 55 | which use :term:`PKG` renaming such as :ref:`ref-classes-debian`. |
56 | 56 | ||
diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst index ab143f7df0..8acb4b8e09 100644 --- a/documentation/ref-manual/release-process.rst +++ b/documentation/ref-manual/release-process.rst | |||
@@ -117,17 +117,17 @@ consists of the following pieces: | |||
117 | - ``bitbake-selftest``: A standalone command that runs unit tests on | 117 | - ``bitbake-selftest``: A standalone command that runs unit tests on |
118 | key pieces of BitBake and its fetchers. | 118 | key pieces of BitBake and its fetchers. |
119 | 119 | ||
120 | - :ref:`sanity.bbclass <ref-classes-sanity>`: This automatically | 120 | - :ref:`ref-classes-sanity`: This automatically |
121 | included class checks the build environment for missing tools (e.g. | 121 | included class checks the build environment for missing tools (e.g. |
122 | ``gcc``) or common misconfigurations such as | 122 | ``gcc``) or common misconfigurations such as |
123 | :term:`MACHINE` set incorrectly. | 123 | :term:`MACHINE` set incorrectly. |
124 | 124 | ||
125 | - :ref:`insane.bbclass <ref-classes-insane>`: This class checks the | 125 | - :ref:`ref-classes-insane`: This class checks the |
126 | generated output from builds for sanity. For example, if building for | 126 | generated output from builds for sanity. For example, if building for |
127 | an ARM target, did the build produce ARM binaries. If, for example, | 127 | an ARM target, did the build produce ARM binaries. If, for example, |
128 | the build produced PPC binaries then there is a problem. | 128 | the build produced PPC binaries then there is a problem. |
129 | 129 | ||
130 | - :ref:`testimage.bbclass <ref-classes-testimage*>`: This class | 130 | - :ref:`ref-classes-testimage*`: This class |
131 | performs runtime testing of images after they are built. The tests | 131 | performs runtime testing of images after they are built. The tests |
132 | are usually used with :doc:`QEMU </dev-manual/qemu>` | 132 | are usually used with :doc:`QEMU </dev-manual/qemu>` |
133 | to boot the images and check the combined runtime result boot | 133 | to boot the images and check the combined runtime result boot |
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 5d2e3a86ef..262b041ea6 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
@@ -667,16 +667,17 @@ Yocto Project. Metadata has several important subdivisions: | |||
667 | 667 | ||
668 | This directory contains the ``*.bbclass`` files. Class files are used to | 668 | This directory contains the ``*.bbclass`` files. Class files are used to |
669 | abstract common code so it can be reused by multiple packages. Every | 669 | abstract common code so it can be reused by multiple packages. Every |
670 | package inherits the ``base.bbclass`` file. Examples of other important | 670 | package inherits the :ref:`ref-classes-base` file. Examples of other important |
671 | classes are ``autotools.bbclass``, which in theory allows any | 671 | classes are :ref:`ref-classes-autotools`, which in theory allows any |
672 | Autotool-enabled package to work with the Yocto Project with minimal | 672 | Autotool-enabled package to work with the Yocto Project with minimal |
673 | effort. Another example is ``kernel.bbclass`` that contains common code | 673 | effort. Another example is :ref:`ref-classes-kernel` that contains common code |
674 | and functions for working with the Linux kernel. Functions like image | 674 | and functions for working with the Linux kernel. Functions like image |
675 | generation or packaging also have their specific class files such as | 675 | generation or packaging also have their specific class files such as |
676 | ``image.bbclass``, ``rootfs_*.bbclass`` and ``package*.bbclass``. | 676 | :ref:`ref-classes-image`, :ref:`ref-classes-rootfs*` and |
677 | :ref:`package*.bbclass <ref-classes-package>`. | ||
677 | 678 | ||
678 | For reference information on classes, see the | 679 | For reference information on classes, see the |
679 | ":ref:`ref-manual/classes:Classes`" chapter. | 680 | ":doc:`/ref-manual/classes`" chapter. |
680 | 681 | ||
681 | .. _structure-meta-conf: | 682 | .. _structure-meta-conf: |
682 | 683 | ||
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index b0621168ae..adb104e202 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -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 directory in which build history | 972 | class, this variable specifies the directory in which build history |
973 | information is kept. For more information on how the variable works, | 973 | information is kept. For more information on how the variable works, |
974 | see the ``buildhistory.bbclass`` file. | 974 | see the :ref:`ref-classes-buildhistory` class. |
975 | 975 | ||
976 | By default, the :ref:`buildhistory <ref-classes-buildhistory>` class sets the directory as follows:: | 976 | By default, the :ref:`buildhistory <ref-classes-buildhistory>` class sets the directory as follows:: |
977 | 977 | ||
@@ -2162,8 +2162,7 @@ system and gives an overview of their function and contents. | |||
2162 | :term:`S` variable, which is what the OpenEmbedded build | 2162 | :term:`S` variable, which is what the OpenEmbedded build |
2163 | system uses to locate unpacked recipe source code. | 2163 | system uses to locate unpacked recipe source code. |
2164 | 2164 | ||
2165 | For more information on ``externalsrc.bbclass``, see the | 2165 | See the ":ref:`ref-classes-externalsrc`" section for details. You |
2166 | ":ref:`ref-classes-externalsrc`" section. You | ||
2167 | can also find information on how to use this variable in the | 2166 | can also find information on how to use this variable in the |
2168 | ":ref:`dev-manual/common-tasks:building software from an external source`" | 2167 | ":ref:`dev-manual/common-tasks:building software from an external source`" |
2169 | section in the Yocto Project Development Tasks Manual. | 2168 | section in the Yocto Project Development Tasks Manual. |
@@ -2176,8 +2175,7 @@ system and gives an overview of their function and contents. | |||
2176 | which is what the OpenEmbedded build system uses to locate the Build | 2175 | which is what the OpenEmbedded build system uses to locate the Build |
2177 | Directory. | 2176 | Directory. |
2178 | 2177 | ||
2179 | For more information on ``externalsrc.bbclass``, see the | 2178 | See the ":ref:`ref-classes-externalsrc`" section for details. You |
2180 | ":ref:`ref-classes-externalsrc`" section. You | ||
2181 | can also find information on how to use this variable in the | 2179 | can also find information on how to use this variable in the |
2182 | ":ref:`dev-manual/common-tasks:building software from an external source`" | 2180 | ":ref:`dev-manual/common-tasks:building software from an external source`" |
2183 | section in the Yocto Project Development Tasks Manual. | 2181 | section in the Yocto Project Development Tasks Manual. |
@@ -2501,7 +2499,7 @@ system and gives an overview of their function and contents. | |||
2501 | :term:`SRC_URI` statements. | 2499 | :term:`SRC_URI` statements. |
2502 | 2500 | ||
2503 | The default value for the :term:`FILESPATH` variable is defined in the | 2501 | The default value for the :term:`FILESPATH` variable is defined in the |
2504 | ``base.bbclass`` class found in ``meta/classes`` in the | 2502 | :ref:`ref-classes-base` class found in ``meta/classes`` in the |
2505 | :term:`Source Directory`:: | 2503 | :term:`Source Directory`:: |
2506 | 2504 | ||
2507 | FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ | 2505 | FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ |
@@ -3085,7 +3083,7 @@ system and gives an overview of their function and contents. | |||
3085 | :term:`IMAGE_INSTALL` variable with care to avoid ordering issues. | 3083 | :term:`IMAGE_INSTALL` variable with care to avoid ordering issues. |
3086 | 3084 | ||
3087 | Image recipes set :term:`IMAGE_INSTALL` to specify the packages to | 3085 | Image recipes set :term:`IMAGE_INSTALL` to specify the packages to |
3088 | install into an image through ``image.bbclass``. Additionally, | 3086 | install into an image through :ref:`ref-classes-image`. Additionally, |
3089 | there are "helper" classes such as the | 3087 | there are "helper" classes such as the |
3090 | :ref:`core-image <ref-classes-core-image>` class which can | 3088 | :ref:`core-image <ref-classes-core-image>` class which can |
3091 | take lists used with :term:`IMAGE_FEATURES` and turn them into | 3089 | take lists used with :term:`IMAGE_FEATURES` and turn them into |
@@ -3118,7 +3116,7 @@ system and gives an overview of their function and contents. | |||
3118 | BitBake operator within the ``/conf/local.conf`` file or from | 3116 | BitBake operator within the ``/conf/local.conf`` file or from |
3119 | within an image recipe is not recommended. Use of this operator | 3117 | within an image recipe is not recommended. Use of this operator |
3120 | in these ways can cause ordering issues. Since | 3118 | in these ways can cause ordering issues. Since |
3121 | ``core-image.bbclass`` sets :term:`IMAGE_INSTALL` to a default | 3119 | :ref:`ref-classes-core-image` sets :term:`IMAGE_INSTALL` to a default |
3122 | value using the | 3120 | value using the |
3123 | :ref:`?= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:setting a default value (?=)>` | 3121 | :ref:`?= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:setting a default value (?=)>` |
3124 | operator, using a ``+=`` operation against :term:`IMAGE_INSTALL` | 3122 | operator, using a ``+=`` operation against :term:`IMAGE_INSTALL` |
@@ -3708,7 +3706,7 @@ system and gives an overview of their function and contents. | |||
3708 | The filename of the initialization script as installed to | 3706 | The filename of the initialization script as installed to |
3709 | ``${sysconfdir}/init.d``. | 3707 | ``${sysconfdir}/init.d``. |
3710 | 3708 | ||
3711 | This variable is used in recipes when using ``update-rc.d.bbclass``. | 3709 | This variable is used in recipes when using :ref:`ref-classes-update-rc.d`. |
3712 | The variable is mandatory. | 3710 | The variable is mandatory. |
3713 | 3711 | ||
3714 | :term:`INITSCRIPT_PACKAGES` | 3712 | :term:`INITSCRIPT_PACKAGES` |
@@ -3716,7 +3714,7 @@ system and gives an overview of their function and contents. | |||
3716 | are specified, you need to append the package name to the other | 3714 | are specified, you need to append the package name to the other |
3717 | ``INITSCRIPT_*`` as an override. | 3715 | ``INITSCRIPT_*`` as an override. |
3718 | 3716 | ||
3719 | This variable is used in recipes when using ``update-rc.d.bbclass``. | 3717 | This variable is used in recipes when using :ref:`ref-classes-update-rc.d`. |
3720 | The variable is optional and defaults to the :term:`PN` | 3718 | The variable is optional and defaults to the :term:`PN` |
3721 | variable. | 3719 | variable. |
3722 | 3720 | ||
@@ -6346,7 +6344,7 @@ system and gives an overview of their function and contents. | |||
6346 | In the | 6344 | In the |
6347 | example, the package name (``${PN}-dev``) must appear as it would in | 6345 | example, the package name (``${PN}-dev``) must appear as it would in |
6348 | the :term:`PACKAGES` namespace before any renaming of the output package | 6346 | the :term:`PACKAGES` namespace before any renaming of the output package |
6349 | by classes such as ``debian.bbclass``. | 6347 | by classes such as :ref:`ref-classes-debian`. |
6350 | 6348 | ||
6351 | BitBake, which the OpenEmbedded build system uses, supports | 6349 | BitBake, which the OpenEmbedded build system uses, supports |
6352 | specifying versioned recommends. Although the syntax varies depending | 6350 | specifying versioned recommends. Although the syntax varies depending |