linux/poky.git/documentation/toaster-manual, branch uninative-3.5

documentation: replace http with https for URLs

2021-10-08T21:01:24+00:00

https has been the preferred way to access websites for many years now. Change all of the URLs with a _working_ https server/certificate to use that URL. (From yocto-docs rev: c77868c780df94356d5f21453f80ace073fade9b) Signed-off-by: Jon Mason Reviewed-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: replace "apt-get" by "apt"

2021-10-08T21:01:24+00:00

Modern Debian based distros (such as Ubuntu) now use "apt" instead of "apt-get" Also make sure "apt" is invoked with root privileges (mandatory) (From yocto-docs rev: 380ef2474f3ecc2bce83f11cd838d054bef56d22) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

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

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

manuals: simplify style

2021-05-22T11:16:41+00:00

(From yocto-docs rev: 3332ee547cde0f2f8718f83d526b21339b0a8901) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: reduce verbosity related to "the following" expression

2021-05-13T10:28:34+00:00

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

manuals: reduce verbosity with "worry about" expression

2021-05-13T10:28:34+00:00

(From yocto-docs rev: 6c65f5f350cdc79a435deb20c48d861d9f4c5c14) Signed-off-by: Michael Opdenacker Reviewed-by: Quentin Schulz Signed-off-by: Richard Purdie

manuals: Fix typos and spacing

2021-04-06T21:29:49+00:00

Fix double words, punctuation spacing issues, spacing issues, "its" instead of "it's", and other trivial issues. (From yocto-docs rev: 56eb1f340a7af112e62c1d8ad02d4bec0ad88313) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: Spellcheck and capitalization fixes

2021-04-06T21:29:49+00:00

- Spelling fixes found using Emacs' spelling checker configured for US English - Fixes for some capitalization issues, especially some project names (QEMU, openSUSE, BusyBox), that were not consistently used with the same capitalization anyway. - A few whitespace fixes too (From yocto-docs rev: 05d69f17490dcc4933dcd85e57d9db53b912084a) Signed-off-by: Michael Opdenacker Reviewed-by: Nicolas Dechesne Signed-off-by: Richard Purdie

Do not assume working from $HOME

2021-03-23T22:54:55+00:00

In the "Yocto Project Quick Build" instructions (https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html#) there is an inconsistency that impacts several documents... People are first instructed to clone the poky git repository, but not mentioning from which directory. Then, it's consistent to instruct people to run "cd poky/". However, later in the instructions, readers are instructed to run "cd ~/poky", which assumes that cloning poky was done from the home directory. Many other places in the documentation make such an assumption. This change fixes this, and makes no assumption on where people have chosen to store their data, in particular where they cloned the "poky" repository. This also fixes a few whitespace issues. (From yocto-docs rev: fd4e365c85df212d7ed70fc1abb3657a4a88b294) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie