linux/poky.git/documentation/kernel-dev, branch yocto-4.0.8

docs: kernel-dev: faq: update tip on how to not include kernel in image

2023-01-06T17:33:45+00:00

Since commit f6d963fa6d0e ("kernel: make kernel-base recommend kernel-image, not depend"), present in Kirkstone 4.0, one should set RRECOMMENDS and not RDEPENDS to avoid including the kernel in the image, so let's update the documentation to reflect that. Reported-by: Konstantin Kletschke Cc: Quentin Schulz (From yocto-docs rev: b94956c7d416879f9e4c46102145ef478270c440) Signed-off-by: Quentin Schulz Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: replace "rootfs" by "root filesystem"

2022-01-07T11:12:06+00:00

Almost everyone understands "rootfs", but "root filesystem" is real English. (From yocto-docs rev: 3d610f15e5b6be3435e9e81e4498a676671e5b39) 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

manuals: delete unmaintained history sections

2021-09-18T12:03:45+00:00

This deletes the history sections in each sub-manual, which didn't add any value, given that they didn't list the changes from one Yocto Project version to the next. (From yocto-docs rev: 29ce5b89c438079793cc6457401b6a9275db877a) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

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

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 remaining ``FOO`` by :term:`FOO`

2021-07-16T20:59:31+00:00

A few occurences appeared between the time the original patch was sent and it was applied, this fixes it. Also, the original patch didn't take into account lowercase terms, this is now fixed, see module_autoload for example. Finally, as is often the case with regexp, there was a typo in it that didn't make it match as much as it should have. The script that is used to do the replacement of ``FOO`` by :term:`FOO` is the following Python code: import re from pathlib import Path from runpy import run_module import contextlib import io import sys re_term = re.compile(r'variables.html#term-([a-zA-Z_0-9]*)') terms = [] new_terms = set() with contextlib.redirect_stdout(io.StringIO()) as f: run_module('sphinx.ext.intersphinx', run_name='__main__') objects = f.getvalue() match = re_term.search(objects) while match: if match.group(1): terms.append(match.group(1)) match = re_term.search(objects, match.end()) for rst in Path('.').rglob('*.rst'): with open(rst, 'r') as f: content = "".join(f.readlines()) for term in terms: content = re.sub(r'``({})``(?!.*\s+[~=-]{{{:d},}})'.format(term, len(term)), r':term:`\1`', content) with open(rst, 'w') as f: f.write(content) This script takes one argument as input: an objects.inv. Bitbake's can be gotten from https://docs.yoctoproject.org/bitbake/objects.inv. The objetcs.inv from the current git repo can be gotten from documentation/_build/html/objetcs.inv after running `make html`. Note that this excludes from replacement terms that appear in section titles as it requires refs to be changed too. This can be automated too if need be but right now it looks a bit confusing to have an anchor link (for sections) also have a term/reference link in it. I am not sure this is desired today. This is the result of two runs of the aforementioned script, once with Bitbake objects.inv and once with this repo's. Fixes: ba49d9babfcb "docs: replace ``FOO`` by :term:`FOO` where possible" (From yocto-docs rev: 1e1b0c4dd241b6657035172b1f7b5f341afa8b25) 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