aboutsummaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* bitbake-user-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entryPaul Eggleton2021-04-151-2/+16
| | | | | | | | 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>
* bitbake-user-manual: document no support for using passwords in git URLsPaul Eggleton2021-04-151-0/+9
| | | | | | | | 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>
* 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. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* doc: fix glossary link for BB_INVALIDCONF variableRobert P. J. Day2021-03-221-1/+1
| | | | | Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: Add AZ_SAS definition to glossaryAlejandro Hernandez Samaniego2021-03-111-0/+13
| | | | | Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: Add Az fetcher documentationAlejandro Hernandez Samaniego2021-03-112-0/+30
| | | | | Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: Makefile: enable parallel buildNicolas Dechesne2020-11-231-1/+1
| | | | | | | | | | >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>
* doc/conf.py: add missing import sysMert Kirpici2020-11-201-0/+1
| | | | | | | | | 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>
* sphinx: rename Makefile.sphinxNicolas Dechesne2020-10-052-4/+4
| | | | | | | Now that the DocBook files are removed, we can rename the top level Makefile. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: remove DocBook filesNicolas Dechesne2020-10-0525-11898/+0
| | | | | | | The BitBake documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* docs: static: theme_overrides.css: fix responsive design on <640px screensQuentin Schulz2020-10-051-2/+0
| | | | | | | | | 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>
* docs: sphinx: report errors when dependencies are not metNicolas Dechesne2020-10-052-1/+11
| | | | Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* docs: update README file after migrationg to SphinxNicolas Dechesne2020-10-051-17/+33
| | | | Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* docs: sphinx: replace special quotes with double quotesNicolas Dechesne2020-10-055-9/+9
| | | | Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* docs: ref-variables: add links to terms in glossaryNicolas Dechesne2020-10-051-122/+122
| | | | | | | 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>
* 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 Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: theme_override: Use bold for emphasis textRichard Purdie2020-09-161-0/+4
| | | | | | | 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>
* sphinx: theme_override: properly set font for verbatim textNicolas Dechesne2020-09-161-0/+5
| | | | | | | | | | | 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>
* sphinx: remove leading '/'Nicolas Dechesne2020-09-161-3/+3
| | | | | | | | 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>
* sphinx: update style for important, caution and warningsNicolas Dechesne2020-09-161-2/+11
| | | | | | The initial theme override covers for tip and and note only. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* 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. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: bitbake-user-manual: insert additional blank line after titleNicolas Dechesne2020-09-165-0/+10
| | | | Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: add releases pageNicolas Dechesne2020-09-162-0/+131
| | | | | | This page has a list of all the previously released Bitbake user manual. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: conf: enable extlinks extensionNicolas Dechesne2020-09-161-0/+6
| | | | Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: index: move the boilerplate at the end of the pageNicolas Dechesne2020-09-161-10/+14
| | | | Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: add SPDX headersNicolas Dechesne2020-09-167-0/+14
| | | | Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: Enhance the sphinx experience/nagivation with:Richard Purdie2020-09-164-0/+264
| | | | | | | | | * Remove the pointless looking parts of breadcrumb navigtation * Add a document type switcher to the breadcrumb navigation * Add a version selection switch to the breadcrumb navigation Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: tweak html output a bitNicolas Dechesne2020-09-161-5/+11
| | | | | | | | * Remove the 'generated by Sphinx' text on each page * Add a 'last updated timestamp' on each page * Remove the trailing 'dot' in TOC numbering Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: Makefile.sphinx: add clean and publish targetsNicolas Dechesne2020-09-161-1/+12
| | | | Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: fixes all remaining warningsNicolas Dechesne2020-09-163-11/+11
| | | | | | This patch fixes a handful of remaining warnings reported by Sphinx. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: fix links inside notesNicolas Dechesne2020-09-163-18/+13
| | | | | | | For some notes with links, the links were lost during the pandoc conversion. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* 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) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: override theme CSSNicolas Dechesne2020-09-162-1/+153
| | | | | | | | | | It is possible to override CSS settings from the theme, by providing custom snippets of CSS stylesheet. Support for that is added in conf.py file. Most of the CSS customization is inherited from the DocBook CSS style. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: switch to readthedocs themeNicolas Dechesne2020-09-161-1/+1
| | | | | | | To install this additional theme: pip3 install sphinx_rtd_theme Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* 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) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: initial sphinx supportNicolas Dechesne2020-09-167-6/+5204
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* sphinx: add initial build infrastructureNicolas Dechesne2020-09-165-0/+101
| | | | | | | | Used sphinx-quickstart to generate top level config and Makefile.sphinx, to allow side by side DocBook and Sphinx co-existence. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
* bitbake-user-manual: update perforce fetcher docsAlexandru N. Onea2020-06-231-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. Signed-off-by: Alexandru N. Onea <onea.alex@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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 Signed-off-by: Konrad Weihmann <kweihmann@outlook.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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. Signed-off-by: Jacob Kroon <jacob.kroon@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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. Signed-off-by: Kai Kang <kai.kang@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* doc: More explanation to tasks that recursively depend on themselvesJacob Kroon2020-05-281-6/+8
| | | | | Signed-off-by: Jacob Kroon <jacob.kroon@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* doc: Clarify how task dependencies relate to RDEPENDSJacob Kroon2020-05-261-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. Signed-off-by: Jacob Kroon <jacob.kroon@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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. Signed-off-by: Jacob Kroon <jacob.kroon@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake-user-manual: Fix order of end tagsJacob Kroon2020-03-191-2/+2
| | | | | | | Fixes commit e22565968828c86983162e67f52ebb106242ca76. Signed-off-by: Jacob Kroon <jacob.kroon@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>