mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-31 12:49:46 +00:00
Code Issues Projects Releases Wiki Activity

sphinx: add links to section in the Bitbake manual

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/migration.rst
+5 -6
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:
documentation/ref-manual/ref-devtool-reference.rst
+2 -2
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.
documentation/ref-manual/ref-structure.rst
+2 -2
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:
documentation/ref-manual/ref-tasks.rst
+3 -3
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:
documentation/ref-manual/ref-terms.rst
+2 -2
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
documentation/ref-manual/ref-variables.rst
+16 -18
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
documentation/ref-manual/resources.rst
+1 -1
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.