summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-01-18 19:11:14 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-02-03 13:47:50 +0000
commit3a6185404e241790bd17cb563e33eec4a0a9296a (patch)
treef7d1b86f5f2b82631491d6ae5f295c948d296e69 /documentation/ref-manual/variables.rst
parenta9fdd010b9382c05a0fd5aefb14280dc125f1808 (diff)
downloadpoky-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/ref-manual/variables.rst')
-rw-r--r--documentation/ref-manual/variables.rst20
1 files changed, 9 insertions, 11 deletions
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