summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-07-27 18:37:35 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-07-30 22:49:15 +0100
commitd664794cce1605e046d45a3cb64f5e019a0b2e5a (patch)
treea0c85bac9ff98494a49a2a6bada03357e518081b
parent38496093d7e70145a054505f6d2f28ff7b270117 (diff)
downloadpoky-d664794cce1605e046d45a3cb64f5e019a0b2e5a.tar.gz
manuals: remove explicit BitBake variable references
The standard :term:`VARIABLE` will refer to the description of the variable in the YP variable index. If it doesn't exist, it will refer to the description of the variable in the BitBake manual. (From yocto-docs rev: 34cb466caf872f9284eb81f6a5f31ad606214dee) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/common-tasks.rst6
-rw-r--r--documentation/migration-guides/migration-3.0.rst2
-rw-r--r--documentation/overview-manual/concepts.rst6
-rw-r--r--documentation/ref-manual/variables.rst5
4 files changed, 8 insertions, 11 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index c4b12c0a7e..9a6f4e1a8e 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -4384,7 +4384,7 @@ directory:
4384 variable, inherit the 4384 variable, inherit the
4385 :ref:`own-mirrors <ref-classes-own-mirrors>` 4385 :ref:`own-mirrors <ref-classes-own-mirrors>`
4386 class, and use the 4386 class, and use the
4387 :term:`bitbake:BB_NO_NETWORK` 4387 :term:`BB_NO_NETWORK`
4388 variable to your ``local.conf``. 4388 variable to your ``local.conf``.
4389 :: 4389 ::
4390 4390
@@ -4457,7 +4457,7 @@ variable for more information:
4457- :term:`BB_NUMBER_THREADS`: 4457- :term:`BB_NUMBER_THREADS`:
4458 The maximum number of threads BitBake simultaneously executes. 4458 The maximum number of threads BitBake simultaneously executes.
4459 4459
4460- :term:`bitbake:BB_NUMBER_PARSE_THREADS`: 4460- :term:`BB_NUMBER_PARSE_THREADS`:
4461 The number of threads BitBake uses during parsing. 4461 The number of threads BitBake uses during parsing.
4462 4462
4463- :term:`PARALLEL_MAKE`: Extra 4463- :term:`PARALLEL_MAKE`: Extra
@@ -9121,7 +9121,7 @@ BitBake has determined by doing the following:
9121 9121
9122 The output of ``bitbake-dumpsig`` also includes the value each 9122 The output of ``bitbake-dumpsig`` also includes the value each
9123 variable had, a list of dependencies for each variable, and 9123 variable had, a list of dependencies for each variable, and
9124 :term:`bitbake:BB_HASHBASE_WHITELIST` 9124 :term:`BB_HASHBASE_WHITELIST`
9125 information. 9125 information.
9126 9126
9127There is also a ``bitbake-diffsigs`` command for comparing two 9127There is also a ``bitbake-diffsigs`` command for comparing two
diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst
index 20c7026e8d..9a5f5714bd 100644
--- a/documentation/migration-guides/migration-3.0.rst
+++ b/documentation/migration-guides/migration-3.0.rst
@@ -194,7 +194,7 @@ The following BitBake changes have occurred.
194 scripts that handles these two events need to be updated. 194 scripts that handles these two events need to be updated.
195 195
196- The arguments passed to functions used with 196- The arguments passed to functions used with
197 :term:`bitbake:BB_HASHCHECK_FUNCTION` 197 :term:`BB_HASHCHECK_FUNCTION`
198 have changed. If you are using your own custom hash check function, 198 have changed. If you are using your own custom hash check function,
199 see :yocto_git:`/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725` 199 see :yocto_git:`/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725`
200 for details. 200 for details.
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 6377ebc000..4f8e6cb041 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -1250,11 +1250,9 @@ download or setscene task fails, the build system then tries to install
1250dependencies, such as the compiler, from the cache. 1250dependencies, such as the compiler, from the cache.
1251 1251
1252The availability of objects in the sstate cache is handled by the 1252The availability of objects in the sstate cache is handled by the
1253function specified by the 1253function specified by the :term:`BB_HASHCHECK_FUNCTION`
1254:term:`bitbake:BB_HASHCHECK_FUNCTION`
1255variable and returns a list of available objects. The function specified 1254variable and returns a list of available objects. The function specified
1256by the 1255by the :term:`BB_SETSCENE_DEPVALID`
1257:term:`bitbake:BB_SETSCENE_DEPVALID`
1258variable is the function that determines whether a given dependency 1256variable is the function that determines whether a given dependency
1259needs to be followed, and whether for any given relationship the 1257needs to be followed, and whether for any given relationship the
1260function needs to be passed. The function returns a True or False value. 1258function needs to be passed. The function returns a True or False value.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 55121f2c5a..b61de1993d 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -762,8 +762,7 @@ system and gives an overview of their function and contents.
762 762
763 export BBSERVER=localhost:$port 763 export BBSERVER=localhost:$port
764 764
765 By default, :term:`BBSERVER` also appears in 765 By default, :term:`BBSERVER` also appears in :term:`BB_HASHBASE_WHITELIST`.
766 :term:`bitbake:BB_HASHBASE_WHITELIST`.
767 Consequently, :term:`BBSERVER` is excluded from checksum and dependency 766 Consequently, :term:`BBSERVER` is excluded from checksum and dependency
768 data. 767 data.
769 768
@@ -6500,7 +6499,7 @@ system and gives an overview of their function and contents.
6500 6499
6501 - :term:`CONF_VERSION` 6500 - :term:`CONF_VERSION`
6502 - :term:`BB_NUMBER_THREADS` 6501 - :term:`BB_NUMBER_THREADS`
6503 - :term:`bitbake:BB_NUMBER_PARSE_THREADS` 6502 - :term:`BB_NUMBER_PARSE_THREADS`
6504 - :term:`PARALLEL_MAKE` 6503 - :term:`PARALLEL_MAKE`
6505 - :term:`PRSERV_HOST` 6504 - :term:`PRSERV_HOST`
6506 - :term:`SSTATE_MIRRORS` :term:`DL_DIR` 6505 - :term:`SSTATE_MIRRORS` :term:`DL_DIR`