linux/poky.git/documentation/kernel-dev/faq.rst, branch honister-3.4

manuals: Rename the "Using .bbappend Files in Your Layer" section

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

To prepare to add another example bbappend, rename the current "Using .bbappend Files in Your Layer" section to "Appending Other Layers Metadata With Your Layer". Name the current example as "Overlaying a File Using Your Layer". (From yocto-docs rev: 62d7b5721b2fbcf1e22fc4e7bbac51d52260730e) Signed-off-by: Tom Rini Reviewed-by: Michael Opdenacker Reviewed-by: Quentin Schulz 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

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

manuals: reduce verbosity related to "the following" expression

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

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

kernel-dev: remove 'kernel-dev' 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: 3d7eb2c5e1d230290c97dd8e5b528086e1d8034a) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie