linux/poky.git/documentation, branch 3.4_M2

ref-manual: Document BUILDHISTORY_PATH_PREFIX_STRIP

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

(From yocto-docs rev: c834fab46794233864e6bcb587ab75f2bfa1631c) Signed-off-by: Joshua Watt Reviewed-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: remove image-mklibs references

2021-07-10T22:39:18+00:00

The image-mklibs bbclass was removed from OE-Core with commit 908df863b419d1cad7317153101fc827e7e3a354 and corresponding changes to local.conf.sample were made in meta-yocto with c8c8f284eb2abe7e1352850a885454487cc01986. Remove all references to image-mklibs from the documentation as it is no longer supported. (From yocto-docs rev: f45b378eb2cb08c173620cffb17cbcc8b402da0d) Signed-off-by: Patrick Williams Signed-off-by: Richard Purdie

releases: update to include 3.1.9

2021-07-02T06:24:21+00:00

Adding 3.1.9 to documentation switcher and release list. (From yocto-docs rev: 6951b86a2e0e95bb72db12624efa23fec579bc70) Signed-off-by: Michael Halstead 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

sdk-manual: fix wrong word

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

(From yocto-docs rev: 93c43a019e3f44b0eb83a16e44372d98b5dce1a9) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

sdk-manual: add missing quoting around "devtool upgrade"

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

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

migration guides: remove index reference to BB_SETSCENE_VERIFY_FUNCTION2

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

This variable is no longer documented in Bitbake's manual as it's not in use any more. (From yocto-docs rev: 68328d93023d2e3251a05ea2830c4f6b6de65708) 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