linux/poky.git/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst, branch honister-3.4.2

bitbake: bitbake.conf: fix vars_from_file() call

2021-09-14T22:16:42+00:00

The reference to this function was dropped from BBHandler.py in: https://git.openembedded.org/bitbake/commit/?id=aaa5292ef96ea27f505bc5c5a4b1eb4f497ed061 (Bitbake rev: b4fe8507079b6464287549f3eac1f1fc8d0d9be2) Signed-off-by: Martin Jansa Signed-off-by: Richard Purdie

bitbake: bitbake-user-manual: replace "file name" by "filename"

2021-09-06T09:07:53+00:00

There are many more instances of "filename" or "filenames" than of "file name" or "file names". The winner takes it all! (Bitbake rev: dcd115176f63256f10db0b24b563683c4bdf8f96) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

bitbake: doc: Fix append/prepend/remove references

2021-08-06T05:34:58+00:00

Fix some references missed during the overrides syntax migration. Thanks to Quentin Schulz for the patch. (Bitbake rev: 2fd03ec7b136c694f2ced43b3abb69f719c99ec2) Signed-off-by: Richard Purdie

bitbake: doc: bitbake-user-manual: fix syntax in example and improve description

2021-08-02T15:09:19+00:00

The previous syntax of the example was clearly incorrect The example and description were also ambiguous, one could think that it was "bitbake recipe" instead of "bitbake " (Bitbake rev: 9d6664bbb68fac9bb4fbcbe0b35beb0a022a5a1f) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

bitbake: doc/lib: Add fixes for issues missed by the automated conversion

2021-08-02T14:44:10+00:00

The examples and tests use non-standard override names, convert these to the new syntax by hand. (Bitbake rev: a6c40eca1146c0160da7e4e0bd7ac52fef2029e0) Signed-off-by: Richard Purdie

bitbake: doc/lib: Update to use new override syntax containing colons

2021-08-02T14:44:10+00:00

This runs the overrides conversion script in OE-Core over the bitbake code base including the docs. A handful of things were excluded in toaster and for the Changelog file. (Bitbake rev: 47f8d3b24fd52381bf3b41e2f55a53e57841344c) Signed-off-by: Richard Purdie

bitbake: doc: bitbake-user-manual: replace ``FOO`` by :term:`FOO` where possible

2021-07-26T22:05:05+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. 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 which can be gotten from doc/_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. (Bitbake rev: aba88f40c47133ed9bc999e0298aca3bc8490912) Signed-off-by: Quentin Schulz Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

bitbake: doc: user-manual: ref-manual: remove mentions to BB_SETSCENE_VERIFY_FUNCTION2

2021-06-06T22:18:26+00:00

This variable was removed in July 2019 with commit 5deaa5df730a "runqueue: Drop unused BB_SETSCENE_VERIFY_FUNCTION2". There's no replacement, so let's update the documentation to not mention this variable anymore. This was found by running: git grep -hoP '^ :term:`\K\w+(?=`)' doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | \ xargs -I{} sh -c \ "grep -Rq --include='*.py' --include='*.conf' --include='*.bbclass' --include='*.bb' --include='*.bbappend' --include='*.inc' \ -w -E {}'_*(_[a-z]+[0-9a-z]*[a-z]+)*' || \ echo {}" (Bitbake rev: c2c0f5126c7c784bfd7a08f127e161a58c6b5d12) Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

bitbake: doc: user-manual: remove mentions to BBVERSIONS

2021-06-06T22:18:26+00:00

BBVERSIONS support was dropped in November 2016 in commit 0bb188f01e39 "ast: remove BBVERSIONS support". Let's update the documentation to reflect this. This was found by running: git grep -hoP '^ :term:`\K\w+(?=`)' doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | \ xargs -I{} sh -c \ "grep -Rq --include='*.py' --include='*.conf' --include='*.bbclass' --include='*.bb' --include='*.bbappend' --include='*.inc' \ -w -E {}'_*(_[a-z]+[0-9a-z]*[a-z]+)*' || \ echo {}" (Bitbake rev: 376e20c1aaff197020cdb68d309b3b22f19dafe8) Signed-off-by: Quentin Schulz Signed-off-by: Richard Purdie

bitbake: doc: bitbake-user-manual: simplify colon usage

2021-04-26T14:26:14+00:00

- This replaces instances of ": ::" by "::", which generates identical HTML output (Bitbake rev: fd8ce4dcaff3aae395f9945fb0a3be54905e1727) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie