aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-30 18:05:38 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-16 18:13:44 +0100
commite11d2dd1adbcb35b45d6d0f3a47f8d06caab0b49 (patch)
tree59e54eed899957a2b5d03f5625e62d36bea40911 /doc
parent57300955beb200c81762880f44f1a499451b7432 (diff)
downloadbitbake-e11d2dd1adbcb35b45d6d0f3a47f8d06caab0b49.tar.gz
sphinx: fix links inside notes
For some notes with links, the links were lost during the pandoc conversion. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-hello.rst9
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-metadata.rst18
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst4
3 files changed, 13 insertions, 18 deletions
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-hello.rst b/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
index 32d5b7bbc..5edf97eaa 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
@@ -79,8 +79,8 @@ discussion mailing list about the BitBake build tool.
.. note::
This example was inspired by and drew heavily from
- Mailing List post - The BitBake equivalent of "Hello, World!"
- .
+ `Mailing List post - The BitBake equivalent of "Hello, World!"
+ <http://www.mail-archive.com/yocto@yoctoproject.org/msg09379.html>`_.
As stated earlier, the goal of this example is to eventually compile
"Hello World". However, it is unknown what BitBake needs and what you
@@ -277,9 +277,8 @@ Following is the complete "Hello World" example.
.. note::
- You can find additional information on layers in the "
- Layers
- " section.
+ You can find additional information on layers in the
+ ":ref:`bitbake-user-manual/bitbake-user-manual-intro:Layers`" section.
Minimally, you need a recipe file and a layer configuration file in
your layer. The configuration file needs to be in the ``conf``
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
index cea8d5ba2..c0eb118eb 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -639,7 +639,7 @@ definitions: include test_defs.inc
directive does not produce an error when the file cannot be found.
Consequently, it is recommended that if the file you are including is
expected to exist, you should use
- require
+ :ref:`require <require-inclusion>`
instead of
include
. Doing so makes sure that an error is produced if the file cannot be
@@ -756,9 +756,7 @@ recipename do_foo: fourth
.. note::
Overrides and override-style operators can be applied to any shell
- function, not just
- tasks
- .
+ function, not just :ref:`tasks <bitbake-user-manual/bitbake-user-manual-metadata:Tasks>`.
You can use the ``bitbake -e`` recipename command to view the final
assembled function after all overrides have been applied.
@@ -1009,9 +1007,7 @@ Additionally, the ``do_printdate`` task becomes dependent upon the
after that initial run. If you want to force the task to always be
rerun for experimentation purposes, you can make BitBake always
consider the task "out-of-date" by using the
- [
- nostamp
- ]
+ :ref:`[nostamp] <bitbake-user-manual/bitbake-user-manual-metadata:Variable Flags>`
variable flag, as follows:
::
@@ -1082,7 +1078,7 @@ the build machine cannot influence the build.
things exported or listed in its whitelist to ensure that the build
environment is reproducible and consistent. You can prevent this
"cleaning" by setting the
- BB_PRESERVE_ENV
+ :term:`BB_PRESERVE_ENV`
variable.
Consequently, if you do want something to get passed into the build task
@@ -1397,11 +1393,11 @@ incarnations are buildable. These features are enabled through the
The mechanism for this class extension is extremely specific to the
implementation. Usually, the recipe's
- PROVIDES
+ :term:`PROVIDES`
,
- PN
+ :term:`PN`
, and
- DEPENDS
+ :term:`DEPENDS`
variables would need to be modified by the extension class. For
specific examples, see the OE-Core
native
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index f81c01c06..d5c07e4aa 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -484,7 +484,7 @@ overview of their function and contents.
.. note::
This variable works similarly to the
- BB_TASK_NICE_LEVEL
+ :term:`BB_TASK_NICE_LEVEL`
variable except with a task's I/O priorities.
Set the variable as follows: BB_TASK_IONICE_LEVEL = "class.prio" For
@@ -764,7 +764,7 @@ overview of their function and contents.
The bias provided by
DEFAULT_PREFERENCE
is weak and is overridden by
- BBFILE_PRIORITY
+ :term:`BBFILE_PRIORITY`
if that variable is different between two layers that contain
different versions of the same recipe.