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: a394eeec6aeb98c6395cb5da2036ce936bdaa0a0)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 5ddf0e5bee0de59d07295fc5693e20b1a0380fde)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This change is not applicable to 1.46/dunfell branch, and was brought
by the automatic backport of Sphinx docs, so let's undo it. Note that
this patch also included a general statement which applies to 1.46, so
this snippet was not removed.
(Bitbake rev: b164cf6790e47271a0848104a6c9507dd35c7f8f)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This change is not applicable to 1.46/dunfell branch, and was brought
by the automatic backport of Sphinx docs, so let's undo it.
(Bitbake rev: 07bc934fab62c0a238ec62a8516396191095a231)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Bitbake manual was migrated to Sphinx in Yocto Project 3.2. Since
the docs between 3.2 and 3.1 are "similar", and since 3.1 is an LTS
release, we agreed to backport the documentation onto 3.1.
If we look at all docs changes in 3.1 and 3.2, we have the following:
=== Changes in 3.1
git log --oneline b94dec477a8d48ebceec91952ba290798c56c1f5..origin/1.46 -- doc/
====
324aaa7f bitbake-user-manual-metadata.xml: fix a minor error
f92e19a3 doc: More explanation to tasks that recursively depend on themselves
e4695176 doc: Clarify how task dependencies relate to RDEPENDS
25c5c79b user manual: properly tag content as <replaceable>
be367887 docs: delete reference to obsolete recipe-depends.dot
=== Changes in 3.2/master
git log --oneline b94dec477a8d48ebceec91952ba290798c56c1f5..origin/master -- doc/
====
a7c47f1e sphinx: rename Makefile.sphinx
427721d8 sphinx: remove DocBook files
d52190ea docs: static: theme_overrides.css: fix responsive design on <640px screens
9ae5cce7 docs: sphinx: report errors when dependencies are not met
ec4c481a docs: update README file after migrationg to Sphinx
c87cc35a docs: sphinx: replace special quotes with double quotes
ebdeef2c docs: ref-variables: add links to terms in glossary
29081375 bitbake-user-manual: fix bad links
a0f37789 sphinx: theme_override: Use bold for emphasis text
cbc5ca48 sphinx: theme_override: properly set font for verbatim text
08b1ae23 sphinx: remove leading '/'
99ba6fe9 sphinx: update style for important, caution and warnings
d99760cc sphinx: last manual round of fixes/improvements
4f94633a sphinx: bitbake-user-manual: insert additional blank line after title
63adcaa5 sphinx: add releases page
3e940d93 sphinx: conf: enable extlinks extension
9921c652 sphinx: index: move the boilerplate at the end of the page
4e461224 sphinx: add SPDX headers
cb19159c sphinx: Enhance the sphinx experience/nagivation with:
10a54678 sphinx: tweak html output a bit
219b2348 sphinx: Makefile.sphinx: add clean and publish targets
35fdc185 sphinx: fixes all remaining warnings
e11d2dd1 sphinx: fix links inside notes
57300955 sphinx: fixup for links
fa304c01 sphinx: override theme CSS
29af1cd2 sphinx: switch to readthedocs theme
e8359fd8 sphinx: bitbake-user-manual: use builtin sphinx glossary
6bf6c8d6 sphinx: initial sphinx support
84ccba0f sphinx: add initial build infrastructure
44b57216 bitbake-user-manual: update perforce fetcher docs
9186ca47 bitbake-user-manual: Add BBFILES_DYNAMIC
7689fa78 bitbake-user-manual: Remove TERM from BB_HASHBASE_WHITELIST example
06b5cf0a bitbake-user-manual-metadata.xml: fix a minor error
c92a266c doc: More explanation to tasks that recursively depend on themselves
caf42243 doc: Clarify how task dependencies relate to RDEPENDS
647c13d4 user manual: properly tag content as <replaceable>
2effbb6e docs: delete reference to obsolete recipe-depends.dot
We can conclude the following commits exist in 3.2 and not in 3.1 (if
we filter out sphinx changes)
44b57216 bitbake-user-manual: update perforce fetcher docs
9186ca47 bitbake-user-manual: Add BBFILES_DYNAMIC
7689fa78 bitbake-user-manual: Remove TERM from BB_HASHBASE_WHITELIST example
Out of these 3 changes, the following patches are for 3.2 only:
44b57216 bitbake-user-manual: update perforce fetcher docs
7689fa78 bitbake-user-manual: Remove TERM from BB_HASHBASE_WHITELIST example
To backport the Sphinx docs, we then need to cherry-pick all docs
patches from 3.2/1.48 and 'undo' the two patches above.
This first patch is the first step that imports all Sphinx files, and
remove Docbook files. It was done with the following command:
git cherry-pick -n \
$(git log --reverse --oneline \
b94dec477a8d48ebceec91952ba290798c56c1f5..origin/master -- doc/ \
| cut -f1 -d' ')
(Bitbake rev: cd68f14031eb45006b44d10b348e35c69ac21ad0)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
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: c27a5cc80852595549ad4156e4bb7f5a05e4cd15)
Signed-off-by: Konrad Weihmann <kweihmann@outlook.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 9186ca47ce73b4d1c87eb69163698a04679fb55c)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
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: 324aaa7f8d6d83e1e00b8054dac44df561588be8)
Signed-off-by: Kai Kang <kai.kang@windriver.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 06b5cf0ab6c6e518ac780d081fab5546334c5c7d)
Signed-off-by: Steve Sakoman <steve@sakoman.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: e4695176ffdc5eb959f71a08f77ff6a8e028ffa9)
Signed-off-by: Jacob Kroon <jacob.kroon@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit caf422435ad64aacbdab8a94da3115599dd0938b)
Signed-off-by: Steve Sakoman <steve@sakoman.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: 25c5c79bbe814eaff03c72cc2680414a73cff7f4)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 647c13d4ae746a1bb9bd76ff318477dadb4d292f)
Signed-off-by: Steve Sakoman <steve@sakoman.com>
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: be367887b0a729ef01fc04f2b91368612ed92ed3)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 2effbb6e10b07dc12e4ecdf449ca29fc20968c59)
Signed-off-by: Steve Sakoman <steve@sakoman.com>
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>
BitBake now fires off one "BuildStarted" event per configuration when
it is configured for multiple configurations (multiconfig). I updated
the bullet item for "bb.envent.BuildStarted()" to indicate that
behavior.
(Bitbake rev: 28720c85e64a56677b71d2170a0a07901d52b180)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
