From 5a6fb291ad16ce4110e65adf2d29e8ccfe6fa25a Mon Sep 17 00:00:00 2001 From: Quentin Schulz Date: Sat, 19 Jun 2021 09:07:35 +0200 Subject: docs: replace remaining ``FOO`` by :term:`FOO` A few occurences appeared between the time the original patch was sent and it was applied, this fixes it. Also, the original patch didn't take into account lowercase terms, this is now fixed, see module_autoload for example. Finally, as is often the case with regexp, there was a typo in it that didn't make it match as much as it should have. The script that is used to do the replacement of ``FOO`` by :term:`FOO` is the following Python code: import re from pathlib import Path from runpy import run_module import contextlib import io import sys re_term = re.compile(r'variables.html#term-([a-zA-Z_0-9]*)') terms = [] new_terms = set() with contextlib.redirect_stdout(io.StringIO()) as f: run_module('sphinx.ext.intersphinx', run_name='__main__') objects = f.getvalue() match = re_term.search(objects) while match: if match.group(1): terms.append(match.group(1)) match = re_term.search(objects, match.end()) for rst in Path('.').rglob('*.rst'): with open(rst, 'r') as f: content = "".join(f.readlines()) for term in terms: content = re.sub(r'``({})``(?!.*\s+[~=-]{{{:d},}})'.format(term, len(term)), r':term:`\1`', content) with open(rst, 'w') as f: f.write(content) This script takes one argument as input: an objects.inv. Bitbake's can be gotten from https://docs.yoctoproject.org/bitbake/objects.inv. The objetcs.inv from the current git repo can be gotten from documentation/_build/html/objetcs.inv after running `make html`. Note that this excludes from replacement terms that appear in section titles as it requires refs to be changed too. This can be automated too if need be but right now it looks a bit confusing to have an anchor link (for sections) also have a term/reference link in it. I am not sure this is desired today. This is the result of two runs of the aforementioned script, once with Bitbake objects.inv and once with this repo's. Fixes: ba49d9babfcb "docs: replace ``FOO`` by :term:`FOO` where possible" (From yocto-docs rev: 1e1b0c4dd241b6657035172b1f7b5f341afa8b25) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/bsp-guide/bsp.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'documentation/bsp-guide') diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 5c43f53d0c..5f62376d69 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst @@ -1365,7 +1365,7 @@ Project Reference Manual. - :term:`IMAGE_INSTALL`: Specifies packages to install into an image through the :ref:`image ` class. Recipes - use the ``IMAGE_INSTALL`` variable. + use the :term:`IMAGE_INSTALL` variable. - ``do_image_wic[depends]``: A task that is constructed during the build. In this example, the task depends on specific tools in order -- cgit v1.2.3-54-g00ecf