summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual
Commit message (Collapse)AuthorAgeFilesLines
...
* bitbake: doc: Fix append/prepend/remove referencesRichard Purdie2021-08-061-13/+13
| | | | | | | | | Fix some references missed during the overrides syntax migration. Thanks to Quentin Schulz <foss@0leil.net> for the patch. (Bitbake rev: 2fd03ec7b136c694f2ced43b3abb69f719c99ec2) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: grammar fix for the number of "metadata"Michael Opdenacker2021-08-021-1/+1
| | | | | | | | | | | | | "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. (Bitbake rev: fff7ade48d6cb9381284b93742bb2255976d6b41) 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>
* bitbake: doc: bitbake-user-manual: update bitbake option helpMichael Opdenacker2021-08-021-2/+5
| | | | | | | (Bitbake rev: 214d11867ea5dd9f1d7e50e128d45d7cc4eaf7ea) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: fix syntax in example and improve descriptionMichael Opdenacker2021-08-021-2/+3
| | | | | | | | | | | 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>" (Bitbake rev: 9d6664bbb68fac9bb4fbcbe0b35beb0a022a5a1f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/lib: Add fixes for issues missed by the automated conversionRichard Purdie2021-08-021-12/+12
| | | | | | | | | The examples and tests use non-standard override names, convert these to the new syntax by hand. (Bitbake rev: a6c40eca1146c0160da7e4e0bd7ac52fef2029e0) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/lib: Update to use new override syntax containing colonsRichard Purdie2021-08-022-39/+39
| | | | | | | | | | 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. (Bitbake rev: 47f8d3b24fd52381bf3b41e2f55a53e57841344c) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: replace ``FOO`` by :term:`FOO` where possibleQuentin Schulz2021-07-266-151/+151
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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. (Bitbake rev: aba88f40c47133ed9bc999e0298aca3bc8490912) 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>
* bitbake: doc: bitbake-user-manual: ref-variables: force glossary output to ↵Quentin Schulz2021-07-261-0/+1
| | | | | | | | | | | | | | | | | be 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. (Bitbake rev: 98809ebc6ad51f0a94cedccfaff9c11d3744dc0d) 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>
* bitbake: doc: bitbake-user-manual: ref-variables: order alphabetically the ↵Quentin Schulz2021-07-261-27/+27
| | | | | | | | | | | | glossary sources This reorders a few entry so that they are alphabetically sorted. (Bitbake rev: 311350ed5cb164d975c2119e60255a409e27dffb) 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>
* bitbake: doc: bitbake-user-manual: fix erroneous statement in glossary introMichael Opdenacker2021-06-061-4/+0
| | | | | | | | | | | This is the BitBake glossary. Remove an erroneous statement probably coming from the introduction to the YP/OE glossary. (Bitbake rev: 398a1686176c695d103591089a36e25173f9fd6e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: Add BB_HASHSERVE definition to glossaryMichael Opdenacker2021-06-061-0/+10
| | | | | | | (Bitbake rev: 0ab3255f8e9d9c8c8aa4788504ab06a50d1bb1f2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: user-manual: ref-manual: remove mentions to ↵Quentin Schulz2021-06-063-22/+0
| | | | | | | | | | | | | | | | | | | | | | BB_SETSCENE_VERIFY_FUNCTION2 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 {}" (Bitbake rev: c2c0f5126c7c784bfd7a08f127e161a58c6b5d12) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: user-manual: remove mentions to BBVERSIONSQuentin Schulz2021-06-062-42/+9
| | | | | | | | | | | | | | | | | | | | 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 {}" (Bitbake rev: 376e20c1aaff197020cdb68d309b3b22f19dafe8) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: fix typo left over from Sphinx migrationNicolas Dechesne2021-04-261-2/+2
| | | | | | | | | | Fixes d99760cc687c (sphinx: last manual round of fixes/improvements) Reported-by: Michal Piechowski <m.z.piechowski@gmail.com> (Bitbake rev: 00ce48919de720639eda2b6f7065a82b641e5167) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: code insertion simplification over two linesMichael Opdenacker2021-04-261-6/+3
| | | | | | | | | | | | | | | 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. (Bitbake rev: 51c80fc3497eecc8e50194fe1ff8069b59f03eda) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: bitbake-user-manual: simplify colon usageMichael Opdenacker2021-04-266-193/+193
| | | | | | | | | | - This replaces instances of ": ::" by "::", which generates identical HTML output (Bitbake rev: fd8ce4dcaff3aae395f9945fb0a3be54905e1727) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/user-manual-fetching: Remove basepath unpack parameter docsRichard Purdie2021-04-201-3/+0
| | | | | | | | | | | | 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] (Bitbake rev: 76bf42ea41a28b19d0377c2e548b0a59119fdf67) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: add REQUIRED_VERSION and adjust ↵Paul Eggleton2021-04-151-2/+16
| | | | | | | | | | | | PREFERRED_VERSION entry Add REQUIRED_VERSION, add a reference to it in PREFERRED_VERSION and adjust the opening statement to read slightly better. (Bitbake rev: b32e6c8d4ea2f83fe77021207e9db883fec82d97) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: document no support for using passwords in git ↵Paul Eggleton2021-04-151-0/+9
| | | | | | | | | | | | URLs This is based on the comment added in revision aded964eed4ce5a725ed1ab477efabc86b1aa481. (Bitbake rev: 082683da089115d8b6f71f221cabb41ac401f733) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: fix syntax error in layer.conf exampleRobert P. J. Day2021-03-221-1/+2
| | | | | | | | | | | 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. (Bitbake rev: 1c2d2875099a3ff9149710d42c679ab31b00f68b) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: fix glossary link for BB_INVALIDCONF variableRobert P. J. Day2021-03-221-1/+1
| | | | | | | (Bitbake rev: 4a4d55c41806815c32add32863a05351a6df30f7) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: mention that addtask handles multiple dependenciesRobert P. J. Day2021-03-221-0/+11
| | | | | | | | | | Add a note explaining that "addtask" can accept multiple dependencies, just in case someone runs across such an example and is confused. (Bitbake rev: 5e4e9acd323b5ebc3a14c07384f6cf8f8a272066) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: move BBFILES_DYNAMIC for alphabetical orderRobert P. J. Day2021-03-151-39/+39
| | | | | | | | | | Since BBFILES_DYNAMIC does not have a "BB_" prefix, it belongs further down in the variable glossary. (Bitbake rev: 493f291601c7680f8b8146f358c545fcb5f53cc9) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: Add AZ_SAS definition to glossaryAlejandro Hernandez Samaniego2021-03-111-0/+13
| | | | | | | (Bitbake rev: 134df841b273d94e767426876459da348d96dd23) Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: Add Az fetcher documentationAlejandro Hernandez Samaniego2021-03-112-0/+30
| | | | | | | (Bitbake rev: e3b480636a3c2716effd619b59cf55e11f9a6db0) Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-worker/runqueue: Add support for BB_DEFAULT_UMASKRichard Purdie2021-02-161-0/+4
| | | | | | | | | | | | | 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. (Bitbake rev: 3e664599fd54a8a37ce587022fcbce5ca26f2ed3) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: remove DocBook filesNicolas Dechesne2020-10-0610-10142/+0
| | | | | | | | | | The BitBake documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. (Bitbake rev: 427721d8ff2c8e1db8cb490074f2eed88d03852a) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: sphinx: replace special quotes with double quotesNicolas Dechesne2020-10-065-9/+9
| | | | | | | (Bitbake rev: c87cc35a5665afbf67f6dbb3458976c215fd5ee3) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: ref-variables: add links to terms in glossaryNicolas Dechesne2020-10-061-122/+122
| | | | | | | | | | This is similar to this change in yocto-docs: 9e468274eaad (docs: ref-manual: ref-variables: add links to terms in glossary) (Bitbake rev: ebdeef2c185465ac9f7d7f01ae9e8531355b9e70) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: fix bad linksNicolas Dechesne2020-09-162-2/+2
| | | | | | | | | | | | 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 (Bitbake rev: 29081375659e3dcf1c578cd98ab2c8a2e9f07ca8) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: last manual round of fixes/improvementsNicolas Dechesne2020-09-166-1170/+1733
| | | | | | | | | | Review all pages, and fix up for formatting which was not covered by pandoc, such as some links and code block sections. (Bitbake rev: d99760cc687cc9c24d6d9a1c49fa094574476e0c) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: bitbake-user-manual: insert additional blank line after titleNicolas Dechesne2020-09-165-0/+10
| | | | | | | (Bitbake rev: 4f94633a68fd44223d6be458fc0d3616dfdfd1a7) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: add SPDX headersNicolas Dechesne2020-09-166-0/+12
| | | | | | | (Bitbake rev: 4e461224c1825ebba6024fb8d962e726598da153) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: fixes all remaining warningsNicolas Dechesne2020-09-163-11/+11
| | | | | | | | | This patch fixes a handful of remaining warnings reported by Sphinx. (Bitbake rev: 35fdc18549607e195d424f554e8d4b74e87fd245) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: fix links inside notesNicolas Dechesne2020-09-163-18/+13
| | | | | | | | | | For some notes with links, the links were lost during the pandoc conversion. (Bitbake rev: e11d2dd1adbcb35b45d6d0f3a47f8d06caab0b49) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: fixup for linksNicolas Dechesne2020-09-166-160/+160
| | | | | | | | | | | | | | | | | | | | | | | | Since we converted the list of variables into a Sphinx glossary, the automatic conversion from Pandoc does not produce proper links. We fix them up using a Python regexp. Similarly some http links were not converted correctly, and can also be fixed up with a regexp. This patch was generated by running the following regexp: line = re.sub("` <(https?://.*)>`__", "\\1", line) line = re.sub("`+(\w+)`* <#var-bb-\\1>`__", ":term:`\\1`", line) (Bitbake rev: 57300955beb200c81762880f44f1a499451b7432) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: bitbake-user-manual: use builtin sphinx glossaryNicolas Dechesne2020-09-161-1202/+1236
| | | | | | | | | | | | | | | | | | | | | | Sphinx has a glossary directive. From the documentation: This directive must contain a reST definition list with terms and definitions. The definitions will then be referencable with the 'term' role. So anywhere in *any* manual, we can do :term:`VAR` to refer to an item from the glossary, and create a link. An HTML anchor is created for each term in the glossary, and can be accessed as: <link>/ref-variables.html#term-<NAME> To convert to a glossary, we needed proper indentation (e.g. added 3 spaces to each line) (Bitbake rev: e8359fd85ce0358019e2a32b4c47ba76613f48f0) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: initial sphinx supportNicolas Dechesne2020-09-166-0/+5178
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit is autogenerated pandoc to generate an inital set of reST files based on DocBook XML files. A .rst file is generated for each .xml files in all manuals with this command: cd <manual> for i in *.xml; do \ pandoc -f docbook -t rst --shift-heading-level-by=-1 \ $i -o $(basename $i .xml).rst \ done The conversion was done with: pandoc 2.9.2.1-91 (Arch Linux). Also created an initial top level index file for each document, and added all 'books' to the top leve index.rst file. The YP manuals layout is organized as: Book Chapter Section Section Section Sphinx uses section headers to create the document structure. ReStructuredText defines sections headers like that: To break longer text up into sections, you use section headers. These are a single line of text (one or more words) with adornment: an underline alone, or an underline and an overline together, in dashes "-----", equals "======", tildes "~~~~~~" or any of the non-alphanumeric characters = - ` : ' " ~ ^ _ * + # < > that you feel comfortable with. An underline-only adornment is distinct from an overline-and-underline adornment using the same character. The underline/overline must be at least as long as the title text. Be consistent, since all sections marked with the same adornment style are deemed to be at the same level: Let's define the following convention when converting from Docbook: Book => overline === (Title) Chapter => overline *** (1.) Section => ==== (1.1) Section => ---- (1.1.1) Section => ~~~~ (1.1.1.1) Section => ^^^^ (1.1.1.1.1) During the conversion with pandoc, we used --shift-heading-level=-1 to convert most of DocBook headings automatically. However with this setting, the Chapter header was removed, so I added it back manually. Without this setting all headings were off by one, which was more difficult to manually fix. At least with this change, we now have the same TOC with Sphinx and DocBook. (Bitbake rev: 6bf6c8d63787aed7624793c24af3fa603b5ac961) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: update perforce fetcher docsAlexandru N. Onea2020-06-251-0/+60
| | | | | | | | | | | | | | This change updates the perforce documentation by describing two new parameters: module and remotepath. Additionally, a general statement regarding the fetcher implementation has been added, to make it clear that the fetcher does not use a perforce client for the job. (Bitbake rev: 44b57216548fa96a5ecab02cfed517e0d631dc44) Signed-off-by: Alexandru N. Onea <onea.alex@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: Add BBFILES_DYNAMICKonrad Weihmann2020-06-231-0/+61
| | | | | | | | | | - add missing entry for BBFILES_DYNAMIC, ported from yocto-docs - add description for the new inverse mode (Bitbake rev: 9186ca47ce73b4d1c87eb69163698a04679fb55c) Signed-off-by: Konrad Weihmann <kweihmann@outlook.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: Remove TERM from BB_HASHBASE_WHITELIST exampleJacob Kroon2020-06-171-1/+1
| | | | | | | | | | TERM is no longer included in OE-Core's default BB_HASHBASE_WHITELIST, so remove it. (Bitbake rev: 7689fa781646039524a655295a884e525ad8732c) Signed-off-by: Jacob Kroon <jacob.kroon@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual-metadata.xml: fix a minor errorKai Kang2020-05-301-1/+1
| | | | | | | | | | In the '_remove' example in bitbake-user-manual-metadata.xml, there is no 'jkl' in the original value of FOO2. So remove it from result. (Bitbake rev: 06b5cf0ab6c6e518ac780d081fab5546334c5c7d) Signed-off-by: Kai Kang <kai.kang@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: More explanation to tasks that recursively depend on themselvesJacob Kroon2020-05-301-6/+8
| | | | | | | (Bitbake rev: c92a266c8e452833f2a590721aa1c2bd6fbeb2e0) Signed-off-by: Jacob Kroon <jacob.kroon@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: Clarify how task dependencies relate to RDEPENDSJacob Kroon2020-05-271-0/+3
| | | | | | | | | | | Clarify that BitBake knows how to map entries defined in the runtime dependency namespace back to build-time dependencies (recipes) in which tasks are defined. (Bitbake rev: caf422435ad64aacbdab8a94da3115599dd0938b) Signed-off-by: Jacob Kroon <jacob.kroon@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user manual: properly tag content as <replaceable>Robert P. J. Day2020-05-211-2/+2
| | | | | | | | | | Tag a couple fields as replaceable to be consistent with rest of manual. (Bitbake rev: 647c13d4ae746a1bb9bd76ff318477dadb4d292f) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: delete reference to obsolete recipe-depends.dotRobert P. J. Day2020-05-051-6/+1
| | | | | | | | | | | | | | | | | | | Given that generation of recipe-depends.dot was removed: commit 4c484cc01e3eee7ab2ab0359fd680b4dbd31dc30 Author: Chen Qi <Qi.Chen@windriver.com> Date: Thu Aug 22 15:52:51 2019 +0800 cooker.py: remove generation of recipe-depends.dot The information of recipe-depends.dot is misleading. delete mention of it from the user manual. (Bitbake rev: 2effbb6e10b07dc12e4ecdf449ca29fc20968c59) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: immediate-variable-expansion: Correct descriptionJacob Kroon2020-03-191-6/+9
| | | | | | | | | | References to undefined variables are preserved as is and do not expand to nothing as in GNU Make. (Bitbake rev: 4780df48d5998d619dc36b699400e344187fc134) Signed-off-by: Jacob Kroon <jacob.kroon@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: Fix order of end tagsJacob Kroon2020-03-191-2/+2
| | | | | | | | | Fixes commit e22565968828c86983162e67f52ebb106242ca76. (Bitbake rev: a37189fbdba399437cb9fcb28aa963515679cc65) Signed-off-by: Jacob Kroon <jacob.kroon@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: Add documentation for BB_LOGCONFIGJoshua Watt2020-03-132-0/+108
| | | | | | | | | | Adds documentation describing how to use the BB_LOGCONFIG variable to enable custom logging. (Bitbake rev: e22565968828c86983162e67f52ebb106242ca76) Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: correct typo of 'BitBack'Robert P. J. Day2020-02-171-1/+1
| | | | | | | (Bitbake rev: 88b8b5f6f17c18f57f8f9f7863483792f29e22ef) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>