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

@@ -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: