summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-11-20 08:50:38 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-03 12:04:20 +0000
commit63710fc913a39f0037c1f6604bf46446af26f86d (patch)
tree38f3c46574cf456fdcb779b40feb1c414970de3a /documentation
parent308cffcef12b93b4e42ef8a8821df1e0bcdd9a81 (diff)
downloadpoky-63710fc913a39f0037c1f6604bf46446af26f86d.tar.gz
sphinx: replace bitbake labels with references to corresponding title
In order to remove autogenerated labels in the bibtake docs, let's use section titles in all YP docs. (From yocto-docs rev: 0f44b6027f16cc37260abc7e00042d98e2e0427f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst2
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.rst4
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.rst2
-rw-r--r--documentation/overview-manual/overview-manual-concepts.rst6
-rw-r--r--documentation/ref-manual/migration-2.3.rst2
-rw-r--r--documentation/ref-manual/migration-2.6.rst2
-rw-r--r--documentation/ref-manual/ref-devtool-reference.rst2
-rw-r--r--documentation/ref-manual/ref-tasks.rst2
-rw-r--r--documentation/ref-manual/ref-variables.rst4
-rw-r--r--documentation/sdk-manual/sdk-extensible.rst2
10 files changed, 14 insertions, 14 deletions
diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
index c9622d3647..f8c3ad974e 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
+++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
@@ -246,7 +246,7 @@ an entire Linux distribution, including the toolchain, from source.
246 For information on using the ``bitbake`` command, see the 246 For information on using the ``bitbake`` command, see the
247 :ref:`usingpoky-components-bitbake` section in the Yocto Project Overview and 247 :ref:`usingpoky-components-bitbake` section in the Yocto Project Overview and
248 Concepts Manual, or see the ":ref:`BitBake Command 248 Concepts Manual, or see the ":ref:`BitBake Command
249 <bitbake:bitbake-user-manual-command>`" section in the BitBake User Manual. 249 <bitbake:bitbake-user-manual/bitbake-user-manual-intro:the bitbake command>`" section in the BitBake User Manual.
250 250
251#. **Simulate Your Image Using QEMU:** Once this particular image is 251#. **Simulate Your Image Using QEMU:** Once this particular image is
252 built, you can start QEMU, which is a Quick EMUlator that ships with 252 built, you can start QEMU, which is a Quick EMUlator that ships with
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
index 683f5557ec..1640a884d3 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -1369,7 +1369,7 @@ the Yocto Project Overview and Concepts Manual.
1369 1369
1370The :ref:`ref-tasks-fetch` task uses 1370The :ref:`ref-tasks-fetch` task uses
1371the prefix of each entry in the ``SRC_URI`` variable value to determine 1371the prefix of each entry in the ``SRC_URI`` variable value to determine
1372which :ref:`fetcher <bitbake:bb-fetchers>` to use to get your 1372which :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` to use to get your
1373source files. It is the ``SRC_URI`` variable that triggers the fetcher. 1373source files. It is the ``SRC_URI`` variable that triggers the fetcher.
1374The :ref:`ref-tasks-patch` task uses 1374The :ref:`ref-tasks-patch` task uses
1375the variable after source is fetched to apply patches. The OpenEmbedded 1375the variable after source is fetched to apply patches. The OpenEmbedded
@@ -7567,7 +7567,7 @@ Creating Node Package Manager (NPM) Packages
7567 7567
7568`NPM <https://en.wikipedia.org/wiki/Npm_(software)>`__ is a package 7568`NPM <https://en.wikipedia.org/wiki/Npm_(software)>`__ is a package
7569manager for the JavaScript programming language. The Yocto Project 7569manager for the JavaScript programming language. The Yocto Project
7570supports the NPM :ref:`fetcher <bitbake:bb-fetchers>`. You can 7570supports the NPM :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. You can
7571use this fetcher in combination with 7571use this fetcher in combination with
7572:doc:`devtool <../ref-manual/ref-devtool-reference>` to create 7572:doc:`devtool <../ref-manual/ref-devtool-reference>` to create
7573recipes that produce NPM packages. 7573recipes that produce NPM packages.
diff --git a/documentation/kernel-dev/kernel-dev-advanced.rst b/documentation/kernel-dev/kernel-dev-advanced.rst
index ca049316e4..6999057b8a 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.rst
+++ b/documentation/kernel-dev/kernel-dev-advanced.rst
@@ -369,7 +369,7 @@ in the "`Features <#features>`__" section. The
369variable in the kernel recipe selects the kernel type. For example, in 369variable in the kernel recipe selects the kernel type. For example, in
370the ``linux-yocto_4.12.bb`` kernel recipe found in 370the ``linux-yocto_4.12.bb`` kernel recipe found in
371``poky/meta/recipes-kernel/linux``, a 371``poky/meta/recipes-kernel/linux``, a
372:ref:`require <bitbake:require-inclusion>` directive 372:ref:`require <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`require\`\` directive>` directive
373includes the ``poky/meta/recipes-kernel/linux/linux-yocto.inc`` file, 373includes the ``poky/meta/recipes-kernel/linux/linux-yocto.inc`` file,
374which has the following statement that defines the default kernel type: 374which has the following statement that defines the default kernel type:
375:: 375::
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst
index 736fd9591e..f1f2b7f352 100644
--- a/documentation/overview-manual/overview-manual-concepts.rst
+++ b/documentation/overview-manual/overview-manual-concepts.rst
@@ -78,7 +78,7 @@ versions of ``matchbox-desktop`` might exist. BitBake chooses the one
78selected by the distribution configuration. You can get more details 78selected by the distribution configuration. You can get more details
79about how BitBake chooses between different target versions and 79about how BitBake chooses between different target versions and
80providers in the 80providers in the
81":ref:`Preferences <bitbake:bb-bitbake-preferences>`" section 81":ref:`Preferences <bitbake:bitbake-user-manual/bitbake-user-manual-execution:preferences>`" section
82of the BitBake User Manual. 82of the BitBake User Manual.
83 83
84BitBake also tries to execute any dependent tasks first. So for example, 84BitBake also tries to execute any dependent tasks first. So for example,
@@ -607,7 +607,7 @@ Source Control Managers (Optional)
607~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 607~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
608 608
609Another place from which the build system can get source files is with 609Another place from which the build system can get source files is with
610:ref:`fetchers <bitbake:bb-fetchers>` employing various Source 610:ref:`fetchers <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` employing various Source
611Control Managers (SCMs) such as Git or Subversion. In such cases, a 611Control Managers (SCMs) such as Git or Subversion. In such cases, a
612repository is cloned or checked out. The 612repository is cloned or checked out. The
613:ref:`ref-tasks-fetch` task inside 613:ref:`ref-tasks-fetch` task inside
@@ -1949,7 +1949,7 @@ The following list explains the previous example:
1949 extra metadata to the `stamp 1949 extra metadata to the `stamp
1950 file <#stamp-files-and-the-rerunning-of-tasks>`__. In this case, the 1950 file <#stamp-files-and-the-rerunning-of-tasks>`__. In this case, the
1951 metadata makes the task specific to a machine's architecture. See 1951 metadata makes the task specific to a machine's architecture. See
1952 ":ref:`bitbake:ref-bitbake-tasklist`" 1952 ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:the task list`"
1953 section in the BitBake User Manual for more information on the 1953 section in the BitBake User Manual for more information on the
1954 ``stamp-extra-info`` flag. 1954 ``stamp-extra-info`` flag.
1955 1955
diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst
index 5bf3e7033c..4041ad0556 100644
--- a/documentation/ref-manual/migration-2.3.rst
+++ b/documentation/ref-manual/migration-2.3.rst
@@ -198,7 +198,7 @@ The following changes took place for BitBake:
198 fetcher passes the new parameter through the ``SVN_SSH`` environment 198 fetcher passes the new parameter through the ``SVN_SSH`` environment
199 variable during the :ref:`ref-tasks-fetch` task. 199 variable during the :ref:`ref-tasks-fetch` task.
200 200
201 See the ":ref:`bitbake:svn-fetcher`" 201 See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:subversion (svn) fetcher (\`\`svn://\`\`)`"
202 section in the BitBake 202 section in the BitBake
203 User Manual for additional information. 203 User Manual for additional information.
204 204
diff --git a/documentation/ref-manual/migration-2.6.rst b/documentation/ref-manual/migration-2.6.rst
index 2f0da48ab6..cc7c24c5b1 100644
--- a/documentation/ref-manual/migration-2.6.rst
+++ b/documentation/ref-manual/migration-2.6.rst
@@ -278,7 +278,7 @@ The following changes have occurred:
278 specifying list items to remove, be aware that leading and trailing 278 specifying list items to remove, be aware that leading and trailing
279 whitespace resulting from the removal is retained. 279 whitespace resulting from the removal is retained.
280 280
281 See the ":ref:`bitbake:removing-override-style-syntax`" 281 See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`"
282 section in the BitBake User Manual for a detailed example. 282 section in the BitBake User Manual for a detailed example.
283 283
284.. _migration-2.6-systemd-configuration-now-split-out-to-system-conf: 284.. _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 ad8889ed25..3f95f8d702 100644
--- a/documentation/ref-manual/ref-devtool-reference.rst
+++ b/documentation/ref-manual/ref-devtool-reference.rst
@@ -352,7 +352,7 @@ particular recipe.
352 `maintainers.inc <http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc>`_ 352 `maintainers.inc <http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc>`_
353 file. 353 file.
354 354
355 - If the recipe is using the :ref:`bitbake:git-fetcher` 355 - If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)`
356 rather than a 356 rather than a
357 tarball, the commit hash points to the commit that matches the 357 tarball, the commit hash points to the commit that matches the
358 recipe's latest version tag. 358 recipe's latest version tag.
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index 9ef014139c..88b285d769 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -122,7 +122,7 @@ If the ``do_deploy`` task re-executes, any previous output is removed
122 122
123Fetches the source code. This task uses the 123Fetches the source code. This task uses the
124:term:`SRC_URI` variable and the argument's prefix to 124:term:`SRC_URI` variable and the argument's prefix to
125determine the correct :ref:`fetcher <bitbake:bb-fetchers>` 125determine the correct :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`
126module. 126module.
127 127
128.. _ref-tasks-image: 128.. _ref-tasks-image:
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index e552351e32..56aeb583ac 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -3062,7 +3062,7 @@ system and gives an overview of their function and contents.
3062 section in the Yocto Project Development Tasks Manual. 3062 section in the Yocto Project Development Tasks Manual.
3063 3063
3064 - Using ``IMAGE_INSTALL`` with the 3064 - Using ``IMAGE_INSTALL`` with the
3065 :ref:`+= <bitbake:appending-and-prepending>` 3065 :ref:`+= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:appending (+=) and prepending (=+) with spaces>`
3066 BitBake operator within the ``/conf/local.conf`` file or from 3066 BitBake operator within the ``/conf/local.conf`` file or from
3067 within an image recipe is not recommended. Use of this operator 3067 within an image recipe is not recommended. Use of this operator
3068 in these ways can cause ordering issues. Since 3068 in these ways can cause ordering issues. Since
@@ -7018,7 +7018,7 @@ system and gives an overview of their function and contents.
7018 protocols are highly dependent on particular BitBake Fetcher 7018 protocols are highly dependent on particular BitBake Fetcher
7019 submodules. Depending on the fetcher BitBake uses, various URL 7019 submodules. Depending on the fetcher BitBake uses, various URL
7020 parameters are employed. For specifics on the supported Fetchers, see 7020 parameters are employed. For specifics on the supported Fetchers, see
7021 the ":ref:`Fetchers <bitbake:bb-fetchers>`" section in the 7021 the ":ref:`Fetchers <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`" section in the
7022 BitBake User Manual. 7022 BitBake User Manual.
7023 7023
7024 - ``file://`` - Fetches files, which are usually files shipped 7024 - ``file://`` - Fetches files, which are usually files shipped
diff --git a/documentation/sdk-manual/sdk-extensible.rst b/documentation/sdk-manual/sdk-extensible.rst
index 1a17da4f6e..14ad23ba8f 100644
--- a/documentation/sdk-manual/sdk-extensible.rst
+++ b/documentation/sdk-manual/sdk-extensible.rst
@@ -627,7 +627,7 @@ specify source code revision and versioning schemes, extract code into
627or out of the ``devtool`` 627or out of the ``devtool``
628:ref:`devtool-the-workspace-layer-structure`, 628:ref:`devtool-the-workspace-layer-structure`,
629and work with any source file forms that the 629and work with any source file forms that the
630:ref:`fetchers <bitbake:bb-fetchers>` support. 630:ref:`fetchers <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` support.
631 631
632The following diagram shows the common development flow used with the 632The following diagram shows the common development flow used with the
633``devtool upgrade`` command: 633``devtool upgrade`` command: