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>
This commit is contained in:
Nicolas Dechesne
2020-07-31 17:58:42 +02:00
committed by Richard Purdie
parent 18df4a8368
commit f3e7db78ad
14 changed files with 67 additions and 71 deletions

View File

@@ -204,8 +204,7 @@ an entire Linux distribution, including the toolchain, from source.
command, see the
"`BitBake <&YOCTO_DOCS_OM_URL;#usingpoky-components-bitbake>`__"
section in the Yocto Project Overview and Concepts Manual, or see the
"`BitBake
Command <&YOCTO_DOCS_BB_URL;#bitbake-user-manual-command>`__" section
":ref:`BitBake Command <bitbake:bitbake-user-manual-command>`" section
in the BitBake User Manual.
4. *Simulate Your Image Using QEMU:* Once this particular image is

View File

@@ -789,8 +789,8 @@ workflow.
7. *Build the Image:* The OpenEmbedded build system uses the BitBake
tool to build images based on the type of image you want to create.
You can find more information about BitBake in the `BitBake User
Manual <&YOCTO_DOCS_BB_URL;>`__.
You can find more information about BitBake in the
:doc:`BitBake User Manual <bitbake:index>`.
The build process supports several types of images to satisfy
different needs. See the

View File

@@ -1163,7 +1163,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 `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ to use to get your
which :ref:`fetcher <bitbake:bb-fetchers>` 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
@@ -2302,10 +2302,10 @@ doing the following:
If ``${S}`` might contain a Makefile, or if you inherit some class
that replaces ``do_configure`` and ``do_compile`` with custom
versions, then you can use the
``[``\ ```noexec`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]``
``[``\ :ref:`noexec <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
flag to turn the tasks into no-ops, as follows: do_configure[noexec]
= "1" do_compile[noexec] = "1" Unlike
```deleting the tasks`` <&YOCTO_DOCS_BB_URL;#deleting-a-task>`__,
:ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:deleting a task`,
using the flag preserves the dependency chain from the
:ref:`ref-tasks-fetch`,
:ref:`ref-tasks-unpack`, and
@@ -2341,8 +2341,8 @@ Recipe Syntax
Understanding recipe file syntax is important for writing recipes. The
following list overviews the basic items that make up a BitBake recipe
file. For more complete BitBake syntax descriptions, see the "`Syntax
and Operators <&YOCTO_DOCS_BB_URL;#bitbake-user-manual-metadata>`__"
file. For more complete BitBake syntax descriptions, see the
":doc:`bitbake-user-manual/bitbake-user-manual-metadata`"
chapter of the BitBake User Manual.
- *Variable Assignments and Manipulations:* Variable assignments allow
@@ -2385,8 +2385,8 @@ chapter of the BitBake User Manual.
This next list summarizes the most important and most commonly used
parts of the recipe syntax. For more information on these parts of the
syntax, you can reference the `Syntax and
Operators <&YOCTO_DOCS_BB_URL;#bitbake-user-manual-metadata>`__ chapter
syntax, you can reference the
:doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata` chapter
in the BitBake User Manual.
- *Line Continuation (\):* Use the backward slash (``\``) character to
@@ -6661,7 +6661,7 @@ Creating Node Package Manager (NPM) Packages
`NPM <https://en.wikipedia.org/wiki/Npm_(software)>`__ is a package
manager for the JavaScript programming language. The Yocto Project
supports the NPM `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__. You can
supports the NPM :ref:`fetcher <bitbake:bb-fetchers>`. You can
use this fetcher in combination with
```devtool`` <&YOCTO_DOCS_REF_URL;#ref-devtool-reference>`__ to create
recipes that produce NPM packages.
@@ -8239,9 +8239,9 @@ Viewing Variable Values
Sometimes you need to know the value of a variable as a result of
BitBake's parsing step. This could be because some unexpected behavior
occurred in your project. Perhaps an attempt to `modify a
variable <&YOCTO_DOCS_BB_URL;#modifying-existing-variables>`__ did not
work out as expected.
occurred in your project. Perhaps an attempt to :ref:`modify a variable
<bitbake:bitbake-user-manual/bitbake-user-manual-metadata:modifying existing
variables>` did not work out as expected.
BitBake's ``-e`` option is used to display variable values after
parsing. The following command displays the variable values after the
@@ -8404,15 +8404,15 @@ dependencies for the recipes involved in building recipename.
Viewing Task Variable Dependencies
----------------------------------
As mentioned in the "`Checksums
(Signatures) <&YOCTO_DOCS_BB_URL;#checksums>`__" section of the BitBake
As mentioned in the
":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:checksums (signatures)`" section of the BitBake
User Manual, BitBake tries to automatically determine what variables a
task depends on so that it can rerun the task if any values of the
variables change. This determination is usually reliable. However, if
you do things like construct variable names at runtime, then you might
have to manually declare dependencies on those variables using
``vardeps`` as described in the "`Variable
Flags <&YOCTO_DOCS_BB_URL;#variable-flags>`__" section of the BitBake
``vardeps`` as described in the
":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" section of the BitBake
User Manual.
If you are unsure whether a variable dependency is being picked up
@@ -8691,7 +8691,7 @@ log to ``${T}/log.do_``\ task, and can also log to standard output
- ``bb.debug(``\ level\ ``, ``\ msg\ ``)``: Writes "DEBUG: msg" to the
log. Also logs to stdout if the log level is greater than or equal to
level. See the "`-D <&YOCTO_DOCS_BB_URL;#usage-and-syntax>`__" option
level. See the ":ref:`-D <bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax>`" option
in the BitBake User Manual for more information.
- ``bb.warn(``\ msg\ ``)``: Writes "WARNING: msg" to the log while also

