diff options
author | Quentin Schulz <foss@0leil.net> | 2021-05-27 20:41:17 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-06-19 16:54:01 +0100 |
commit | 7d3f57cfd2e4322bcd96d67d330124f221a9aedd (patch) | |
tree | 5d07321b7c8bc59bb7fcc0372fab8b7a1966cf06 /documentation/sdk-manual/appendix-customizing-standard.rst | |
parent | 7a9b74e9d2a5cf3b1fb3ac7565c50eae6e0d4632 (diff) | |
download | poky-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/sdk-manual/appendix-customizing-standard.rst')
-rw-r--r-- | documentation/sdk-manual/appendix-customizing-standard.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/documentation/sdk-manual/appendix-customizing-standard.rst b/documentation/sdk-manual/appendix-customizing-standard.rst index 90b634529e..9bc70cf55c 100644 --- a/documentation/sdk-manual/appendix-customizing-standard.rst +++ b/documentation/sdk-manual/appendix-customizing-standard.rst | |||
@@ -17,10 +17,10 @@ and | |||
17 | variables control the set of packages adding to the SDK. | 17 | variables control the set of packages adding to the SDK. |
18 | 18 | ||
19 | If you want to add individual packages to the toolchain that runs on the | 19 | If you want to add individual packages to the toolchain that runs on the |
20 | host, simply add those packages to the ``TOOLCHAIN_HOST_TASK`` variable. | 20 | host, simply add those packages to the :term:`TOOLCHAIN_HOST_TASK` variable. |
21 | Similarly, if you want to add packages to the default set that is part | 21 | Similarly, if you want to add packages to the default set that is part |
22 | of the toolchain that runs on the target, add the packages to the | 22 | of the toolchain that runs on the target, add the packages to the |
23 | ``TOOLCHAIN_TARGET_TASK`` variable. | 23 | :term:`TOOLCHAIN_TARGET_TASK` variable. |
24 | 24 | ||
25 | Adding API Documentation to the Standard SDK | 25 | Adding API Documentation to the Standard SDK |
26 | ============================================ | 26 | ============================================ |