diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-31 15:19:25 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:34 +0100 |
commit | 18df4a836845c6d7dec389a95623a472c19acdfe (patch) | |
tree | 212a82bf189f343b8d1f99e2a61a5c4df14a7619 /documentation/overview-manual/overview-manual-concepts.rst | |
parent | 28afbf81ecb34add93f5eed2c1a41ec5f278d0a7 (diff) | |
download | poky-18df4a836845c6d7dec389a95623a472c19acdfe.tar.gz |
sphinx: add links to terms in the BitBake glossary
Using the intersphinx extension, we can refer to terms in the Bitbake
manual using :term:`bitbake:FOO`. This patch implements that, mostly
using the following regexp:
line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_BB_URL;)?#var(-bb)?-\\1>`__",
":term:`bitbake:\\1`",
line)
And a handful of manual fixup.
(From yocto-docs rev: d2ed9117fffceb756c4a8f3cb6d39363a271d6d9)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual/overview-manual-concepts.rst')
-rw-r--r-- | documentation/overview-manual/overview-manual-concepts.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst index b49284911c..0986de6ea1 100644 --- a/documentation/overview-manual/overview-manual-concepts.rst +++ b/documentation/overview-manual/overview-manual-concepts.rst | |||
@@ -1288,10 +1288,10 @@ dependencies, such as the compiler, from the cache. | |||
1288 | 1288 | ||
1289 | The availability of objects in the sstate cache is handled by the | 1289 | The availability of objects in the sstate cache is handled by the |
1290 | function specified by the | 1290 | function specified by the |
1291 | ```BB_HASHCHECK_FUNCTION`` <&YOCTO_DOCS_BB_URL;#var-BB_HASHCHECK_FUNCTION>`__ | 1291 | :term:`bitbake:BB_HASHCHECK_FUNCTION` |
1292 | variable and returns a list of available objects. The function specified | 1292 | variable and returns a list of available objects. The function specified |
1293 | by the | 1293 | by the |
1294 | ```BB_SETSCENE_DEPVALID`` <&YOCTO_DOCS_BB_URL;#var-BB_SETSCENE_DEPVALID>`__ | 1294 | :term:`bitbake:BB_SETSCENE_DEPVALID` |
1295 | variable is the function that determines whether a given dependency | 1295 | variable is the function that determines whether a given dependency |
1296 | needs to be followed, and whether for any given relationship the | 1296 | needs to be followed, and whether for any given relationship the |
1297 | function needs to be passed. The function returns a True or False value. | 1297 | function needs to be passed. The function returns a True or False value. |
@@ -2171,7 +2171,7 @@ accomplished using fakeroot. | |||
2171 | 2171 | ||
2172 | 2172 | ||
2173 | For more information, see the | 2173 | For more information, see the |
2174 | ```FAKEROOT*`` <&YOCTO_DOCS_BB_URL;#var-FAKEROOT>`__ variables in the | 2174 | :term:`FAKEROOT* <bitbake:FAKEROOT>` variables in the |
2175 | BitBake User Manual. You can also reference the "`Why Not | 2175 | BitBake User Manual. You can also reference the "`Why Not |
2176 | Fakeroot? <https://github.com/wrpseudo/pseudo/wiki/WhyNotFakeroot>`__" | 2176 | Fakeroot? <https://github.com/wrpseudo/pseudo/wiki/WhyNotFakeroot>`__" |
2177 | article for background information on Fakeroot and Pseudo. | 2177 | article for background information on Fakeroot and Pseudo. |