linux/poky.git/documentation/transitioning-to-a-custom-environment.rst, branch scarthgap-5.0.13

manuals: split dev-manual/common-tasks.rst

2022-12-01T19:20:29+00:00

A 500 KB source file is always harder to manage, and can have section title conflicts. So, the "Common Tasks" document is gone and all its constituents are moved up one level. You now have 40 chapters in the Development Tasks Manual. (From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: replace hyphens with em dashes

2022-06-27T13:55:08+00:00

Fix some hyphens being improperly used as em dashes. See https://www.grammarly.com/blog/hyphens-and-dashes/ Using em dashes may also allow Sphinx to hyphenate and break lines in the best way. Note that the first character after an em dash not supposed to be capitalized, unless a specific rule applies, typically when what follows is a proper noun. Fix a few misuses of parentheses in following text. (From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: refer to "YP Compatible" layers instead of "curated" ones

2022-04-27T15:02:39+00:00

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

documentation: Simplify layerindex and layer links

2020-12-24T08:23:33+00:00

(From yocto-docs rev: b157d57cc50b0a9cfaa062fa0e966b4d29eceeec) Signed-off-by: Paul Barker Signed-off-by: Richard Purdie

sdk-manual: remove 'sdk' from filenames

2020-12-09T12:21:27+00:00

All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: bd8c0f7fc09a39a8bbde1c05b51693955738e148) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

dev-manual: remove 'dev-manual' from filenames

2020-12-09T12:21:27+00:00

All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: 00a9244587e2e63f2a5197ed0dfc89cb330f9275) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: rename top level document in each manual

2020-12-09T12:21:27+00:00

It is more common to call the top level document index.rst. This is what this patch is doing, along with all required references fixup. (From yocto-docs rev: 2cea7fbba9210479fc0387d7e1b80da9885558f0) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

docs: Fix license CC-BY-2.0-UK -> CC-BY-SA-2.0-UK

2020-10-08T10:28:30+00:00

When the license identifier tags were added, an incorrect string was used and the Share-Alike clause was lost. Fix this to match the license description in the files and add back the lost piece (its clear from the history it should be there) (From yocto-docs rev: 8d30c3d792755a7bfdb74b331dad98f51d3516af) Signed-off-by: Richard Purdie

sphinx: "highlight" some variables, tasks or files

2020-09-17T09:09:36+00:00

(From yocto-docs rev: 41e379dc32e52cec652a7f89caf4c3fd96dd2dda) Signed-off-by: Quentin Schulz Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie