summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-31 17:58:42 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:34 +0100
commitf3e7db78adf417231ce29eb6a9a28a74857a2954 (patch)
treec6faab74fc9b7b2d368bd610486065f3ab53e580 /documentation/ref-manual
parent18df4a836845c6d7dec389a95623a472c19acdfe (diff)
downloadpoky-f3e7db78adf417231ce29eb6a9a28a74857a2954.tar.gz
sphinx: add links to section in the Bitbake manual
Use intersphinx extension to replace links to the Bitbake manual with proper cross references. (From yocto-docs rev: 458a6e540a2286ac838812d802306806f77b885c) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/migration.rst11
-rw-r--r--documentation/ref-manual/ref-devtool-reference.rst4
-rw-r--r--documentation/ref-manual/ref-structure.rst4
-rw-r--r--documentation/ref-manual/ref-tasks.rst6
-rw-r--r--documentation/ref-manual/ref-terms.rst4
-rw-r--r--documentation/ref-manual/ref-variables.rst34
-rw-r--r--documentation/ref-manual/resources.rst2
7 files changed, 31 insertions, 34 deletions
diff --git a/documentation/ref-manual/migration.rst b/documentation/ref-manual/migration.rst
index 9e821c5dd3..f834ba7004 100644
--- a/documentation/ref-manual/migration.rst
+++ b/documentation/ref-manual/migration.rst
@@ -2452,7 +2452,7 @@ compared to uClibc.
2452``${``\ :term:`B`\ ``}`` is no longer the default working 2452``${``\ :term:`B`\ ``}`` is no longer the default working
2453directory for tasks. Consequently, any custom tasks you define now need 2453directory for tasks. Consequently, any custom tasks you define now need
2454to either have the 2454to either have the
2455``[``\ ```dirs`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` flag 2455``[``\ :ref:`dirs <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` flag
2456set, or the task needs to change into the appropriate working directory 2456set, or the task needs to change into the appropriate working directory
2457manually (e.g using ``cd`` for a shell task). 2457manually (e.g using ``cd`` for a shell task).
2458 2458
@@ -2942,8 +2942,8 @@ The following changes took place for BitBake:
2942 fetcher passes the new parameter through the ``SVN_SSH`` environment 2942 fetcher passes the new parameter through the ``SVN_SSH`` environment
2943 variable during the :ref:`ref-tasks-fetch` task. 2943 variable during the :ref:`ref-tasks-fetch` task.
2944 2944
2945 See the "`Subversion (SVN) Fetcher 2945 See the ":ref:`bitbake:svn-fetcher`"
2946 (svn://) <&YOCTO_DOCS_BB_URL;#svn-fetcher>`__" section in the BitBake 2946 section in the BitBake
2947 User Manual for additional information. 2947 User Manual for additional information.
2948 2948
2949- *``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2`` 2949- *``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2``
@@ -3546,7 +3546,7 @@ The following are additional changes:
3546 3546
3547- BitBake fires multiple "BuildStarted" events when multiconfig is 3547- BitBake fires multiple "BuildStarted" events when multiconfig is
3548 enabled (one per configuration). For more information, see the 3548 enabled (one per configuration). For more information, see the
3549 "`Events <&YOCTO_DOCS_BB_URL;#events>`__" section in the BitBake User 3549 ":ref:`Events <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:events>`" section in the BitBake User
3550 Manual. 3550 Manual.
3551 3551
3552- By default, the ``security_flags.inc`` file sets a 3552- By default, the ``security_flags.inc`` file sets a
@@ -4143,8 +4143,7 @@ The following changes have occurred:
4143 specifying list items to remove, be aware that leading and trailing 4143 specifying list items to remove, be aware that leading and trailing
4144 whitespace resulting from the removal is retained. 4144 whitespace resulting from the removal is retained.
4145 4145
4146 See the "`Removal (Override Style 4146 See the ":ref:`bitbake:removing-override-style-syntax`"
4147 Syntax) <&YOCTO_DOCS_BB_URL;#removing-override-style-syntax>`__"
4148 section in the BitBake User Manual for a detailed example. 4147 section in the BitBake User Manual for a detailed example.
4149 4148
4150.. _migration-2.6-systemd-configuration-now-split-out-to-system-conf: 4149.. _migration-2.6-systemd-configuration-now-split-out-to-system-conf:
diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst
index 418c9623f6..ca1d7fd0cb 100644
--- a/documentation/ref-manual/ref-devtool-reference.rst
+++ b/documentation/ref-manual/ref-devtool-reference.rst
@@ -290,8 +290,8 @@ particular recipe.
290 ```maintainers.inc`http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc 290 ```maintainers.inc`http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc
291 file. 291 file.
292 292
293 - If the recipe is using the `Git 293 - If the recipe is using the :ref:`bitbake:git-fetcher`
294 fetcher <&YOCTO_DOCS_BB_URL;#git-fetcher>`__ rather than a 294 rather than a
295 tarball, the commit hash points to the commit that matches the 295 tarball, the commit hash points to the commit that matches the
296 recipe's latest version tag. 296 recipe's latest version tag.
297 297
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
index a21c0bdd52..03648148c2 100644
--- a/documentation/ref-manual/ref-structure.rst
+++ b/documentation/ref-manual/ref-structure.rst
@@ -46,8 +46,8 @@ environment setup script (i.e. ````` <#structure-core-script>`__) places
46the ``scripts/`` and ``bitbake/bin/`` directories (in that order) into 46the ``scripts/`` and ``bitbake/bin/`` directories (in that order) into
47the shell's ``PATH`` environment variable. 47the shell's ``PATH`` environment variable.
48 48
49For more information on BitBake, see the `BitBake User 49For more information on BitBake, see the :doc:`BitBake User Manual
50Manual <&YOCTO_DOCS_BB_URL;>`__. 50<bitbake:index>`.
51 51
52.. _structure-core-build: 52.. _structure-core-build:
53 53
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index f56f7a993f..5b0711586f 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -14,8 +14,8 @@ Normal Recipe Build Tasks
14 14
15The following sections describe normal tasks associated with building a 15The following sections describe normal tasks associated with building a
16recipe. For more information on tasks and dependencies, see the 16recipe. For more information on tasks and dependencies, see the
17"`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and 17":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and
18"`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the 18":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the
19BitBake User Manual. 19BitBake User Manual.
20 20
21.. _ref-tasks-build: 21.. _ref-tasks-build:
@@ -125,7 +125,7 @@ If the ``do_deploy`` task re-executes, any previous output is removed
125 125
126Fetches the source code. This task uses the 126Fetches the source code. This task uses the
127:term:`SRC_URI` variable and the argument's prefix to 127:term:`SRC_URI` variable and the argument's prefix to
128determine the correct `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ 128determine the correct :ref:`fetcher <bitbake:bb-fetchers>`
129module. 129module.
130 130
131.. _ref-tasks-image: 131.. _ref-tasks-image:
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst
index ec9f6d3948..24eff62bcd 100644
--- a/documentation/ref-manual/ref-terms.rst
+++ b/documentation/ref-manual/ref-terms.rst
@@ -47,8 +47,8 @@ universal, the list includes them just in case:
47 47
48 BitBake 48 BitBake
49 The task executor and scheduler used by the OpenEmbedded build system to 49 The task executor and scheduler used by the OpenEmbedded build system to
50 build images. For more information on BitBake, see the `BitBake User 50 build images. For more information on BitBake, see the :doc:`BitBake User
51 Manual <&YOCTO_DOCS_BB_URL;>`__. 51 Manual <bitbake:index>`.
52 52
53 Board Support Package (BSP) 53 Board Support Package (BSP)
54 A group of drivers, definitions, and other components that provide support 54 A group of drivers, definitions, and other components that provide support
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 6f70787cbb..485fbb27f5 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -239,8 +239,8 @@ system and gives an overview of their function and contents.
239 239
240 To add a tune to the list, be sure to append it with spaces using the 240 To add a tune to the list, be sure to append it with spaces using the
241 "+=" BitBake operator. Do not simply replace the list by using the 241 "+=" BitBake operator. Do not simply replace the list by using the
242 "=" operator. See the "`Basic 242 "=" operator. See the
243 Syntax <&YOCTO_DOCS_BB_URL;#basic-syntax>`__" section in the BitBake 243 ":ref:`Basic Syntax <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax>`" section in the BitBake
244 User Manual for more information. 244 User Manual for more information.
245 245
246 B 246 B
@@ -1477,7 +1477,7 @@ system and gives an overview of their function and contents.
1477 This mechanism is implemented by having ``do_configure`` depend on 1477 This mechanism is implemented by having ``do_configure`` depend on
1478 the :ref:`ref-tasks-populate_sysroot` task of 1478 the :ref:`ref-tasks-populate_sysroot` task of
1479 each recipe listed in ``DEPENDS``, through a 1479 each recipe listed in ``DEPENDS``, through a
1480 ``[``\ ```deptask`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` 1480 ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
1481 declaration in the :ref:`base <ref-classes-base>` class. 1481 declaration in the :ref:`base <ref-classes-base>` class.
1482 1482
1483 .. note:: 1483 .. note::
@@ -1524,8 +1524,8 @@ system and gives an overview of their function and contents.
1524 1524
1525 For information on runtime dependencies, see the 1525 For information on runtime dependencies, see the
1526 :term:`RDEPENDS` variable. You can also see the 1526 :term:`RDEPENDS` variable. You can also see the
1527 "`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and 1527 ":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and
1528 "`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the 1528 ":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the
1529 BitBake User Manual for additional information on tasks and 1529 BitBake User Manual for additional information on tasks and
1530 dependencies. 1530 dependencies.
1531 1531
@@ -2270,8 +2270,8 @@ system and gives an overview of their function and contents.
2270 :term:`FILESPATH` variable. For an example of how 2270 :term:`FILESPATH` variable. For an example of how
2271 that works, see the :term:`FILESPATH` variable 2271 that works, see the :term:`FILESPATH` variable
2272 description. Additionally, you find more information on how overrides 2272 description. Additionally, you find more information on how overrides
2273 are handled in the "`Conditional Syntax 2273 are handled in the
2274 (Overrides) <&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides>`__" 2274 ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
2275 section of the BitBake User Manual. 2275 section of the BitBake User Manual.
2276 2276
2277 By default, the ``FILESOVERRIDES`` variable is defined as: 2277 By default, the ``FILESOVERRIDES`` variable is defined as:
@@ -2789,13 +2789,13 @@ system and gives an overview of their function and contents.
2789 section in the Yocto Project Development Tasks Manual. 2789 section in the Yocto Project Development Tasks Manual.
2790 2790
2791 - Using ``IMAGE_INSTALL`` with the 2791 - Using ``IMAGE_INSTALL`` with the
2792 ```+=`` <&YOCTO_DOCS_BB_URL;#appending-and-prepending>`__ 2792 :ref:`+= <bitbake:appending-and-prepending>`
2793 BitBake operator within the ``/conf/local.conf`` file or from 2793 BitBake operator within the ``/conf/local.conf`` file or from
2794 within an image recipe is not recommended. Use of this operator 2794 within an image recipe is not recommended. Use of this operator
2795 in these ways can cause ordering issues. Since 2795 in these ways can cause ordering issues. Since
2796 ``core-image.bbclass`` sets ``IMAGE_INSTALL`` to a default 2796 ``core-image.bbclass`` sets ``IMAGE_INSTALL`` to a default
2797 value using the 2797 value using the
2798 ```?=`` <&YOCTO_DOCS_BB_URL;#setting-a-default-value>`__ 2798 :ref:`?= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:setting a default value (?=)>`
2799 operator, using a ``+=`` operation against ``IMAGE_INSTALL`` 2799 operator, using a ``+=`` operation against ``IMAGE_INSTALL``
2800 results in unexpected behavior when used within 2800 results in unexpected behavior when used within
2801 ``conf/local.conf``. Furthermore, the same operation from 2801 ``conf/local.conf``. Furthermore, the same operation from
@@ -3078,9 +3078,8 @@ system and gives an overview of their function and contents.
3078 configuration and in each individual recipe. The OpenEmbedded build 3078 configuration and in each individual recipe. The OpenEmbedded build
3079 system ignores changes to ``INHERIT`` in individual recipes. 3079 system ignores changes to ``INHERIT`` in individual recipes.
3080 3080
3081 For more information on ``INHERIT``, see the "```INHERIT`` 3081 For more information on ``INHERIT``, see the
3082 Configuration 3082 :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`"
3083 Directive <&YOCTO_DOCS_BB_URL;#inherit-configuration-directive>`__"
3084 section in the Bitbake User Manual. 3083 section in the Bitbake User Manual.
3085 3084
3086 INHERIT_DISTRO 3085 INHERIT_DISTRO
@@ -4415,9 +4414,8 @@ system and gives an overview of their function and contents.
4415 As an example, if the string "an-override" appears as an element in 4414 As an example, if the string "an-override" appears as an element in
4416 the colon-separated list in ``OVERRIDES``, then the following 4415 the colon-separated list in ``OVERRIDES``, then the following
4417 assignment will override ``FOO`` with the value "overridden" at the 4416 assignment will override ``FOO`` with the value "overridden" at the
4418 end of parsing: FOO_an-override = "overridden" See the "`Conditional 4417 end of parsing: FOO_an-override = "overridden" See the
4419 Syntax 4418 ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
4420 (Overrides) <&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides>`__"
4421 section in the BitBake User Manual for more information on the 4419 section in the BitBake User Manual for more information on the
4422 overrides mechanism. 4420 overrides mechanism.
4423 4421
@@ -5502,8 +5500,8 @@ system and gives an overview of their function and contents.
5502 5500
5503 For information on build-time dependencies, see the 5501 For information on build-time dependencies, see the
5504 :term:`DEPENDS` variable. You can also see the 5502 :term:`DEPENDS` variable. You can also see the
5505 "`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and 5503 ":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and
5506 "`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the 5504 ":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the
5507 BitBake User Manual for additional information on tasks and 5505 BitBake User Manual for additional information on tasks and
5508 dependencies. 5506 dependencies.
5509 5507
@@ -6254,7 +6252,7 @@ system and gives an overview of their function and contents.
6254 protocols are highly dependent on particular BitBake Fetcher 6252 protocols are highly dependent on particular BitBake Fetcher
6255 submodules. Depending on the fetcher BitBake uses, various URL 6253 submodules. Depending on the fetcher BitBake uses, various URL
6256 parameters are employed. For specifics on the supported Fetchers, see 6254 parameters are employed. For specifics on the supported Fetchers, see
6257 the "`Fetchers <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__" section in the 6255 the ":ref:`Fetchers <bitbake:bb-fetchers>`" section in the
6258 BitBake User Manual. 6256 BitBake User Manual.
6259 6257
6260 - *``file://`` -* Fetches files, which are usually files shipped 6258 - *``file://`` -* Fetches files, which are usually files shipped
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index b443cbfb79..c5ddcca97f 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -123,7 +123,7 @@ Here is a list of resources you might find helpful:
123- `BitBake <http://www.openembedded.org/wiki/BitBake>`__\ *:* The tool 123- `BitBake <http://www.openembedded.org/wiki/BitBake>`__\ *:* The tool
124 used to process metadata. 124 used to process metadata.
125 125
126- `BitBake User Manual <&YOCTO_DOCS_BB_URL;>`__\ *:* A comprehensive 126- :doc:`BitBake User Manual <bitbake:index>`\ *:* A comprehensive
127 guide to the BitBake tool. If you want information on BitBake, see 127 guide to the BitBake tool. If you want information on BitBake, see
128 this manual. 128 this manual.
129 129