summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-31 15:19:25 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:34 +0100
commit18df4a836845c6d7dec389a95623a472c19acdfe (patch)
tree212a82bf189f343b8d1f99e2a61a5c4df14a7619 /documentation/ref-manual
parent28afbf81ecb34add93f5eed2c1a41ec5f278d0a7 (diff)
downloadpoky-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/ref-manual')
-rw-r--r--documentation/ref-manual/migration.rst4
-rw-r--r--documentation/ref-manual/ref-variables.rst4
2 files changed, 4 insertions, 4 deletions
diff --git a/documentation/ref-manual/migration.rst b/documentation/ref-manual/migration.rst
index a678580978..9e821c5dd3 100644
--- a/documentation/ref-manual/migration.rst
+++ b/documentation/ref-manual/migration.rst
@@ -4677,7 +4677,7 @@ The following BitBake changes have occurred.
4677 ``bb.build.exec_func()`` in custom classes or scripts. 4677 ``bb.build.exec_func()`` in custom classes or scripts.
4678 4678
4679- The 4679- The
4680 ```BB_SETSCENE_VERIFY_FUNCTION2`` <&YOCTO_DOCS_BB_URL;#var-bb-BB_SETSCENE_VERIFY_FUNCTION2>`__ 4680 :term:`bitbake:BB_SETSCENE_VERIFY_FUNCTION2`
4681 is no longer used. In the unlikely event that you have any references 4681 is no longer used. In the unlikely event that you have any references
4682 to it, they should be removed. 4682 to it, they should be removed.
4683 4683
@@ -4687,7 +4687,7 @@ The following BitBake changes have occurred.
4687 scripts that handles these two events need to be updated. 4687 scripts that handles these two events need to be updated.
4688 4688
4689- The arguments passed to functions used with 4689- The arguments passed to functions used with
4690 ```BB_HASHCHECK_FUNCTION`` <&YOCTO_DOCS_BB_URL;#var-bb-BB_HASHCHECK_FUNCTION>`__ 4690 :term:`bitbake:BB_HASHCHECK_FUNCTION`
4691 have changed. If you are using your own custom hash check function, 4691 have changed. If you are using your own custom hash check function,
4692 see 4692 see
4693 http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725 4693 http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 205a060103..6f70787cbb 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -665,7 +665,7 @@ system and gives an overview of their function and contents.
665 environment: export BBSERVER=localhost:$port 665 environment: export BBSERVER=localhost:$port
666 666
667 By default, ``BBSERVER`` also appears in 667 By default, ``BBSERVER`` also appears in
668 ```BB_HASHBASE_WHITELIST`` <&YOCTO_DOCS_BB_URL;#var-BB_HASHBASE_WHITELIST>`__. 668 :term:`bitbake:BB_HASHBASE_WHITELIST`.
669 Consequently, ``BBSERVER`` is excluded from checksum and dependency 669 Consequently, ``BBSERVER`` is excluded from checksum and dependency
670 data. 670 data.
671 671
@@ -5829,7 +5829,7 @@ system and gives an overview of their function and contents.
5829 excludes the following variables: 5829 excludes the following variables:
5830 :term:`CONF_VERSION` 5830 :term:`CONF_VERSION`
5831 :term:`BB_NUMBER_THREADS` 5831 :term:`BB_NUMBER_THREADS`
5832 `BB_NUMBER_PARSE_THREADS <&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS>`__ 5832 :term:`bitbake:BB_NUMBER_PARSE_THREADS`
5833 :term:`PARALLEL_MAKE` 5833 :term:`PARALLEL_MAKE`
5834 :term:`PRSERV_HOST` 5834 :term:`PRSERV_HOST`
5835 :term:`SSTATE_MIRRORS` :term:`DL_DIR` 5835 :term:`SSTATE_MIRRORS` :term:`DL_DIR`