summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/kickstart.rst
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2021-06-19 09:07:35 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-07-16 21:59:31 +0100
commit5a6fb291ad16ce4110e65adf2d29e8ccfe6fa25a (patch)
treedf43222dc7a0def1bbc6246ca2a33953f85e584f /documentation/ref-manual/kickstart.rst
parentbe3e14dd43220db034a63b7a9f5516feb6a00110 (diff)
downloadpoky-5a6fb291ad16ce4110e65adf2d29e8ccfe6fa25a.tar.gz
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 <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/kickstart.rst')
-rw-r--r--documentation/ref-manual/kickstart.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst
index a7443f9ea3..fc723ccbe2 100644
--- a/documentation/ref-manual/kickstart.rst
+++ b/documentation/ref-manual/kickstart.rst
@@ -208,7 +208,7 @@ supports the following options:
208 bootloader times out and boots the default option. 208 bootloader times out and boots the default option.
209 209
210- ``--append``: Specifies kernel parameters. These parameters will be 210- ``--append``: Specifies kernel parameters. These parameters will be
211 added to the syslinux ``APPEND`` or ``grub`` kernel command line. 211 added to the syslinux :term:`APPEND` or ``grub`` kernel command line.
212 212
213- ``--configfile``: Specifies a user-defined configuration file for 213- ``--configfile``: Specifies a user-defined configuration file for
214 the bootloader. You can provide a full pathname for the file or a 214 the bootloader. You can provide a full pathname for the file or a