mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-04-22 15:32:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

manuals: simplify references to class sections

Browse Source 
Replace
":ref:`classname.bbclass <ref-classes-classname>`" section
by
":ref:`ref-classes-classname`" section
because each section has "classname.bbclass" as title,
therefore the result is the same.

(From yocto-docs rev: e3f438e4a71b155bd09bc7988c8e5626a063fde3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker
2022-01-11 17:49:28 +01:00
committed by Richard Purdie
parent 8dbd3a1757
commit fc30301d4c
6 changed files with 22 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/migration-guides/migration-1.3.rst
View File

@@ -113,7 +113,7 @@ recipes to ``packagegroup-*``, and change them to inherit
to remove anything now handled by ``packagegroup.bbclass``, such as
providing ``-dev`` and ``-dbg`` packages, setting
:term:`LIC_FILES_CHKSUM`, and so forth. See the
":ref:`packagegroup.bbclass <ref-classes-packagegroup>`" section for
:ref:`ref-classes-packagegroup` section for
further details.
.. _migration-1.3-image-features:

9
documentation/migration-guides/migration-1.5.rst
View File

@@ -87,8 +87,7 @@ The following changes have been made to the package QA checks:
item not mentioned in :term:`ERROR_QA` or :term:`WARN_QA` would be treated as
a warning. Consequently, several important items were not already in
the default value of :term:`WARN_QA`. All of the possible QA checks are
now documented in the ":ref:`insane.bbclass <ref-classes-insane>`"
section.
now documented in the ":ref:`ref-classes-insane`" section.
- An additional QA check has been added to check if
``/usr/share/info/dir`` is being installed. Your recipe should delete
@@ -102,8 +101,7 @@ The following changes have been made to the package QA checks:
and still wish to have this check performed, you should add
"version-going-backwards" to your value for one or the other
variables depending on how you wish it to be handled. See the
documented QA checks in the
":ref:`insane.bbclass <ref-classes-insane>`" section.
documented QA checks in the ":ref:`ref-classes-insane`" section.
.. _migration-1.5-directory-layout-changes:
@@ -222,8 +220,7 @@ recipes that previously inherited from this class, you should rename
them from ``task-*`` to ``packagegroup-*`` and inherit packagegroup
instead.
For more information, see the
":ref:`packagegroup.bbclass <ref-classes-packagegroup>`" section.
For more information, see the ":ref:`ref-classes-packagegroup`" section.
.. _migration-1.5-busybox:

3
documentation/migration-guides/migration-1.6.rst
View File

@@ -222,8 +222,7 @@ Package Tests (ptest) are built but not installed by default. For
information on using Package Tests, see the
":ref:`dev-manual/common-tasks:testing packages with ptest`"
section in the Yocto Project Development Tasks Manual. For information on the
``ptest`` class, see the ":ref:`ptest.bbclass <ref-classes-ptest>`"
section.
``ptest`` class, see the ":ref:`ref-classes-ptest`" section.
.. _migration-1.6-build-changes:

4
documentation/ref-manual/qa-checks.rst
View File

@@ -28,7 +28,7 @@ error form along with an explanation.
.. note::
- At the end of each message, the name of the associated QA test (as
listed in the ":ref:`insane.bbclass <ref-classes-insane>`"
listed in the ":ref:`ref-classes-insane`"
section) appears within square brackets.
- As mentioned, this list of error and warning messages is for QA
@@ -749,7 +749,7 @@ either raise a warning or an error message, using the
variables, respectively. You can also disable checks within a particular
recipe using :term:`INSANE_SKIP`. For information on
how to work with the QA checks, see the
":ref:`insane.bbclass <ref-classes-insane>`" section.
":ref:`ref-classes-insane`" section.
.. note::

2
documentation/ref-manual/tasks.rst
View File

@@ -415,7 +415,7 @@ dependencies specified by :term:`DEPENDS`). See the
Removes work files after the OpenEmbedded build system has finished with
them. You can learn more by looking at the
":ref:`rm_work.bbclass <ref-classes-rm-work>`" section.
":ref:`ref-classes-rm-work`" section.
.. _ref-tasks-unpack:

29
documentation/ref-manual/variables.rst
View File

@@ -56,7 +56,7 @@ system and gives an overview of their function and contents.
ALTERNATIVE:busybox = "sh sed test bracket"
For more information on the alternatives system, see the
":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
":ref:`ref-classes-update-alternatives`"
section.
:term:`ALTERNATIVE_LINK_NAME`
@@ -76,7 +76,7 @@ system and gives an overview of their function and contents.
If :term:`ALTERNATIVE_LINK_NAME` is not defined, it defaults to ``${bindir}/name``.
For more information on the alternatives system, see the
":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
":ref:`ref-classes-update-alternatives`"
section.
:term:`ALTERNATIVE_PRIORITY`
@@ -92,7 +92,7 @@ system and gives an overview of their function and contents.
ALTERNATIVE_PRIORITY_pkg[name] = "priority"
For more information on the alternatives system, see the
":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
":ref:`ref-classes-update-alternatives`"
section.
:term:`ALTERNATIVE_TARGET`
@@ -122,8 +122,7 @@ system and gives an overview of their function and contents.
task while retaining support for the command if necessary.
For more information on the alternatives system, see the
":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
section.
":ref:`ref-classes-update-alternatives`" section.
:term:`ANY_OF_DISTRO_FEATURES`
When inheriting the
@@ -803,7 +802,7 @@ system and gives an overview of their function and contents.
``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`.
You can also find general
information on the class in the
":ref:`binconfig.bbclass <ref-classes-binconfig>`" section.
":ref:`ref-classes-binconfig`" section.
:term:`BP`
The base recipe name and version but without any special recipe name
@@ -2079,7 +2078,7 @@ system and gives an overview of their function and contents.
errors by the OpenEmbedded build system. You set this variable in
your distribution configuration file. For a list of the checks you
can control with this variable, see the
":ref:`insane.bbclass <ref-classes-insane>`" section.
":ref:`ref-classes-insane`" section.
:term:`EXCLUDE_FROM_SHLIBS`
Triggers the OpenEmbedded build system's shared libraries resolver to
@@ -2158,7 +2157,7 @@ system and gives an overview of their function and contents.
system uses to locate unpacked recipe source code.
For more information on ``externalsrc.bbclass``, see the
":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You
":ref:`ref-classes-externalsrc`" section. You
can also find information on how to use this variable in the
":ref:`dev-manual/common-tasks:building software from an external source`"
section in the Yocto Project Development Tasks Manual.
@@ -2172,7 +2171,7 @@ system and gives an overview of their function and contents.
Directory.
For more information on ``externalsrc.bbclass``, see the
":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You
":ref:`ref-classes-externalsrc`" section. You
can also find information on how to use this variable in the
":ref:`dev-manual/common-tasks:building software from an external source`"
section in the Yocto Project Development Tasks Manual.
@@ -2843,7 +2842,7 @@ system and gives an overview of their function and contents.
:term:`ICECC_DISABLED`
Disables or enables the ``icecc`` (Icecream) function. For more
information on this function and best practices for using this
variable, see the ":ref:`icecc.bbclass <ref-classes-icecc>`"
variable, see the ":ref:`ref-classes-icecc`"
section.
Setting this variable to "1" in your ``local.conf`` disables the
@@ -3740,7 +3739,7 @@ system and gives an overview of their function and contents.
INSANE_SKIP:${PN} += "dev-so"
See the ":ref:`insane.bbclass <ref-classes-insane>`" section for a
See the ":ref:`ref-classes-insane`" section for a
list of the valid QA checks you can specify using this variable.
:term:`INSTALL_TIMEZONE_FILE`
@@ -5090,7 +5089,7 @@ system and gives an overview of their function and contents.
For information on packaging and build performance effects as a
result of the package manager in use, see the
":ref:`package.bbclass <ref-classes-package>`" section.
":ref:`ref-classes-package`" section.
:term:`PACKAGE_DEBUG_SPLIT_STYLE`
Determines how to split up and package debug and source information
@@ -6204,7 +6203,7 @@ system and gives an overview of their function and contents.
:term:`RM_WORK_EXCLUDE`
With ``rm_work`` enabled, this variable specifies a list of recipes
whose work directories should not be removed. See the
":ref:`rm_work.bbclass <ref-classes-rm-work>`" section for more
":ref:`ref-classes-rm-work`" section for more
details.
:term:`ROOT_HOME`
@@ -8016,7 +8015,7 @@ system and gives an overview of their function and contents.
on enabling, running, and writing these tests, see the
":ref:`dev-manual/common-tasks:performing automated runtime testing`"
section in the Yocto Project Development Tasks Manual and the
":ref:`testimage*.bbclass <ref-classes-testimage*>`" section.
":ref:`ref-classes-testimage*`" section.
:term:`THISDIR`
The directory in which the file BitBake is currently parsing is
@@ -8675,7 +8674,7 @@ system and gives an overview of their function and contents.
warnings by the OpenEmbedded build system. You set this variable in
your distribution configuration file. For a list of the checks you
can control with this variable, see the
":ref:`insane.bbclass <ref-classes-insane>`" section.
":ref:`ref-classes-insane`" section.
:term:`WKS_FILE`
Specifies the location of the Wic kickstart file that is used by the