summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-01-11 17:49:28 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-01-17 11:59:50 +0000
commitfc30301d4cf6a1aa4934cc8572cfd4d3659df817 (patch)
tree12a008ef225acad396e563d5d2bec4e86f6b698a
parent8dbd3a1757f2703c5183155dda3f52f6f9a79a96 (diff)
downloadpoky-fc30301d4cf6a1aa4934cc8572cfd4d3659df817.tar.gz
manuals: simplify references to class sections
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>
-rw-r--r--documentation/migration-guides/migration-1.3.rst2
-rw-r--r--documentation/migration-guides/migration-1.5.rst9
-rw-r--r--documentation/migration-guides/migration-1.6.rst3
-rw-r--r--documentation/ref-manual/qa-checks.rst4
-rw-r--r--documentation/ref-manual/tasks.rst2
-rw-r--r--documentation/ref-manual/variables.rst29
6 files changed, 22 insertions, 27 deletions
diff --git a/documentation/migration-guides/migration-1.3.rst b/documentation/migration-guides/migration-1.3.rst
index afb868e7cb..9a1539172e 100644
--- a/documentation/migration-guides/migration-1.3.rst
+++ b/documentation/migration-guides/migration-1.3.rst
@@ -113,7 +113,7 @@ recipes to ``packagegroup-*``, and change them to inherit
113to remove anything now handled by ``packagegroup.bbclass``, such as 113to remove anything now handled by ``packagegroup.bbclass``, such as
114providing ``-dev`` and ``-dbg`` packages, setting 114providing ``-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:`packagegroup.bbclass <ref-classes-packagegroup>`" section for 116:ref:`ref-classes-packagegroup` section for
117further details. 117further details.
118 118
119.. _migration-1.3-image-features: 119.. _migration-1.3-image-features:
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst
index 15b0b43092..0306b99c65 100644
--- a/documentation/migration-guides/migration-1.5.rst
+++ b/documentation/migration-guides/migration-1.5.rst
@@ -87,8 +87,7 @@ The following changes have been made to the package QA checks:
87 item not mentioned in :term:`ERROR_QA` or :term:`WARN_QA` would be treated as 87 item not mentioned in :term:`ERROR_QA` or :term:`WARN_QA` would be treated as
88 a warning. Consequently, several important items were not already in 88 a warning. Consequently, several important items were not already in
89 the default value of :term:`WARN_QA`. All of the possible QA checks are 89 the default value of :term:`WARN_QA`. All of the possible QA checks are
90 now documented in the ":ref:`insane.bbclass <ref-classes-insane>`" 90 now documented in the ":ref:`ref-classes-insane`" section.
91 section.
92 91
93- An additional QA check has been added to check if 92- An additional QA check has been added to check if
94 ``/usr/share/info/dir`` is being installed. Your recipe should delete 93 ``/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:
102 and still wish to have this check performed, you should add 101 and still wish to have this check performed, you should add
103 "version-going-backwards" to your value for one or the other 102 "version-going-backwards" to your value for one or the other
104 variables depending on how you wish it to be handled. See the 103 variables depending on how you wish it to be handled. See the
105 documented QA checks in the 104 documented QA checks in the ":ref:`ref-classes-insane`" section.
106 ":ref:`insane.bbclass <ref-classes-insane>`" section.
107 105
108.. _migration-1.5-directory-layout-changes: 106.. _migration-1.5-directory-layout-changes:
109 107
@@ -222,8 +220,7 @@ recipes that previously inherited from this class, you should rename
222them from ``task-*`` to ``packagegroup-*`` and inherit packagegroup 220them from ``task-*`` to ``packagegroup-*`` and inherit packagegroup
223instead. 221instead.
224 222
225For more information, see the 223For more information, see the ":ref:`ref-classes-packagegroup`" section.
226":ref:`packagegroup.bbclass <ref-classes-packagegroup>`" section.
227 224
228.. _migration-1.5-busybox: 225.. _migration-1.5-busybox:
229 226
diff --git a/documentation/migration-guides/migration-1.6.rst b/documentation/migration-guides/migration-1.6.rst
index e240038a7b..358086560b 100644
--- a/documentation/migration-guides/migration-1.6.rst
+++ b/documentation/migration-guides/migration-1.6.rst
@@ -222,8 +222,7 @@ Package Tests (ptest) are built but not installed by default. For
222information on using Package Tests, see the 222information on using Package Tests, see the
223":ref:`dev-manual/common-tasks:testing packages with ptest`" 223":ref:`dev-manual/common-tasks:testing packages with ptest`"
224section in the Yocto Project Development Tasks Manual. For information on the 224section in the Yocto Project Development Tasks Manual. For information on the
225``ptest`` class, see the ":ref:`ptest.bbclass <ref-classes-ptest>`" 225``ptest`` class, see the ":ref:`ref-classes-ptest`" section.
226section.
227 226
228.. _migration-1.6-build-changes: 227.. _migration-1.6-build-changes:
229 228
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index 792c099d0c..3364311219 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -28,7 +28,7 @@ error form along with an explanation.
28.. note:: 28.. note::
29 29
30 - At the end of each message, the name of the associated QA test (as 30 - At the end of each message, the name of the associated QA test (as
31 listed in the ":ref:`insane.bbclass <ref-classes-insane>`" 31 listed in the ":ref:`ref-classes-insane`"
32 section) appears within square brackets. 32 section) appears within square brackets.
33 33
34 - As mentioned, this list of error and warning messages is for QA 34 - 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
749variables, respectively. You can also disable checks within a particular 749variables, respectively. You can also disable checks within a particular
750recipe using :term:`INSANE_SKIP`. For information on 750recipe using :term:`INSANE_SKIP`. For information on
751how to work with the QA checks, see the 751how to work with the QA checks, see the
752":ref:`insane.bbclass <ref-classes-insane>`" section. 752":ref:`ref-classes-insane`" section.
753 753
754.. note:: 754.. note::
755 755
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index d484d08f82..b51462b79a 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -415,7 +415,7 @@ dependencies specified by :term:`DEPENDS`). See the
415 415
416Removes work files after the OpenEmbedded build system has finished with 416Removes work files after the OpenEmbedded build system has finished with
417them. You can learn more by looking at the 417them. You can learn more by looking at the
418":ref:`rm_work.bbclass <ref-classes-rm-work>`" section. 418":ref:`ref-classes-rm-work`" section.
419 419
420.. _ref-tasks-unpack: 420.. _ref-tasks-unpack:
421 421
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index be496161bd..76831003d1 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -56,7 +56,7 @@ system and gives an overview of their function and contents.
56 ALTERNATIVE:busybox = "sh sed test bracket" 56 ALTERNATIVE:busybox = "sh sed test bracket"
57 57
58 For more information on the alternatives system, see the 58 For more information on the alternatives system, see the
59 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" 59 ":ref:`ref-classes-update-alternatives`"
60 section. 60 section.
61 61
62 :term:`ALTERNATIVE_LINK_NAME` 62 :term:`ALTERNATIVE_LINK_NAME`
@@ -76,7 +76,7 @@ system and gives an overview of their function and contents.
76 If :term:`ALTERNATIVE_LINK_NAME` is not defined, it defaults to ``${bindir}/name``. 76 If :term:`ALTERNATIVE_LINK_NAME` is not defined, it defaults to ``${bindir}/name``.
77 77
78 For more information on the alternatives system, see the 78 For more information on the alternatives system, see the
79 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" 79 ":ref:`ref-classes-update-alternatives`"
80 section. 80 section.
81 81
82 :term:`ALTERNATIVE_PRIORITY` 82 :term:`ALTERNATIVE_PRIORITY`
@@ -92,7 +92,7 @@ system and gives an overview of their function and contents.
92 ALTERNATIVE_PRIORITY_pkg[name] = "priority" 92 ALTERNATIVE_PRIORITY_pkg[name] = "priority"
93 93
94 For more information on the alternatives system, see the 94 For more information on the alternatives system, see the
95 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" 95 ":ref:`ref-classes-update-alternatives`"
96 section. 96 section.
97 97
98 :term:`ALTERNATIVE_TARGET` 98 :term:`ALTERNATIVE_TARGET`
@@ -122,8 +122,7 @@ system and gives an overview of their function and contents.
122 task while retaining support for the command if necessary. 122 task while retaining support for the command if necessary.
123 123
124 For more information on the alternatives system, see the 124 For more information on the alternatives system, see the
125 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" 125 ":ref:`ref-classes-update-alternatives`" section.
126 section.
127 126
128 :term:`ANY_OF_DISTRO_FEATURES` 127 :term:`ANY_OF_DISTRO_FEATURES`
129 When inheriting the 128 When inheriting the
@@ -803,7 +802,7 @@ system and gives an overview of their function and contents.
803 ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`. 802 ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`.
804 You can also find general 803 You can also find general
805 information on the class in the 804 information on the class in the
806 ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section. 805 ":ref:`ref-classes-binconfig`" section.
807 806
808 :term:`BP` 807 :term:`BP`
809 The base recipe name and version but without any special recipe name 808 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.
2079 errors by the OpenEmbedded build system. You set this variable in 2078 errors by the OpenEmbedded build system. You set this variable in
2080 your distribution configuration file. For a list of the checks you 2079 your distribution configuration file. For a list of the checks you
2081 can control with this variable, see the 2080 can control with this variable, see the
2082 ":ref:`insane.bbclass <ref-classes-insane>`" section. 2081 ":ref:`ref-classes-insane`" section.
2083 2082
2084 :term:`EXCLUDE_FROM_SHLIBS` 2083 :term:`EXCLUDE_FROM_SHLIBS`
2085 Triggers the OpenEmbedded build system's shared libraries resolver to 2084 Triggers the OpenEmbedded build system's shared libraries resolver to
@@ -2158,7 +2157,7 @@ system and gives an overview of their function and contents.
2158 system uses to locate unpacked recipe source code. 2157 system uses to locate unpacked recipe source code.
2159 2158
2160 For more information on ``externalsrc.bbclass``, see the 2159 For more information on ``externalsrc.bbclass``, see the
2161 ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You 2160 ":ref:`ref-classes-externalsrc`" section. You
2162 can also find information on how to use this variable in the 2161 can also find information on how to use this variable in the
2163 ":ref:`dev-manual/common-tasks:building software from an external source`" 2162 ":ref:`dev-manual/common-tasks:building software from an external source`"
2164 section in the Yocto Project Development Tasks Manual. 2163 section in the Yocto Project Development Tasks Manual.
@@ -2172,7 +2171,7 @@ system and gives an overview of their function and contents.
2172 Directory. 2171 Directory.
2173 2172
2174 For more information on ``externalsrc.bbclass``, see the 2173 For more information on ``externalsrc.bbclass``, see the
2175 ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You 2174 ":ref:`ref-classes-externalsrc`" section. You
2176 can also find information on how to use this variable in the 2175 can also find information on how to use this variable in the
2177 ":ref:`dev-manual/common-tasks:building software from an external source`" 2176 ":ref:`dev-manual/common-tasks:building software from an external source`"
2178 section in the Yocto Project Development Tasks Manual. 2177 section in the Yocto Project Development Tasks Manual.
@@ -2843,7 +2842,7 @@ system and gives an overview of their function and contents.
2843 :term:`ICECC_DISABLED` 2842 :term:`ICECC_DISABLED`
2844 Disables or enables the ``icecc`` (Icecream) function. For more 2843 Disables or enables the ``icecc`` (Icecream) function. For more
2845 information on this function and best practices for using this 2844 information on this function and best practices for using this
2846 variable, see the ":ref:`icecc.bbclass <ref-classes-icecc>`" 2845 variable, see the ":ref:`ref-classes-icecc`"
2847 section. 2846 section.
2848 2847
2849 Setting this variable to "1" in your ``local.conf`` disables the 2848 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.
3740 3739
3741 INSANE_SKIP:${PN} += "dev-so" 3740 INSANE_SKIP:${PN} += "dev-so"
3742 3741
3743 See the ":ref:`insane.bbclass <ref-classes-insane>`" section for a 3742 See the ":ref:`ref-classes-insane`" section for a
3744 list of the valid QA checks you can specify using this variable. 3743 list of the valid QA checks you can specify using this variable.
3745 3744
3746 :term:`INSTALL_TIMEZONE_FILE` 3745 :term:`INSTALL_TIMEZONE_FILE`
@@ -5090,7 +5089,7 @@ system and gives an overview of their function and contents.
5090 5089
5091 For information on packaging and build performance effects as a 5090 For information on packaging and build performance effects as a
5092 result of the package manager in use, see the 5091 result of the package manager in use, see the
5093 ":ref:`package.bbclass <ref-classes-package>`" section. 5092 ":ref:`ref-classes-package`" section.
5094 5093
5095 :term:`PACKAGE_DEBUG_SPLIT_STYLE` 5094 :term:`PACKAGE_DEBUG_SPLIT_STYLE`
5096 Determines how to split up and package debug and source information 5095 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.
6204 :term:`RM_WORK_EXCLUDE` 6203 :term:`RM_WORK_EXCLUDE`
6205 With ``rm_work`` enabled, this variable specifies a list of recipes 6204 With ``rm_work`` enabled, this variable specifies a list of recipes
6206 whose work directories should not be removed. See the 6205 whose work directories should not be removed. See the
6207 ":ref:`rm_work.bbclass <ref-classes-rm-work>`" section for more 6206 ":ref:`ref-classes-rm-work`" section for more
6208 details. 6207 details.
6209 6208
6210 :term:`ROOT_HOME` 6209 :term:`ROOT_HOME`
@@ -8016,7 +8015,7 @@ system and gives an overview of their function and contents.
8016 on enabling, running, and writing these tests, see the 8015 on enabling, running, and writing these tests, see the
8017 ":ref:`dev-manual/common-tasks:performing automated runtime testing`" 8016 ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
8018 section in the Yocto Project Development Tasks Manual and the 8017 section in the Yocto Project Development Tasks Manual and the
8019 ":ref:`testimage*.bbclass <ref-classes-testimage*>`" section. 8018 ":ref:`ref-classes-testimage*`" section.
8020 8019
8021 :term:`THISDIR` 8020 :term:`THISDIR`
8022 The directory in which the file BitBake is currently parsing is 8021 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.
8675 warnings by the OpenEmbedded build system. You set this variable in 8674 warnings by the OpenEmbedded build system. You set this variable in
8676 your distribution configuration file. For a list of the checks you 8675 your distribution configuration file. For a list of the checks you
8677 can control with this variable, see the 8676 can control with this variable, see the
8678 ":ref:`insane.bbclass <ref-classes-insane>`" section. 8677 ":ref:`ref-classes-insane`" section.
8679 8678
8680 :term:`WKS_FILE` 8679 :term:`WKS_FILE`
8681 Specifies the location of the Wic kickstart file that is used by the 8680 Specifies the location of the Wic kickstart file that is used by the