View File

@@ -316,7 +316,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
```require`` <&YOCTO_DOCS_BB_URL;#require-inclusion>`__ directive
:ref:`require <bitbake:require-inclusion>` directive
includes the ``poky/meta/recipes-kernel/linux/linux-yocto.inc`` file,
which has the following statement that defines the default kernel type:
LINUX_KERNEL_TYPE ??= "standard"

View File

@@ -54,7 +54,7 @@ for parsing the :term:`Metadata`, generating
a list of tasks from it, and then executing those tasks.
This section briefly introduces BitBake. If you want more information on
BitBake, see the `BitBake User Manual <&YOCTO_DOCS_BB_URL;>`__.
BitBake, see the :doc:`BitBake User Manual <bitbake:index>`.
To see a list of the options BitBake supports, use either of the
following commands: $ bitbake -h $ bitbake --help
@@ -69,7 +69,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
"`Preferences <&YOCTO_DOCS_BB_URL;#bb-bitbake-preferences>`__" section
":ref:`Preferences <bitbake:bb-bitbake-preferences>`" section
of the BitBake User Manual.
BitBake also tries to execute any dependent tasks first. So for example,
@@ -361,8 +361,8 @@ environment. It is important to understand that the
:term:`OpenEmbedded Build System` reads the
configuration files in a specific order: ``site.conf``, ``auto.conf``,
and ``local.conf``. And, the build system applies the normal assignment
statement rules as described in the "`Syntax and
Operators <&YOCTO_DOCS_BB_URL;#bitbake-user-manual-metadata>`__" chapter
statement rules as described in the
":doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata`" chapter
of the BitBake User Manual. Because the files are parsed in a specific
order, variable assignments for the same variable could be affected. For
example, if the ``auto.conf`` file and the ``local.conf`` set variable1
@@ -599,7 +599,7 @@ Source Control Managers (Optional)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Another place from which the build system can get source files is with
`fetchers <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ employing various Source
:ref:`fetchers <bitbake:bb-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
@@ -1212,7 +1212,7 @@ Since ``STAMPS_DIR`` is usually a subdirectory of ``TMPDIR``, removing
properly be rerun to repopulate ``TMPDIR``.
If you want some task to always be considered "out of date", you can
mark it with the ```nostamp`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__
mark it with the :ref:`nostamp <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`
varflag. If some other task depends on such a task, then that task will
also always be considered out of date, which might not be what you want.
@@ -1913,14 +1913,14 @@ do_deploy[dirs] = "${DEPLOYDIR} ${B}" do_deploy[stamp-extra-info] =
through the shared state cache if possible. If the task was
accelerated, ``sstate_setscene()`` returns True. Otherwise, it
returns False, and the normal ``do_deploy`` task runs. For more
information, see the "`setscene <&YOCTO_DOCS_BB_URL;#setscene>`__"
information, see the ":ref:`setscene <bitbake:bitbake-user-manual/bitbake-user-manual-execution:setscene>`"
section in the BitBake User Manual.
- The ``do_deploy[dirs] = "${DEPLOYDIR} ${B}"`` line creates
``${DEPLOYDIR}`` and ``${B}`` before the ``do_deploy`` task runs, and
also sets the current working directory of ``do_deploy`` to ``${B}``.
For more information, see the "`Variable
Flags <&YOCTO_DOCS_BB_URL;#variable-flags>`__" section in the BitBake
For more information, see the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags`"
section in the BitBake
User Manual.
.. note::
@@ -1947,7 +1947,7 @@ do_deploy[dirs] = "${DEPLOYDIR} ${B}" do_deploy[stamp-extra-info] =
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
"`The Task List <&YOCTO_DOCS_BB_URL;#ref-bitbake-tasklist>`__"
":ref:`bitbake:ref-bitbake-tasklist`"
section in the BitBake User Manual for more information on the
``stamp-extra-info`` flag.
@@ -2106,7 +2106,7 @@ dependencies, you must manually declare the dependencies.
The ``do_package`` task depends on the ``do_packagedata`` task of each
recipe in :term:`DEPENDS` through use
of a ``[``\ ```deptask`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]``
of a ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
declaration, which guarantees that the required
shared-library/module-to-package mapping information will be available
when needed as long as ``DEPENDS`` has been correctly set.

