linux/poky.git/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst, branch mickledore-next

bitbake: bitbake-user-manual: show how use BB_LOGCONFIG to log warnings

2023-02-04T17:03:15+00:00

(Bitbake rev: 22be2dbd8e70322239f70e53ace2a552425e3665) Signed-off-by: Michael Opdenacker Suggested-by: Joshua Watt Signed-off-by: Richard Purdie

bitbake: bitbake-user-manual: remove "OEBasic" signature generator

2022-12-21T14:15:26+00:00

Removed in BitBake through https://git.openembedded.org/openembedded-core/commit/?id=3667e589ba16eb261cfd72c2b11429f482c239f6 (Bitbake rev: 50261fe047dfb41c3ce9d91b9b8245ce465d69b3) Signed-off-by: Michael Opdenacker Signed-off-by: Alexandre Belloni Signed-off-by: Richard Purdie

bitbake: bitbake: bitbake-user-manual: punctuation fixes

2022-03-30T12:05:03+00:00

- Replace hyphens by em dashes when necessary See https://www.grammarly.com/blog/hyphens-and-dashes/ - No uppercase after em dashes - No uppercase after colons if what follows is not a complete sentence. - Fix spacing before colons ":" - Replace em-dashes with colons for consistency in a section (Bitbake rev: 72230d6a9976b3bfca1f1e6fb09736fec195e2fe) (Bitbake rev: f1c4ac816e927f490fb9852c12aa408e8c9403b1) Signed-off-by: Michael Opdenacker Signed-off-by: Alexandre Belloni Signed-off-by: Richard Purdie

bitbake: bitbake: Rename configuration hash filtering variable

2022-02-21T23:37:26+00:00

In line with the inclusive language migration defined at: https://wiki.yoctoproject.org/wiki/Inclusive_language rename: BB_HASHCONFIG_WHITELIST -> BB_HASHCONFIG_IGNORE_VARS (Bitbake rev: f344246be73d626c215f867718e45fd6cddc2aaf) (Bitbake rev: 371deb3fe8510aadf4455810d7c5243d374e6532) Signed-off-by: Scott Murray Signed-off-by: Richard Purdie

bitbake: bitbake: Rename environment filtering variables

2022-02-21T23:37:26+00:00

In line with the inclusive language migration defined at: https://wiki.yoctoproject.org/wiki/Inclusive_language rename: BB_ENV_WHITELIST -> BB_ENV_PASSTHROUGH BB_ENV_EXTRAWHITE -> BB_ENV_PASSTHROUGH_ADDITIONS (Bitbake rev: fe60627839d4280cf0117ed1afbfccdff1181b6a) (Bitbake rev: 87104b6a167188921da157c7dba45938849fb22a) Signed-off-by: Scott Murray Signed-off-by: Richard Purdie

bitbake: bitbake: Rename basehas and taskhash filtering variables

2022-02-21T23:37:26+00:00

In line with the inclusive language migration defined at: https://wiki.yoctoproject.org/wiki/Inclusive_language rename: BB_HASHBASE_WHITELIST -> BB_BASEHASH_IGNORE_VARS BB_HASHTASK_WHITELIST -> BB_TASKHASH_IGNORE_TASKS the derived code variables basewhitelist and taskwhitelist have been renamed to basehash_ignore_vars and taskhash_ignore_tasks, respectively. [RP: Added compatibility mapping code and tweaked naming] (Bitbake rev: efaafc9ec2e8c0475e3fb27e877a1c0a5532a0e5) Signed-off-by: Scott Murray Signed-off-by: Richard Purdie

bitbake: bitbake-user-manual: add missing reference

2021-11-21T11:25:39+00:00

(Bitbake rev: d05529cc322ba9198edc12954b982729fc628fa0) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

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: doc: bitbake-user-manual-execution: remove mention to long-gone BBHASHDEPS variable

2021-09-06T09:19:03+00:00

BBHASHDEPS was removed from bitbake in April 2014, with the following commit: 92526eadd09d "bitbake-worker: Drop BBHASH variables" so let's remove mentions from the docs. (Bitbake rev: 7816a8de70adc3806a3739384cf08b281b4ee401) Signed-off-by: Quentin Schulz 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