linux/poky.git/documentation/sdk-manual, branch yocto-3.4.3

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

sdk-manual: reference obsolete reference to ADT

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

(From yocto-docs rev: 024258ecd3c50184ab38d54e7bec2698c04fc631) Signed-off-by: Michael Opdenacker 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

sdk-manual: overrides syntax updates

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

Updated with openembedded-core/scripts/contrib/convert-overrides.py (From yocto-docs rev: 39cf6b2eb063815a3e2bf7a71ffd1fd6351cc594) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: simplify references to BitBake manual

2021-07-30T21:49:15+00:00

Replacing ":ref:`section name:section name>`" by ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-

:section name`" when the reference description is the same as the section name. In this case, that's unnecessary to repeat the section name in the description part. (From yocto-docs rev: 6a1a590f9ef77dc8842ea5945661135992eb94e1) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz 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

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