From 63710fc913a39f0037c1f6604bf46446af26f86d Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Fri, 20 Nov 2020 08:50:38 +0100 Subject: 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 Signed-off-by: Richard Purdie --- documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst | 2 +- documentation/dev-manual/dev-manual-common-tasks.rst | 4 ++-- documentation/kernel-dev/kernel-dev-advanced.rst | 2 +- documentation/overview-manual/overview-manual-concepts.rst | 6 +++--- documentation/ref-manual/migration-2.3.rst | 2 +- documentation/ref-manual/migration-2.6.rst | 2 +- documentation/ref-manual/ref-devtool-reference.rst | 2 +- documentation/ref-manual/ref-tasks.rst | 2 +- documentation/ref-manual/ref-variables.rst | 4 ++-- documentation/sdk-manual/sdk-extensible.rst | 2 +- 10 files changed, 14 insertions(+), 14 deletions(-) (limited to 'documentation') 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. For information on using the ``bitbake`` command, see the :ref:`usingpoky-components-bitbake` section in the Yocto Project Overview and Concepts Manual, or see the ":ref:`BitBake Command - `" section in the BitBake User Manual. + `" section in the BitBake User Manual. #. **Simulate Your Image Using QEMU:** Once this particular image is 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. The :ref:`ref-tasks-fetch` task uses the prefix of each entry in the ``SRC_URI`` variable value to determine -which :ref:`fetcher ` to use to get your +which :ref:`fetcher ` to use to get your source files. It is the ``SRC_URI`` variable that triggers the fetcher. The :ref:`ref-tasks-patch` task uses the variable after source is fetched to apply patches. The OpenEmbedded @@ -7567,7 +7567,7 @@ Creating Node Package Manager (NPM) Packages `NPM `__ is a package manager for the JavaScript programming language. The Yocto Project -supports the NPM :ref:`fetcher `. You can +supports the NPM :ref:`fetcher `. You can use this fetcher in combination with :doc:`devtool <../ref-manual/ref-devtool-reference>` to create recipes 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 variable in the kernel recipe selects the kernel type. For example, in the ``linux-yocto_4.12.bb`` kernel recipe found in ``poky/meta/recipes-kernel/linux``, a -:ref:`require ` directive +:ref:`require ` directive includes the ``poky/meta/recipes-kernel/linux/linux-yocto.inc`` file, which has the following statement that defines the default kernel type: :: 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 selected by the distribution configuration. You can get more details about how BitBake chooses between different target versions and providers in the -":ref:`Preferences `" section +":ref:`Preferences `" section of the BitBake User Manual. BitBake also tries to execute any dependent tasks first. So for example, @@ -607,7 +607,7 @@ Source Control Managers (Optional) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Another place from which the build system can get source files is with -:ref:`fetchers ` employing various Source +:ref:`fetchers ` employing various Source Control Managers (SCMs) such as Git or Subversion. In such cases, a repository is cloned or checked out. The :ref:`ref-tasks-fetch` task inside @@ -1949,7 +1949,7 @@ The following list explains the previous example: extra metadata to the `stamp file <#stamp-files-and-the-rerunning-of-tasks>`__. In this case, the metadata makes the task specific to a machine's architecture. See - ":ref:`bitbake:ref-bitbake-tasklist`" + ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:the task list`" section in the BitBake User Manual for more information on the ``stamp-extra-info`` flag. 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: fetcher passes the new parameter through the ``SVN_SSH`` environment variable during the :ref:`ref-tasks-fetch` task. - See the ":ref:`bitbake:svn-fetcher`" + See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:subversion (svn) fetcher (\`\`svn://\`\`)`" section in the BitBake User Manual for additional information. 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: specifying list items to remove, be aware that leading and trailing whitespace resulting from the removal is retained. - See the ":ref:`bitbake:removing-override-style-syntax`" + See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`" section in the BitBake User Manual for a detailed example. .. _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. `maintainers.inc `_ file. - - If the recipe is using the :ref:`bitbake:git-fetcher` + - If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)` rather than a tarball, the commit hash points to the commit that matches the 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 Fetches the source code. This task uses the :term:`SRC_URI` variable and the argument's prefix to -determine the correct :ref:`fetcher ` +determine the correct :ref:`fetcher ` module. .. _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. section in the Yocto Project Development Tasks Manual. - Using ``IMAGE_INSTALL`` with the - :ref:`+= ` + :ref:`+= ` BitBake operator within the ``/conf/local.conf`` file or from within an image recipe is not recommended. Use of this operator in these ways can cause ordering issues. Since @@ -7018,7 +7018,7 @@ system and gives an overview of their function and contents. protocols are highly dependent on particular BitBake Fetcher submodules. Depending on the fetcher BitBake uses, various URL parameters are employed. For specifics on the supported Fetchers, see - the ":ref:`Fetchers `" section in the + the ":ref:`Fetchers `" section in the BitBake User Manual. - ``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 or out of the ``devtool`` :ref:`devtool-the-workspace-layer-structure`, and work with any source file forms that the -:ref:`fetchers ` support. +:ref:`fetchers ` support. The following diagram shows the common development flow used with the ``devtool upgrade`` command: -- cgit v1.2.3-54-g00ecf