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/migration-guides/migration-2.7.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/migration-guides/migration-2.7.rst')
| -rw-r--r-- | documentation/migration-guides/migration-2.7.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/documentation/migration-guides/migration-2.7.rst b/documentation/migration-guides/migration-2.7.rst index 66cb84584f..25d92296cc 100644 --- a/documentation/migration-guides/migration-2.7.rst +++ b/documentation/migration-guides/migration-2.7.rst | |||
| @@ -91,7 +91,7 @@ This section provides information about packaging changes. | |||
| 91 | package_name\ ``-src``). If you are currently using ``dbg-pkgs`` in | 91 | package_name\ ``-src``). If you are currently using ``dbg-pkgs`` in |
| 92 | :term:`IMAGE_FEATURES` to bring in debug | 92 | :term:`IMAGE_FEATURES` to bring in debug |
| 93 | symbols and you still need the sources, you must now also add | 93 | symbols and you still need the sources, you must now also add |
| 94 | ``src-pkgs`` to ``IMAGE_FEATURES``. Source packages remain in the | 94 | ``src-pkgs`` to :term:`IMAGE_FEATURES`. Source packages remain in the |
| 95 | target portion of the SDK by default, unless you have set your own | 95 | target portion of the SDK by default, unless you have set your own |
| 96 | value for :term:`SDKIMAGE_FEATURES` that | 96 | value for :term:`SDKIMAGE_FEATURES` that |
| 97 | does not include ``src-pkgs``. | 97 | does not include ``src-pkgs``. |
