From 18df4a836845c6d7dec389a95623a472c19acdfe Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Fri, 31 Jul 2020 15:19:25 +0200 Subject: 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 Signed-off-by: Richard Purdie --- documentation/ref-manual/migration.rst | 4 ++-- documentation/ref-manual/ref-variables.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'documentation/ref-manual') 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. ``bb.build.exec_func()`` in custom classes or scripts. - The - ```BB_SETSCENE_VERIFY_FUNCTION2`` <&YOCTO_DOCS_BB_URL;#var-bb-BB_SETSCENE_VERIFY_FUNCTION2>`__ + :term:`bitbake:BB_SETSCENE_VERIFY_FUNCTION2` is no longer used. In the unlikely event that you have any references to it, they should be removed. @@ -4687,7 +4687,7 @@ The following BitBake changes have occurred. scripts that handles these two events need to be updated. - The arguments passed to functions used with - ```BB_HASHCHECK_FUNCTION`` <&YOCTO_DOCS_BB_URL;#var-bb-BB_HASHCHECK_FUNCTION>`__ + :term:`bitbake:BB_HASHCHECK_FUNCTION` have changed. If you are using your own custom hash check function, see 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. environment: export BBSERVER=localhost:$port By default, ``BBSERVER`` also appears in - ```BB_HASHBASE_WHITELIST`` <&YOCTO_DOCS_BB_URL;#var-BB_HASHBASE_WHITELIST>`__. + :term:`bitbake:BB_HASHBASE_WHITELIST`. Consequently, ``BBSERVER`` is excluded from checksum and dependency data. @@ -5829,7 +5829,7 @@ system and gives an overview of their function and contents. excludes the following variables: :term:`CONF_VERSION` :term:`BB_NUMBER_THREADS` - `BB_NUMBER_PARSE_THREADS <&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS>`__ + :term:`bitbake:BB_NUMBER_PARSE_THREADS` :term:`PARALLEL_MAKE` :term:`PRSERV_HOST` :term:`SSTATE_MIRRORS` :term:`DL_DIR` -- cgit v1.2.3-54-g00ecf