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>
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>
Tweaks include:
- hyphenation
- rewording for brevity or clarification
- adding <firstterm> markup where appropriate
(Bitbake rev: bc84ce7e6542dac1a150b9733411190cff591948)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since the proper spelling is, in fact, 'BitBake', might as well make
it consistent throughout the user manual.
(Bitbake rev: 79ada807de0b202c3d568fc4365a1d3f17ba1bce)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The syntax to use multiconfig builds changed from multiconfig:foo:target
to mc:foo:target, change the syntax on bitbakes documentation.
Clarify that BBMULTICONFIG defines additional configurations along with
the one coming from local.conf.
(Bitbake rev: 648ec12d776d801a6839f759975c91a93aa3a36e)
Signed-off-by: Alejandro Enedino Hernandez Samaniego <aehs29@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Nowadays bitbake applies overrides dynamically, not at a single
specific point in time during parsing.
(Bitbake rev: 218431b0f7c97764cb2c0b79a3aadfe2007f490b)
Signed-off-by: Jacob Kroon <jacob.kroon@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The effects of _append/_prepend/_remove are applied when a variable
is expanded, not after parsing has completed.
(Bitbake rev: f9b67433cb4fe5132ab2cf4a9c6bc078b42e1960)
Signed-off-by: Jacob Kroon <jacob.kroon@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12548]
I created a new section titled "Modifying Variable Values" that
provides instruction on how to use the "bitbake -e" command to
be sure your configuration and variable values are as expected.
(Bitbake rev: 5a697957d7687fe2c730896e178f7e1e054fe724)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These have never been used in the BB manual and were an
artifact from copy-and-pasting the poky.ent file from
the main yocto-docs repo to this bb repo when the BB
manual was origially created. They are useless. I have
removed them.
(Bitbake rev: 3aaf8d6569beeee35ef9dc5021c4b1c2b6db7266)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12399]
The bug was to get the BitBake User Manual into the YP Mega-manual.
All the changes here create unique tags used with variables in the
BitBake Manual. Prior to the fix, tags were identical between like
variables in the YP reference manual and the BitBake User Manual.
The reason for this is because when I created the BitBake manual's
glossary, it was a cut-and-paste operation to get the bulk of
the work started. At the time, the BitBake User Manual was not
a part of the Mega-manual. Once we decided to include the
BitBake User Manual as part of the Mega-Manual, building the
mega-manual produced warnings for all these duplicate links.
To fix, I have updated the variable tags in the BitBake User
Manual to use the following form:
'var-bb-<variable_name>'
The tags used in the YP ref-manual follow this form (original):
'var-<variable_name>'
(Bitbake rev: fb6de2057aae3fbdf37f007d2e47794b332020e1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Rendering the manual to its HTML form was collapsing the two
leading and four trailing whitespace characters into single
whitespace characters. I inserted multiple " " strings
to force the spacing to come through.
(Bitbake rev: 701f76f773a6e77258f307a4f8e2ec1a8552f6f3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12390]
Applied some fixes to the variable wildcard support documentation
in the BitBake manual. Wording changes and changes to make links
referencing Python syntax go to version 3 rather than version 2.
(Bitbake rev: 0cfc71d1a342b82781b0ba547421e41f6340902a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12390]
Added specific descriptions for how wildcarding works for a variety
of variables and files (e.g. append files).
(Bitbake rev: 0a4377cb1837ede213d9640344f4908de3689d91)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Contrary to what the manual said, BB_RUNTASK does include the do_
prefix, unlike BB_CURRENTTASK.
(Bitbake rev: 3f4968c77129252e8d0833fbd683372fca243a90)
Signed-off-by: Chris Laplante <chris.laplante@agilent.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
We have some slightly odd behaviours with the current implementation of
_remove operations. For example:
TEST = " A B"
TEST_remove = "C"
would trigger TEST to become "A B" even thought it doesn't contain "C".
In particular, this means that an inactive remove operator added in a
bbappend could change the task checksum which is not desireable.
Fix the operation to preserve whitespace, adding new tests to make this
explict and test further corner cases. Also update the manual to match.
(Bitbake rev: c0a23dd9155c50a6b7df796980bc7b612cac7994)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created a new section to show how to handle dependencies when
you are doing a multiple configuration build. Put it in the
"Examples" section.
(Bitbake rev: fa42212a6cb7b64add4d6ca0f723a95c908c6b87)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The BBMULTICONFIG variable is a variable used for BitBake and was
not documented in the BitBake Manual glossary. I added the
definition. I also added the variable to the example in the section
describing how to execute builds for multiple configurations.
(Bitbake rev: 836f994ec530ba82c935cb41e006d1f128885dc2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created a new example. Also added a figure for the separate
configuration file hierarchy
(Bitbake rev: f2d432674b187685591f60cec3b2980b377c63fe)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
You can now limit on a task-specific basis the number of threads
a task will use. This is useful for machines that have high
numbers of cores and need to be rate-limited due to various
resource constraints.
(Bitbake rev: 4937ed392fdc4442dd91f644f329dda29f27242c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [#YOCTO 12030]
Updated the "Task Checksums and Setscene" section to provide a bit
of user information around the bitbake-dumpsigs use that lets a
user examine signatures and inputs that determine if a do_compile
task is indeed supposed to be run.
Added more explanation of how a user can examine signatures used
to determine if a do_compile task is indeed supposed to be run.
(Bitbake rev: 103bbc6642261cd5da038ba2071621919ee01253)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made sure that the terms "OpenEmbedded-Core" and "OE-Core"
are used as such throughout the manual.
(Bitbake rev: 677e58f8616a4bf58772e54d2313af3885a3b110)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new repo Fetcher section in the same spirit as the existing
sections for other supported fetchers. Changes included the new section,
removal of the bulleted item that mentioned this fetcher as an
"additional" fetcher, and the creation of a new variable in the glossary
named REPODIR.
(Bitbake rev: 1cf084cee506574b7bb6ed03344597b3b2f2fe08)
Signed-off-by: Nicolas Cornu <nicolac76@yahoo.fr>
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11675]
There was a "hambedded" link that was broken. The link was
intended to show the bitbake.conf file. I replaced it
with the link to show the actual bitbake.conf file.
(Bitbake rev: ec0331cc039ab514d719ed34cec7a0a351c8d52b)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
