linux/poky.git/documentation/ref-manual/structure.rst, branch uninative-3.7

manuals: replace hyphens with em dashes

2022-06-27T13:55:08+00:00

Fix some hyphens being improperly used as em dashes. See https://www.grammarly.com/blog/hyphens-and-dashes/ Using em dashes may also allow Sphinx to hyphenate and break lines in the best way. Note that the first character after an em dash not supposed to be capitalized, unless a specific rule applies, typically when what follows is a proper noun. Fix a few misuses of parentheses in following text. (From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: improve documentation for TEMPLATECONF

2022-05-10T11:52:35+00:00

Add it to the variable index Misc improvements to the documentation for this variable (From yocto-docs rev: fb460a7c7aba1ad5754806f9cfad9ef591420317) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: improve references to classes

2022-02-03T13:47:50+00:00

- Simplify references to class sections, by replacing references such as :ref:`image.bbclass ` by :ref:`ref-classes-image` That's equivalent, because the class sections always called .bbclass - Adding references to class sections, by replacing strings such as ``image.bbclass`` by :ref:`ref-classes-image` - Simplifying a few class section links (From yocto-docs rev: 29d66aaa898390c19f121baf0f4fdcc178e4cd80) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

ref-manual: add more class references

2021-12-13T23:31:34+00:00

(From yocto-docs rev: f4610b060968c481c68d0411b82201c302050b71) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

docs: replace ``FOO`` by :term:`FOO` where possible

2021-06-19T15:54:01+00:00

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 Reviewed-by: Michael Opdenacker Reviewed-by: Nicolas Dechesne Signed-off-by: Richard Purdie

ref-manual: simplify style

2021-05-22T11:16:40+00:00

(From yocto-docs rev: 657a7f54856afd6fec7f2cb0b5f12b4b2d24adb7) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: reduce verbosity with "worry about" expression

2021-05-13T10:28:34+00:00

(From yocto-docs rev: 6c65f5f350cdc79a435deb20c48d861d9f4c5c14) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

ref-manual: delete extraneous back quote

2021-05-13T10:28:34+00:00

(From yocto-docs rev: 784d39fe28436302b4df7e1ea08582d4d2f664c6) Signed-off-by: Robert P. J. Day Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

ref-manual: delete references to dead LSB compliance

2021-05-13T10:28:34+00:00

Since LSB does not seem to be relevant these days, delete mentions of it. (From yocto-docs rev: 5b4354e0611253b40ad58613b910b6591493a1b4) Signed-off-by: Robert P. J. Day Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: code insertion simplification over two lines

2021-04-23T15:39:03+00:00

This simplifies paragraphs ending with a colon and followed by code insertion. Automatically substituted through the command: sed -i -z "s/:\n\s*::/::/g" file.rst This generates identical HTML output. (From yocto-docs rev: 28e2192a7c12d64b68061138a9f6c796453eebb1) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie