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>
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>
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 rev: 4a4d55c41806815c32add32863a05351a6df30f7)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
>From sphinx-build man page:
-j N build in parallel with N processes where possible
(special value "auto" will set N to cpu-count)
(Bitbake rev: e0d08058d849cb28cd70ade0cb35863a91019353)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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.
(Bitbake rev: 5ddf0e5bee0de59d07295fc5693e20b1a0380fde)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Now that the DocBook files are removed, we can rename the top level
Makefile.
(Bitbake rev: a7c47f1eac8caac607a2b5f12d07235dff4d740f)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
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>
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.
(Bitbake rev: d52190ea426d961f609c657dcb403baf59352969)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
This more closely matches the original docbook style and is appropriate
given the way the manual uses this element.
(Bitbake rev: a0f37789493aeb1cd5e82c17459bfa4cf6c0ecd6)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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.
(Bitbake rev: cbc5ca48c7e79c47f055a47f8f9aa480490dd00f)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
(Bitbake rev: 08b1ae2350694e22883e07605a28a10c05f62cda)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The initial theme override covers for tip and and note only.
(Bitbake rev: 99ba6fe98b9c7c4dbe70dce63c478c167c10d91a)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
This page has a list of all the previously released Bitbake user manual.
(Bitbake rev: 63adcaa527b931f4a9494729b26e40ddef8d3695)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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
(Bitbake rev: cb19159cf8972713a2063387849804c5cea72d24)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Remove the 'generated by Sphinx' text on each page
* Add a 'last updated timestamp' on each page
* Remove the trailing 'dot' in TOC numbering
(Bitbake rev: 10a54678bf7a119e91df8160b0f43384181d636d)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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.
(Bitbake rev: fa304c0129538d7a0b7a3922cd1fde2e242d6cab)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
To install this additional theme:
pip3 install sphinx_rtd_theme
(Bitbake rev: 29af1cd2a4f379096f5dd6f4cacc0a9c9f211e7c)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
Used sphinx-quickstart to generate top level config and
Makefile.sphinx, to allow side by side DocBook and Sphinx
co-existence.
(Bitbake rev: 84ccba0f4aff91528f764523fe1205a354c889ed)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
- 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>
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>
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>
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>
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>
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>
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>
