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/transitioning-to-a-custom-environment.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/transitioning-to-a-custom-environment.rst')
-rw-r--r-- | documentation/transitioning-to-a-custom-environment.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/documentation/transitioning-to-a-custom-environment.rst b/documentation/transitioning-to-a-custom-environment.rst index abbd74ca1d..f0035bd3af 100644 --- a/documentation/transitioning-to-a-custom-environment.rst +++ b/documentation/transitioning-to-a-custom-environment.rst | |||
@@ -47,7 +47,7 @@ Transitioning to a custom environment for systems development | |||
47 | #. **Based on the layers you've chosen, make needed changes in your | 47 | #. **Based on the layers you've chosen, make needed changes in your |
48 | configuration**. | 48 | configuration**. |
49 | For instance, you've chosen a machine type and added in the corresponding BSP | 49 | For instance, you've chosen a machine type and added in the corresponding BSP |
50 | layer. You'll then need to change the value of the ``MACHINE`` variable in your | 50 | layer. You'll then need to change the value of the :term:`MACHINE` variable in your |
51 | configuration file (build/local.conf) to point to that same machine | 51 | configuration file (build/local.conf) to point to that same machine |
52 | type. There could be other layer-specific settings you need to change as | 52 | type. There could be other layer-specific settings you need to change as |
53 | well. Each layer has a ``README`` document that you can look at for this type of | 53 | well. Each layer has a ``README`` document that you can look at for this type of |