summaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)Author
2021-10-08bitbake: replace http with https for URLsJon Mason
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. Signed-off-by: Jon Mason <jdmason@kudzu.us> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-14bitbake.conf: fix vars_from_file() callMartin Jansa
The reference to this function was dropped from BBHandler.py in: https://git.openembedded.org/bitbake/commit/?id=aaa5292ef96ea27f505bc5c5a4b1eb4f497ed061 Signed-off-by: Martin Jansa <Martin.Jansa@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-08doc: bitbake-user-manual-fetching: S should be set to WORKDIR/git for git ↵Quentin Schulz
fetcher Document that S has to be set to "${WORKDIR}/git" in order for the recipe to work if the git fetcher is fetching the main source of code for the recipe. Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-06doc: bitbake-user-manual-execution: remove mention to long-gone BBHASHDEPS ↵Quentin Schulz
variable 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. Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-09-06bitbake-user-manual: replace "file name" by "filename"Michael Opdenacker
There are many more instances of "filename" or "filenames" than of "file name" or "file names". The winner takes it all! Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-12fetch2/wget: fetch securely by defaultRoss Burton
The days of broken certificates are behind us now, so instead of always passing --no-check-certificate to wget, don't pass it by default and instead only pass it BB_CHECK_SSL_CERTS = "0". [ YOCTO #14108 ] Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-06doc: Fix append/prepend/remove referencesRichard Purdie
Fix some references missed during the overrides syntax migration. Thanks to Quentin Schulz <foss@0leil.net> for the patch. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-02doc: bitbake-user-manual: grammar fix for the number of "metadata"Michael Opdenacker
"metadata" is used both as singular and as plural. This fixes a case in which the verb has a singular conjugation, which conflicts with the absence of article indicating a plural case. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-02doc: bitbake-user-manual: update bitbake option helpMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-02doc: bitbake-user-manual: fix syntax in example and improve descriptionMichael Opdenacker
The previous syntax of the example was clearly incorrect The example and description were also ambiguous, one could think that it was "bitbake recipe" instead of "bitbake <recipename>" Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-02doc/lib: Add fixes for issues missed by the automated conversionRichard Purdie
The examples and tests use non-standard override names, convert these to the new syntax by hand. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-08-02doc/lib: Update to use new override syntax containing colonsRichard Purdie
This runs the overrides conversion script in OE-Core over the bitbake code base including the docs. A handful of things were excluded in toaster and for the Changelog file. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-07-26doc: bitbake-user-manual: replace ``FOO`` by :term:`FOO` where possibleQuentin Schulz
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. 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 which can be gotten from doc/_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. Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-07-26doc: bitbake-user-manual: ref-variables: force glossary output to be ↵Quentin Schulz
alphabetically sorted Even though, care should be taken to have the terms in the glossary sources alphabetically ordered, it is possible some terms might be in the wrong place. This makes sure that whatever the order of terms in the glossary sources, the generated medium is correctly sorted. Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-07-26doc: bitbake-user-manual: ref-variables: order alphabetically the glossary ↵Quentin Schulz
sources This reorders a few entry so that they are alphabetically sorted. Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-07-26doc: Makefile: turn warnings into errors by defaultQuentin Schulz
-W is for turning warnings into errors, --keep-going to make sure the whole documentation is built and all warnings will be printed before failing. Since there's currently no warning, it's time to introduce it! Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-06doc: bitbake-user-manual: fix erroneous statement in glossary introMichael Opdenacker
This is the BitBake glossary. Remove an erroneous statement probably coming from the introduction to the YP/OE glossary. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-06docs: Add BB_HASHSERVE definition to glossaryMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-06doc: user-manual: ref-manual: remove mentions to BB_SETSCENE_VERIFY_FUNCTION2Quentin Schulz
This variable was removed in July 2019 with commit 5deaa5df730a "runqueue: Drop unused BB_SETSCENE_VERIFY_FUNCTION2". There's no replacement, so let's update the documentation to not mention this variable anymore. This was found by running: git grep -hoP '^ :term:`\K\w+(?=`)' doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | \ xargs -I{} sh -c \ "grep -Rq --include='*.py' --include='*.conf' --include='*.bbclass' --include='*.bb' --include='*.bbappend' --include='*.inc' \ -w -E {}'_*(_[a-z]+[0-9a-z]*[a-z]+)*' || \ echo {}" Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-06-06doc: user-manual: remove mentions to BBVERSIONSQuentin Schulz
BBVERSIONS support was dropped in November 2016 in commit 0bb188f01e39 "ast: remove BBVERSIONS support". Let's update the documentation to reflect this. This was found by running: git grep -hoP '^ :term:`\K\w+(?=`)' doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | \ xargs -I{} sh -c \ "grep -Rq --include='*.py' --include='*.conf' --include='*.bbclass' --include='*.bb' --include='*.bbappend' --include='*.inc' \ -w -E {}'_*(_[a-z]+[0-9a-z]*[a-z]+)*' || \ echo {}" Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-26doc: bitbake-user-manual: fix typo left over from Sphinx migrationNicolas Dechesne
Fixes d99760cc687c (sphinx: last manual round of fixes/improvements) Reported-by: Michal Piechowski <m.z.piechowski@gmail.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-26doc: bitbake-user-manual: code insertion simplification over two linesMichael Opdenacker
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. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-26doc: bitbake-user-manual: simplify colon usageMichael Opdenacker
- This replaces instances of ": ::" by "::", which generates identical HTML output Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-26README: update/fix contribution guidelinesMichael Opdenacker
- Ask to CC the docs@lists.yoctoproject.org mailing list - doc/README: fix the command to generate the manual Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-20doc/user-manual-fetching: Remove basepath unpack parameter docsRichard Purdie
The code for this was removed in 2016 in commit e659a3b0c2771679057ee3e13cd42e6c62383ff2. Nobody seems to have missed it so remove the documentation so we match the code. [YOCTO #13449] Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15bitbake-user-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entryPaul Eggleton
Add REQUIRED_VERSION, add a reference to it in PREFERRED_VERSION and adjust the opening statement to read slightly better. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15bitbake-user-manual: document no support for using passwords in git URLsPaul Eggleton
This is based on the comment added in revision aded964eed4ce5a725ed1ab477efabc86b1aa481. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-22doc: fix syntax error in layer.conf exampleRobert P. J. Day
While this example really needs to be rewritten to not define multiple patterns in the same layer.conf, as long as it's there, it might as well be syntactically correct. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-22doc: fix glossary link for BB_INVALIDCONF variableRobert P. J. Day
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-22doc: mention that addtask handles multiple dependenciesRobert P. J. Day
Add a note explaining that "addtask" can accept multiple dependencies, just in case someone runs across such an example and is confused. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-15doc: move BBFILES_DYNAMIC for alphabetical orderRobert P. J. Day
Since BBFILES_DYNAMIC does not have a "BB_" prefix, it belongs further down in the variable glossary. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-11docs: Add AZ_SAS definition to glossaryAlejandro Hernandez Samaniego
Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-11docs: Add Az fetcher documentationAlejandro Hernandez Samaniego
Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-02-16bitbake-worker/runqueue: Add support for BB_DEFAULT_UMASKRichard Purdie
Currently each task has to have a umask specified individually. This is leading to determinism issues since it is easy to miss specifying this for an extra task. Add support for specifing the default task umask globally which simplifies the problem. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-23docs: Makefile: enable parallel buildNicolas Dechesne
>From sphinx-build man page: -j N build in parallel with N processes where possible (special value "auto" will set N to cpu-count) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-11-20doc/conf.py: add missing import sysMert Kirpici
Due to the calls to sys.stderr.write() and sys.exit() in exception handling in case of sphinx_rtd_theme not being installed, the following exception is raised by Python due to the fact that sys module not being imported. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-10-05sphinx: rename Makefile.sphinxNicolas Dechesne
Now that the DocBook files are removed, we can rename the top level Makefile. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-10-05sphinx: remove DocBook filesNicolas Dechesne
The BitBake documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-10-05docs: static: theme_overrides.css: fix responsive design on <640px screensQuentin Schulz
From experience the body takes the whole space anyway and the text stays within the screen boundaries by default, no need to make the min-width 640px then. Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-10-05docs: sphinx: report errors when dependencies are not metNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-10-05docs: update README file after migrationg to SphinxNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-10-05docs: sphinx: replace special quotes with double quotesNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-10-05docs: ref-variables: add links to terms in glossaryNicolas Dechesne
This is similar to this change in yocto-docs: 9e468274eaad (docs: ref-manual: ref-variables: add links to terms in glossary) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-09-16bitbake-user-manual: fix bad linksNicolas Dechesne
The link errors were found with linkcheck command: (line 1958) broken https://docs.python.org/3/library/re.html#re - Anchor 're' not found (line 713) broken http://docs.python.org/3/library/re.html#re - Anchor 're' not found Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-09-16sphinx: theme_override: Use bold for emphasis textRichard Purdie
This more closely matches the original docbook style and is appropriate given the way the manual uses this element. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-16sphinx: theme_override: properly set font for verbatim textNicolas Dechesne
The 'verbatim' text was rendered with Courier font in DocBook (e.g. when using the <filename> tag). With DocBook we are using the ``FOO`` notation which ends up in a <pre> class in the HTML output. Configure the theme CSS to use Courier, to preserve the look and feel of the original docs. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-16sphinx: remove leading '/'Nicolas Dechesne
When switching back and forth between between regular and mega manual an extra '/' keeps being added to the URL. Reported-by: Quentin Schulz <quentin.schulz@streamunlimited.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-09-16sphinx: update style for important, caution and warningsNicolas Dechesne
The initial theme override covers for tip and and note only. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-09-16sphinx: last manual round of fixes/improvementsNicolas Dechesne
Review all pages, and fix up for formatting which was not covered by pandoc, such as some links and code block sections. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-09-16sphinx: bitbake-user-manual: insert additional blank line after titleNicolas Dechesne
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-05-24 21:37:03 +0000