View File

@@ -474,8 +474,8 @@ The following list consists of components associated with the
is a build engine that works through recipes written in a specific
format in order to perform sets of tasks.
You can learn more about BitBake in the `BitBake User
Manual <&YOCTO_DOCS_BB_URL;>`__.
You can learn more about BitBake in the :doc:`BitBake User
Manual <bitbake:index>`.
- *OpenEmbedded-Core:* OpenEmbedded-Core (OE-Core) is a common layer of
metadata (i.e. recipes, classes, and associated files) used by
@@ -779,8 +779,8 @@ additional tasks as well as task prerequisites. Recipe syntax through
BitBake also supports both ``_prepend`` and ``_append`` operators as a
method of extending task functionality. These operators inject code into
the beginning or end of a task. For information on these BitBake
operators, see the "`Appending and Prepending (Override Style
Syntax) <&YOCTO_DOCS_BB_URL;#appending-and-prepending-override-style-syntax>`__"
operators, see the
":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:appending and prepending (override style syntax)`"
section in the BitBake User's Manual.
.. _openembedded-build-system-workflow:

View File

@@ -2452,7 +2452,7 @@ compared to uClibc.
``${``\ :term:`B`\ ``}`` is no longer the default working
directory for tasks. Consequently, any custom tasks you define now need
to either have the
``[``\ ```dirs`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` flag
``[``\ :ref:`dirs <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` flag
set, or the task needs to change into the appropriate working directory
manually (e.g using ``cd`` for a shell task).
@@ -2942,8 +2942,8 @@ 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 "`Subversion (SVN) Fetcher
(svn://) <&YOCTO_DOCS_BB_URL;#svn-fetcher>`__" section in the BitBake
See the ":ref:`bitbake:svn-fetcher`"
section in the BitBake
User Manual for additional information.
- *``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2``
@@ -3546,7 +3546,7 @@ The following are additional changes:
- BitBake fires multiple "BuildStarted" events when multiconfig is
enabled (one per configuration). For more information, see the
"`Events <&YOCTO_DOCS_BB_URL;#events>`__" section in the BitBake User
":ref:`Events <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:events>`" section in the BitBake User
Manual.
- By default, the ``security_flags.inc`` file sets a
@@ -4143,8 +4143,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 "`Removal (Override Style
Syntax) <&YOCTO_DOCS_BB_URL;#removing-override-style-syntax>`__"
See the ":ref:`bitbake:removing-override-style-syntax`"
section in the BitBake User Manual for a detailed example.
.. _migration-2.6-systemd-configuration-now-split-out-to-system-conf:

View File

@@ -290,8 +290,8 @@ particular recipe.
```maintainers.inc`http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc
file.
- If the recipe is using the `Git
fetcher <&YOCTO_DOCS_BB_URL;#git-fetcher>`__ rather than a
- If the recipe is using the :ref:`bitbake:git-fetcher`
rather than a
tarball, the commit hash points to the commit that matches the
recipe's latest version tag.

View File

@@ -46,8 +46,8 @@ environment setup script (i.e. ````` <#structure-core-script>`__) places
the ``scripts/`` and ``bitbake/bin/`` directories (in that order) into
the shell's ``PATH`` environment variable.
For more information on BitBake, see the `BitBake User
Manual <&YOCTO_DOCS_BB_URL;>`__.
For more information on BitBake, see the :doc:`BitBake User Manual
<bitbake:index>`.
.. _structure-core-build:

View File

@@ -14,8 +14,8 @@ Normal Recipe Build Tasks
The following sections describe normal tasks associated with building a
recipe. For more information on tasks and dependencies, see the
"`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and
"`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the
":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and
":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the
BitBake User Manual.
.. _ref-tasks-build:
@@ -125,7 +125,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 `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__
determine the correct :ref:`fetcher <bitbake:bb-fetchers>`
module.
.. _ref-tasks-image:

View File

@@ -47,8 +47,8 @@ universal, the list includes them just in case:
BitBake
The task executor and scheduler used by the OpenEmbedded build system to
build images. For more information on BitBake, see the `BitBake User
Manual <&YOCTO_DOCS_BB_URL;>`__.
build images. For more information on BitBake, see the :doc:`BitBake User
Manual <bitbake:index>`.
Board Support Package (BSP)
A group of drivers, definitions, and other components that provide support

View File

@@ -239,8 +239,8 @@ system and gives an overview of their function and contents.
To add a tune to the list, be sure to append it with spaces using the
"+=" BitBake operator. Do not simply replace the list by using the
"=" operator. See the "`Basic
Syntax <&YOCTO_DOCS_BB_URL;#basic-syntax>`__" section in the BitBake
"=" operator. See the
":ref:`Basic Syntax <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax>`" section in the BitBake
User Manual for more information.
B
@@ -1477,7 +1477,7 @@ system and gives an overview of their function and contents.
This mechanism is implemented by having ``do_configure`` depend on
the :ref:`ref-tasks-populate_sysroot` task of
each recipe listed in ``DEPENDS``, through a
``[``\ ```deptask`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]``
``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
declaration in the :ref:`base <ref-classes-base>` class.
.. note::
@@ -1524,8 +1524,8 @@ system and gives an overview of their function and contents.
For information on runtime dependencies, see the
:term:`RDEPENDS` variable. You can also see the
"`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and
"`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the
":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and
":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the
BitBake User Manual for additional information on tasks and
dependencies.
@@ -2270,8 +2270,8 @@ system and gives an overview of their function and contents.
:term:`FILESPATH` variable. For an example of how
that works, see the :term:`FILESPATH` variable
description. Additionally, you find more information on how overrides
are handled in the "`Conditional Syntax
(Overrides) <&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides>`__"
are handled in the
":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
section of the BitBake User Manual.
By default, the ``FILESOVERRIDES`` variable is defined as:
@@ -2789,13 +2789,13 @@ system and gives an overview of their function and contents.
section in the Yocto Project Development Tasks Manual.
- Using ``IMAGE_INSTALL`` with the
```+=`` <&YOCTO_DOCS_BB_URL;#appending-and-prepending>`__
:ref:`+= <bitbake:appending-and-prepending>`
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
``core-image.bbclass`` sets ``IMAGE_INSTALL`` to a default
value using the
```?=`` <&YOCTO_DOCS_BB_URL;#setting-a-default-value>`__
:ref:`?= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:setting a default value (?=)>`
operator, using a ``+=`` operation against ``IMAGE_INSTALL``
results in unexpected behavior when used within
``conf/local.conf``. Furthermore, the same operation from
@@ -3078,9 +3078,8 @@ system and gives an overview of their function and contents.
configuration and in each individual recipe. The OpenEmbedded build
system ignores changes to ``INHERIT`` in individual recipes.
For more information on ``INHERIT``, see the "```INHERIT``
Configuration
Directive <&YOCTO_DOCS_BB_URL;#inherit-configuration-directive>`__"
For more information on ``INHERIT``, see the
:ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`"
section in the Bitbake User Manual.
INHERIT_DISTRO
@@ -4415,9 +4414,8 @@ system and gives an overview of their function and contents.
As an example, if the string "an-override" appears as an element in
the colon-separated list in ``OVERRIDES``, then the following
assignment will override ``FOO`` with the value "overridden" at the
end of parsing: FOO_an-override = "overridden" See the "`Conditional
Syntax
(Overrides) <&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides>`__"
end of parsing: FOO_an-override = "overridden" See the
":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
section in the BitBake User Manual for more information on the
overrides mechanism.
@@ -5502,8 +5500,8 @@ system and gives an overview of their function and contents.
For information on build-time dependencies, see the
:term:`DEPENDS` variable. You can also see the
"`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and
"`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the
":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and
":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the
BitBake User Manual for additional information on tasks and
dependencies.
@@ -6254,7 +6252,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 "`Fetchers <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__" section in the
the ":ref:`Fetchers <bitbake:bb-fetchers>`" section in the
BitBake User Manual.
- *``file://`` -* Fetches files, which are usually files shipped

View File

@@ -123,7 +123,7 @@ Here is a list of resources you might find helpful:
- `BitBake <http://www.openembedded.org/wiki/BitBake>`__\ *:* The tool
used to process metadata.
- `BitBake User Manual <&YOCTO_DOCS_BB_URL;>`__\ *:* A comprehensive
- :doc:`BitBake User Manual <bitbake:index>`\ *:* A comprehensive
guide to the BitBake tool. If you want information on BitBake, see
this manual.

View File

@@ -577,7 +577,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
`fetchers <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ support.
:ref:`fetchers <bitbake:bb-fetchers>` support.
The following diagram shows the common development flow used with the
``devtool upgrade`` command: