summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual/concepts.rst
Commit message (Collapse)AuthorAgeFilesLines
...
* overview-manual: remove confusing and unnecessary paragraph about site.confMichael Opdenacker2022-05-101-12/+2
| | | | | | | | | | | | | | | | The explanations which precede and follow are sufficient. The removed text seemed to suggest to use conf/site.conf to specify the location of another conf/site.conf file. Another issue was that the way to override conf/site.conf settings through conf/local.conf was described before explaining that conf/site.conf is processed before conf/local.conf. (From yocto-docs rev: d477a2044e7b53977daf4d0c0d45cad29c2006fb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: improve the width of diagramsMichael Opdenacker2022-05-101-11/+14
| | | | | | | | | | | | Better for EPUB output in particular - Make some diagrams wider when necessary - Remove ":align: center" when we have ":width: 100%" - Update the standards.md files to mention this (From yocto-docs rev: 848ba7bd8984cc3f4bf6b818259865011cde0476) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: refer to "YP Compatible" layers instead of "curated" onesMichael Opdenacker2022-04-271-1/+1
| | | | | | | (From yocto-docs rev: dce5dd78d3bc7510e06cf5748033ee9c2888a405) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: correct and improve descriptions of AutotoolsMichael Opdenacker2022-04-271-4/+4
| | | | | | | (From yocto-docs rev: c7cb693673566ec12b95c568945b514ed0e18522) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: inclusive language updatesMichael Opdenacker2022-03-161-4/+4
| | | | | | | | | | | | | Changes identified by OE core's scripts/contrib/convert-variable-renames.py script Original variable names are kept in old migration notes, but references to the new ones are provided. (From yocto-docs rev: 1a35380ca80509fee036018a2bbb22ba9b44d47a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: overview-manual: formating fixesMichael Opdenacker2022-03-161-7/+2
| | | | | | | | (From yocto-docs rev: c17eb6bb35053ad89e52d41c7da75ccbc3823d1b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: remove references to prelink supportMichael Opdenacker2022-03-041-5/+3
| | | | | | | | | | Fixing documentation and updating examples containing "prelink" in their output. (From yocto-docs rev: 8927b8fff55fac1bd1fefcff2d16141dbd1ebc51) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: Remove unnecessary \n from SSTATE_MIRRORS examplesPeter Kjellerstedt2022-02-201-1/+1
| | | | | | | | | | | | Since commit 044fb04d in bitbake (fetch2: Allow whitespace only mirror entries) there is no need to separate the entries in SSTATE_MIRRORS with "\n". (From yocto-docs rev: 87b34b69b2df72d4e6edbd81839622fffd560331) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: propose https for SSTATE_MIRRORSMichael Opdenacker2022-02-031-1/+1
| | | | | | | | | | Both http and https work, but https should raise fewer questions from users. (From yocto-docs rev: e3bf892b1328b5c43ab041ba6c850e2782f54bdf) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document hash equivalenceMichael Opdenacker2022-01-101-0/+132
| | | | | | | (From yocto-docs rev: 7fad0873207980a747f79b2ce29ec0dc6c6c3cdf) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: fix typoMichael Opdenacker2022-01-071-1/+1
| | | | | | | (From yocto-docs rev: 595d3e77855aeed31537a5e58a4426d7cc0b21f5) Signed-off-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-7/+3
| | | | | | | | | | | | | | | 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>
* misc manuals: add further class referencesMichael Opdenacker2021-12-131-1/+1
| | | | | | | (From yocto-docs rev: 0693f1f8466a118dc707a9c17d5ca528b4ea368a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: simplify expressionMichael Opdenacker2021-10-081-1/+1
| | | | | | | (From yocto-docs rev: ea1e5d4214f30927119f0124ee8a80a558601161) Signed-off-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>
* overview-manual: delete bad backslashes in SSTATE_MIRRORS exampleRobert P. J. Day2021-10-021-2/+2
| | | | | | | | | | | | | Two inappropriate backslashes in the example for setting SSTATE_MIRRORS are apparently the result of an error by the transmogrification script for migrating XML to rST. (From yocto-docs rev: 9cff301a768b248f19fc1d5834f04d3defffcbc7) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: overview-manual: concepts: remove long-gone BBHASHDEPS variableQuentin Schulz2021-08-141-3/+0
| | | | | | | | | | | | | | BBHASHDEPS was removed from bitbake in April 2014, with the following commit: 92526eadd09d "bitbake-worker: Drop BBHASH variables" so let's remove mentions from the docs. (From yocto-docs rev: f9e1768b8c85e3ad7fa974940a90996a5ffee3f5) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: fix new override syntax migrationQuentin Schulz2021-08-141-2/+2
| | | | | | | | | | Fix bits missed by the migration script. (From yocto-docs rev: 452e0c5067476fd2ce81f09e6c73da84ced4bbd0) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: remove explicit BitBake variable referencesMichael Opdenacker2021-07-301-4/+2
| | | | | | | | | | | | | The standard :term:`VARIABLE` will refer to the description of the variable in the YP variable index. If it doesn't exist, it will refer to the description of the variable in the BitBake manual. (From yocto-docs rev: 34cb466caf872f9284eb81f6a5f31ad606214dee) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify references to BitBake manualMichael Opdenacker2021-07-301-3/+3
| | | | | | | | | | | | | Replacing ":ref:`section name<bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name>`" by ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-<section>: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 <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: replace remaining ``FOO`` by :term:`FOO`Quentin Schulz2021-07-161-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix issues related to trailing dotsMichael Opdenacker2021-06-191-5/+2
| | | | | | | | | | | | | 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 <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: replace ``FOO`` by :term:`FOO` where possibleQuentin Schulz2021-06-191-36/+36
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* overview-manual: simplify style and add missings referencesMichael Opdenacker2021-05-221-39/+34
| | | | | | | (From yocto-docs rev: 4a07947dbe0dd70fd1d528a207d663dfdca2b7c1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: code insertion simplification over two linesMichael Opdenacker2021-04-231-34/+17
| | | | | | | | | | | | | | | 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>
* docs: replace anchor linksQuentin Schulz2021-04-091-44/+49
| | | | | | | | | | | | | | | | | | Anchor links are treated by Sphinx as external links and are not checked during build, meaning it is impossible to know if a link becomes broken or not. As a matter of fact, most of the anchor links replaced in this commit were actually broken. The README now states that anchor links are forbidden so that there's no need to go through such a change later on. (From yocto-docs rev: de9e4d26b46afa3c79137d07529a74553400d2e0) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix suspicious newlinesMichael Opdenacker2021-04-061-2/+1
| | | | | | | | | | - That could originate from documentation migration issues - Checked that the corresponding links still exist (From yocto-docs rev: 38bae8f6067bc12f3617ed38587737d22dd7b32c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Simplify remaining yocto_home linksPaul Barker2020-12-241-9/+6
| | | | | | | (From yocto-docs rev: e0151e039f96c1548e2ec39ae24d4b0276f49434) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Simplify layerindex and layer linksPaul Barker2020-12-241-9/+6
| | | | | | | (From yocto-docs rev: b157d57cc50b0a9cfaa062fa0e966b4d29eceeec) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove 'ref' from filenamesNicolas Dechesne2020-12-091-3/+3
| | | | | | | | | | | 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>
* sdk-manual: remove 'sdk' from filenamesNicolas Dechesne2020-12-091-4/+4
| | | | | | | | | | | 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 <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: remove 'overview-manual' from filenamesNicolas Dechesne2020-12-091-0/+2134
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: 4f489a40bb00be018e419802a76fec9dbee3f255) 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 11:57:22 +0000