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.0.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.0.rst')
-rw-r--r-- | documentation/migration-guides/migration-2.0.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/documentation/migration-guides/migration-2.0.rst b/documentation/migration-guides/migration-2.0.rst index 22d0752226..7217853779 100644 --- a/documentation/migration-guides/migration-2.0.rst +++ b/documentation/migration-guides/migration-2.0.rst | |||
@@ -25,7 +25,7 @@ and the porting guide at | |||
25 | https://gcc.gnu.org/gcc-5/porting_to.html. | 25 | https://gcc.gnu.org/gcc-5/porting_to.html. |
26 | 26 | ||
27 | Alternatively, you can switch back to GCC 4.9 or 4.8 by setting | 27 | Alternatively, you can switch back to GCC 4.9 or 4.8 by setting |
28 | ``GCCVERSION`` in your configuration, as follows:: | 28 | :term:`GCCVERSION` in your configuration, as follows:: |
29 | 29 | ||
30 | GCCVERSION = "4.9%" | 30 | GCCVERSION = "4.9%" |
31 | 31 | ||
@@ -244,7 +244,7 @@ The following QA checks have been added: | |||
244 | 244 | ||
245 | - Added an "invalid-packageconfig" check for any options specified in | 245 | - Added an "invalid-packageconfig" check for any options specified in |
246 | :term:`PACKAGECONFIG` that do not match any | 246 | :term:`PACKAGECONFIG` that do not match any |
247 | ``PACKAGECONFIG`` option defined for the recipe. | 247 | :term:`PACKAGECONFIG` option defined for the recipe. |
248 | 248 | ||
249 | .. _migration-2.0-miscellaneous: | 249 | .. _migration-2.0-miscellaneous: |
250 | 250 | ||