summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev/maint-appx.rst
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2021-05-27 20:41:17 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-06-19 16:54:01 +0100
commit7d3f57cfd2e4322bcd96d67d330124f221a9aedd (patch)
tree5d07321b7c8bc59bb7fcc0372fab8b7a1966cf06 /documentation/kernel-dev/maint-appx.rst
parent7a9b74e9d2a5cf3b1fb3ac7565c50eae6e0d4632 (diff)
downloadpoky-7d3f57cfd2e4322bcd96d67d330124f221a9aedd.tar.gz
docs: replace ``FOO`` by :term:`FOO` where possible
If a variable has a glossary entry and some rST files write about those variables, it's better to point to the glossary entry instead of just highlighting it by surrounding it with two tick quotes. This was automated by the following python script: """ import re from pathlib import Path with open('objects.inv.txt', 'r') as f: objects = f.readlines() with open('bitbake-objects.inv.txt', 'r') as f: objects = objects + f.readlines() re_term = re.compile(r'variables.html#term-([A-Z_0-9]*)') terms = [] for obj in objects: match = re_term.search(obj) if match and match.group(1): terms.append(match.group(1)) for rst in Path('.').rglob('*.rst'): with open(rst, 'r') as f: content = "".joing(f.readlines()) for term in terms: content = re.sub(r'``({})``(?!.*\s*[~-]+)'.format(term), r':term:`\1`', content) with open(rst, 'w') as f: f.write(content) """ (From yocto-docs rev: ba49d9babfcb84bc5c26a68c8c3880a1d9c236d3) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/kernel-dev/maint-appx.rst')
-rw-r--r--documentation/kernel-dev/maint-appx.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/documentation/kernel-dev/maint-appx.rst b/documentation/kernel-dev/maint-appx.rst
index 3354de5f0c..d968c856f6 100644
--- a/documentation/kernel-dev/maint-appx.rst
+++ b/documentation/kernel-dev/maint-appx.rst
@@ -104,7 +104,7 @@ patch, or BSP:
104 repository organized under the "Yocto Linux Kernel" heading in the 104 repository organized under the "Yocto Linux Kernel" heading in the
105 :yocto_git:`Yocto Project Source Repositories <>`. 105 :yocto_git:`Yocto Project Source Repositories <>`.
106 106
107 - Areas pointed to by ``SRC_URI`` statements found in kernel recipes. 107 - Areas pointed to by :term:`SRC_URI` statements found in kernel recipes.
108 108
109 For a typical build, the target of the search is a feature 109 For a typical build, the target of the search is a feature
110 description in an ``.scc`` file whose name follows this format (e.g. 110 description in an ``.scc`` file whose name follows this format (e.g.