summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/terms.rst
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: LTS releases now supported for 4 yearsMichael Opdenacker2023-08-031-1/+1
| | | | | | | (From yocto-docs rev: 6676ab2c6a1fd8cc2ad7b3e2da98f95118524c61) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: terms: fix incorrect note directiveQuentin Schulz2023-06-241-1/+1
| | | | | | | | | | | | | | | The directive is followed by two colons and not only one, so let's add the missing one. c.f. https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-note Fixes: 952c7e6dee49 ("manuals: improve initramfs details") Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 203b75e9473b5905ce216dfbc2112dcb02e81f2d) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: fix unnecessary double white spaceQuentin Schulz2023-06-241-1/+1
| | | | | | | | | | | There's no need for double white spaces here so let's just remove them. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: e41f6689157359777c3d86d9a7afed6f9e43782b) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: terms: fix typos in SPDX termQuentin Schulz2023-06-241-2/+2
| | | | | | | | | | Fixes: 2c53ac40e99a ("ref-manual: terms.rst: add SBOM and SPDX terms") Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: b4862c7d1a01029eb29e3dca3fd69e6b545bbc80) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add "Mixin" termMichael Opdenacker2023-04-281-1/+7
| | | | | | | | | | Also add a target (and use) a target for the "Long Term Support Release" section. (From yocto-docs rev: 98d6f2066fcdb20e63b8da6ed52d0f3590b15195) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: move Initramfs entry from variables to termsPaul Eggleton2023-04-221-0/+42
| | | | | | | | | | It looks like this was accidentally added to the variable glossary instead of the terms list, so move it to the latter. (From yocto-docs rev: c9829dcae18cd2cb5f008081d841ca995b76b8bf) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add section link also to buildtools-extended entryPaul Eggleton2023-04-221-0/+4
| | | | | | | | | | I realise it's already in the buildtools entry above, but for completeness let's add it to the buildtools-extended entry as well. (From yocto-docs rev: d9db1d380120e976a30e9eddb86b391084178c94) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add "LTS" termMichael Opdenacker2023-04-031-0/+6
| | | | | | | (From yocto-docs rev: 70536fa188101c8fdd6bbca8343829c4f798ef47) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: create references to buildtoolsMichael Opdenacker2022-12-181-0/+18
| | | | | | | | | On the side, also simplify a reference to the section describing them. (From yocto-docs rev: 0c13a7f9ccee4ddc9c6034d03f47625a09598cec) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: split dev-manual/common-tasks.rstMichael Opdenacker2022-12-011-4/+4
| | | | | | | | | | | | | | 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 <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add shortcut for Wikipedia linksMichael Opdenacker2022-11-071-2/+2
| | | | | | | (From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: terms.rst: add reference to new SBOM/SPDX section in dev manualMichael Opdenacker2022-11-071-1/+3
| | | | | | | (From yocto-docs rev: 908c985b0a9ad98d1e6610c36a057501be1900e9) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: terms.rst: add SBOM and SPDX termsMichael Opdenacker2022-11-071-0/+26
| | | | | | | (From yocto-docs rev: 2c53ac40e99a7957736276c5bf925b3f81544aa5) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: use references to the "Build Directory" termMichael Opdenacker2022-10-281-13/+13
| | | | | | | | | | | | | | Replace instances of "Build Directory" and "build directory" (when applicable) by :term:`Build Directory` as already done in most places. Doing this, fix the indentation of the paragraphs with this term. (From yocto-docs rev: dce50679242d39f133e0cde5c8483b5e69f3eb54) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: stop referring to the meta-openembedded repo from GitHubMichael Opdenacker2022-10-281-5/+3
| | | | | | | (From yocto-docs rev: de6e7c05fbcff99a6f1fe2a2bf889b559b9b576b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: replace "_" by "__" in external linksMichael Opdenacker2022-10-281-3/+3
| | | | | | | (From yocto-docs rev: 25142cd8121fdd6a8e0524fc8417fc666c498981) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: replace hyphens with em dashesMichael Opdenacker2022-06-271-2/+2
| | | | | | | | | | | | | | | | | | | 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 <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add description for the "sysroot" termMichael Opdenacker2022-06-211-0/+25
| | | | | | | | | | This term is used throughout the manual but is not properly introduced anywhere. (From yocto-docs rev: 51426a0762a5988aa835e065f5258fd7ac474c52) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: Drop POKYVERSION and YOCTO_POKY referencesRichard Purdie2022-03-211-7/+7
| | | | | | | | | | | | | | We don't publish tarballs using this version any more, it has been removed everywhere. Remove the obsolete references in the docs, adapting references accordingly. The tarballs now are just created with their sha256 checksum which we don't want or need to reference in the docs. (From yocto-docs rev: c7a0ac88b01c48f3d9209536542bf43ae7a7937f) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: fix hardcoded link warning messagesQuentin Schulz2022-02-231-1/+1
| | | | | | | | | | | | | | Sphinx complains about hardcoded links which can be replaced by an extlink. So let's apply its recommendations. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: dc2ec13cfbe0f20a868108a0bd800c0a875c1796) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* make the documentation a bit more inclusiveQuentin Schulz2021-12-131-1/+1
| | | | | | | | | | | | | | | Except the name of variables which can't be changed only in the documentation for obvious reasons and workflow or developement explanations around the use of the "master" branch which cannot be replaced with "development" branch instead, most of the non-inclusive words that appear in https://inclusivenaming.org/word-lists/tier-1/ should have been replaced in this patch. (From yocto-docs rev: 2755f35060084f7af356091de9dc144f85530fe2) Signed-off-by: Quentin Schulz <foss+yocto@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: generalize definition of "container layer"Robert P. J. Day2021-11-211-4/+21
| | | | | | | | | | | | Given that there seems to be little value in being excruciatingly pedantic about whether a container layer has a valid layer as a top-level directory, expand the definition to allow either. (From yocto-docs rev: 95e5df9a51a7cda6588af523a3a0d6752613f189) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: font fixesMichael Opdenacker2021-10-081-1/+1
| | | | | | | | | | | | | | This fixes font inconsistencies, mixing a ``text`` string with another string with the regular font, where the whole string makes more sense with a single font. The result is also much simpler and will make future searches easier. (From yocto-docs rev: e6d1c166a97a1b6bb42ca49dfcbd3d39f8eadc16) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add potential of parallelism to defn of "Task"Robert P. J. Day2021-09-181-1/+7
| | | | | | | | | (From yocto-docs rev: 2e80de272b987c70374a1758e71c5c1371054d1f) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <foss@0leil.ṅet> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fix reference to bbappend section of dev-manualRichard Purdie2021-08-201-2/+2
| | | | | | (From yocto-docs rev: 015914cdbe3f58a39ec64ee6a4181d3d29741205) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: replace ``FOO`` by :term:`FOO` where possibleQuentin Schulz2021-06-191-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: code insertion simplification over two linesMichael Opdenacker2021-04-231-2/+1
| | | | | | | | | | | | | | | This simplifies paragraphs ending with a colon and followed by code insertion. Automatically substituted through the command: sed -i -z "s/:\n\s*::/::/g" file.rst This generates identical HTML output. (From yocto-docs rev: 28e2192a7c12d64b68061138a9f6c796453eebb1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Do not assume working from $HOMEMichael Opdenacker2021-03-231-7/+4
| | | | | | | | | | | | | | | | | | | | | | | | | 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 <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: fix missing & and ; surrounding references from poky.yamlQuentin Schulz2021-01-201-2/+2
| | | | | | | | | | | | poky.yaml references are only replaced in files if they are prefixed by & and suffixed by ;. Let's fix the missing surrounding characters. (From yocto-docs rev: 7ee4ba7a27acd87d8c728639d1b053d2e26c6e58) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: terms: Fix poky tarball root folderElvis Stansvik2021-01-041-1/+2
| | | | | | | | | When extracting the tarball the root folder is not named `poky`, but e.g. `poky-gatesgarth-24.0.0`. (From yocto-docs rev: 8c92f709cbd96310b7153dd55dae8fa4899a7818) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove 'ref' from filenamesNicolas Dechesne2020-12-091-0/+390
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: bb7e4783f45a5f67e6e4b39968f3512f43738833) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-08-04 20:19:20 +0000