linux/poky.git/documentation/sdk-manual/appendix-customizing.rst, branch kirkstone-4.0.22

manuals: inclusive language updates

2022-03-16T14:25:01+00:00

Changes identified by OE core's scripts/contrib/convert-variable-renames.py script Original variable names are kept in old migration notes, but references to the new ones are provided. (From yocto-docs rev: 1a35380ca80509fee036018a2bbb22ba9b44d47a) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: propose https for SSTATE_MIRRORS

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

Both http and https work, but https should raise fewer questions from users. (From yocto-docs rev: e3bf892b1328b5c43ab041ba6c850e2782f54bdf) 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

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

sdk-manual: add missing index references

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

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

manuals: fix issues related to trailing dots

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

Fix missing reference and styling issues found thanks to trailing dots (only non black character in a line) Matches (and multiple false positives) found with the below command: git grep "\s\.$" (From yocto-docs rev: 1d3026f50753d9ccf39b7d0163c77c765d754994) 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

sdk-manual: fix broken references

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

Detected by running: git grep "^[\ ]*\" section" | grep -v "\`" (From yocto-docs rev: 1e4909304a7e04fa707633b58c5e0d68a67d353a) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

sdk-manual: simplify style and fix formating

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

(From yocto-docs rev: fffd2ce4c9efbdeb75b7afd6f4f2ce4ffca517ad) 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