linux/poky.git/documentation/kernel-dev/advanced.rst, branch yocto-4.1.2

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

make the documentation a bit more inclusive

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

Except the name of variables which can't be changed only in the documentation for obvious reasons and workflow or developement explanations around the use of the "master" branch which cannot be replaced with "development" branch instead, most of the non-inclusive words that appear in https://inclusivenaming.org/word-lists/tier-1/ should have been replaced in this patch. (From yocto-docs rev: 2755f35060084f7af356091de9dc144f85530fe2) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: add hyperlinks to files in meta-skeleton

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

This makes the manuals easier to use. Note the care to keep the paths visible, so that people reading a printed version still know where to find the files. (From yocto-docs rev: 501917f65530f14ea686b69d6e96407c3f970a28) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

docs: fix new override syntax migration

2021-08-14T11:04:23+00:00

Fix bits missed by the migration script. (From yocto-docs rev: 452e0c5067476fd2ce81f09e6c73da84ced4bbd0) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

kernel-dev manual: overrides syntax updates

2021-08-14T11:04:23+00:00

Updated with openembedded-core/scripts/contrib/convert-overrides.py (From yocto-docs rev: d4598b592d1b0c9ce9448a8858eb4f47d83487b2) 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

kernel-dev manual: simplify style

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

(From yocto-docs rev: 5bbbed35175ffcabb24bcac305d17563b8d9b9e3) Signed-off-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

docs: replace anchor links

2021-04-09T14:24:46+00:00

Anchor links are treated by Sphinx as external links and are not checked during build, meaning it is impossible to know if a link becomes broken or not. As a matter of fact, most of the anchor links replaced in this commit were actually broken. The README now states that anchor links are forbidden so that there's no need to go through such a change later on. (From yocto-docs rev: de9e4d26b46afa3c79137d07529a74553400d2e0) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

overview-manual: remove 'overview-manual' from filenames

2020-12-09T12:21:27+00:00

All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: 4f489a40bb00be018e419802a76fec9dbee3f255) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie