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/brief-yoctoprojectqs | |
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/brief-yoctoprojectqs')
-rw-r--r-- | documentation/brief-yoctoprojectqs/index.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index 7ae4526c42..b92b0d33d9 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst | |||
@@ -332,7 +332,7 @@ Follow these steps to add a hardware layer: | |||
332 | #. **Change the Configuration to Build for a Specific Machine:** The | 332 | #. **Change the Configuration to Build for a Specific Machine:** The |
333 | :term:`MACHINE` variable in the | 333 | :term:`MACHINE` variable in the |
334 | ``local.conf`` file specifies the machine for the build. For this | 334 | ``local.conf`` file specifies the machine for the build. For this |
335 | example, set the ``MACHINE`` variable to ``cyclone5``. These | 335 | example, set the :term:`MACHINE` variable to ``cyclone5``. These |
336 | configurations are used: | 336 | configurations are used: |
337 | https://github.com/kraj/meta-altera/blob/master/conf/machine/cyclone5.conf. | 337 | https://github.com/kraj/meta-altera/blob/master/conf/machine/cyclone5.conf. |
338 | 338 | ||