This variable was added by commit 3338330e0c46 ("u-boot: Add specifying
make options as part the config looping") in OE-Core. Document how to
use the option in UBOOT_CONFIG.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 0fc14dca55d3760491cc40ac8c136c9dbdd23dbb)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Part of bitbake.conf, this variable allowing to enable or disable
translation was undocumented. Add a entry to the glossary.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 92a55345a56b5038c0344669daaa7a3a99dd0fc0)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Very similar to REQUIRED_DISTRO_FEATURES, added by commit a8ef7339ecb9
("features_check.bbclass: Add support for required TUNE_FEATURES") in
OE-Core.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 9652c101092c34233f00418fcc2a84a86fbc9a9b)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Can be used in recipes that want to explicitly skip Ccache support when
the ccache class is enabled.
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: b1b4adc8d4d9d23ff6fd91bca632bb0f5277e72b)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable does not apply to the scope of a single recipe, but rather
to the scope of the entire layer.
(From yocto-docs rev: eec26e11adb6e3a9c4f53f825b9a1730c9ddee12)
Signed-off-by: João Marcos Costa <joaomarcos.costa@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There is no single "recipe-sysroots" directory, but rather many
"recipe-sysroot*" directories.
(From yocto-docs rev: f2d6e228409cb1dd1dbf339c405699ac6d3900be)
Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- terms.rst: Provide the definitions of a Configuration Fragment and a
Built-in Fragment.
- ref-manual: Add a quick reference guide on bitbake-config-build, and
list the available fragments in OE-Core.
Document the underlying variables related to fragments in the
glossary.
- dev-manual: give instructions on how to create new custom fragments.
(From yocto-docs rev: 0820b71c830cab4151b0219b6d4013c41f461c6e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There's a (second) overhead factor applied in images generated with Wic,
and this is already documented in the .wks reference. However, the
IMAGE_OVERHEAD_FACTOR entry does not mention it, and by looking at the
partition sizes (e.g. with parted) one may find it confusing that they
don't match with the expected rootfs size (e.g. in a scenario where the
extra space is "0" and IMAGE_OVERHEAD_FACTOR="1.0").
This second overhead is already documented, though:
https://docs.yoctoproject.org/ref-manual/kickstart.html#command-part-or-partition
Mention the '--overhead-factor' option in the glossary entry and add a
reference to the wks documentation.
(From yocto-docs rev: b9040e20b015e9b02683ec3014e4ade5eb59d41a)
Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
documentation/scripts/check-glossaries returns:
WARNING: ref-manual/variables.rst: The variable EFI_PROVIDER shouldn't be in the glossary.
WARNING: ref-manual/variables.rst: The variable ZSTD_THREADS shouldn't be in the glossary.
(From yocto-docs rev: 4d3952414d109f9c9ebb029f3e20018664eacc86)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Instead of tracking the glossary manually, add a small script that
checks if it is properly sorted.
Add two comments between the start and end of the glossary for the
script to know where it's located.
The script also checks if the variables are properly sorted. It uses
difflib and returns the diff if there's a difference between the
unsorted and sorted list.
Messages beginning with "WARNING:" are reported by the Autobuilder,
which is the reason for this format.
(From yocto-docs rev: 416d50c0c322eb88bf13353a198db7211e4d665a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since commit 24772dd2ae6c ("parse/ConfHandler: Add warning for
deprecated whitespace usage") in BitBake, a warning is printed when
there are no spaces around an `=` assignment.
Adjust the documentation to show good examples only.
(From yocto-docs rev: 77ce1544dd793036b1135817c02e090138fe6407)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
WIC plugins were renamed after commit 2de444fc3ef4 ("wic: plugins source
bootimage/isoimage rename to allow be imported") in OE-Core. They no
longer contain dashes, but underscores.
(From yocto-docs rev: 7224d7733e9e0f423475e1b9c5b48aff0de1f744)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added by commit c0fa3d92cefa ("spdx30: Allow VEX Justification to be
configurable") in OE-Core.
(From yocto-docs rev: cee3eb30cc736d990f2232ede0bc6d9686a63713)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable is part of uboot-sign but not documented.
(From yocto-docs rev: 05eb461cb1da76ad9cbaf634da7f47447b3f6765)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added by commit 8e741b2e885a ("ast/BBHandler: Add support for
BB_DEFER_BBCLASSES") in BitBake.
(From yocto-docs rev: bf3c2ade55e4d90dd50f39d01405352cd48c1703)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added by commit 7892ee3dc37d ("kernel-fitimage: allow overriding FIT
configuration prefix") in OE-Core, but never documented.
(From yocto-docs rev: 860891492b96eb127af5e7bab6348fca12167c68)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Dropped by commit ecf8c386cf83 ("classes/recipes-devtools: Drop icecc
from OE-Core") in OE-Core.
Remove documentation for the class and the related variables. Remove the
references to this class.
(From yocto-docs rev: 30c9413c5106bcbcc1600ef16b8d0cece86d8158)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added by commit 2502da81709f ("bitbake.conf/pseudo: Switch from
exclusion list to inclusion list") in OE-Core.
(From yocto-docs rev: 5fc49ee007d22c7dc28c11ea579c804881b9cb8f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The TESTSDK_SUITES variable can be used to control the list of test
modules run with the testsdk class.
(From yocto-docs rev: fbc6db0ab525c7e46774c01fc595f30d6d0fe3c1)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The KMETA_CONFIG_FEATURES variable defines kernel-yocto features to
enable.
(From yocto-docs rev: 1a9f68b875a78c1c7681ed300111399de97631e6)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document the new classes under classes/toolchain as well as
PREFERRED_TOOLCHAIN* and TOOLCHAIN variables, which allow selecting the
toolchain. For now there's "gcc" and "clang" as available toolchain.
(From yocto-docs rev: 69a9568f8bd7ed57efddab507a4294ad3408f4dd)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The tar packaging format was removed some time ago. Also, add some
minor grammatical tweaking.
(From yocto-docs rev: 8e9fd1ca232f3c1e8be51cb881a68b4745ee548a)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For host resource limiting variables, make a reference to the new
"Limiting the Host Resources Usage" document.
(From yocto-docs rev: 161a8549441e8c38791ab7f63001b2a15a39d2f2)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adding documentation for the new feature to store in SPDX
only the compiled sources.
Merged in oe-core: c6a2f1fca76fae4c3ea471a0c63d0b453beea968
- spdx: add option to include only compiled sources
CC: Antonin Godard <antonin.godard@bootlin.com>
(From yocto-docs rev: 4dbc63ed1381fe47723d6ba5b7baf2a3b7fd19aa)
Signed-off-by: Daniel Turull <daniel.turull@ericsson.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This makes all :doc: directives use an absolute paths (with the root
directory being documentation/ in the repo).
This is then consistent across the whole source and is easier to review
and move files around, you just need to know where a file is located
relative to documentation/ directory and use that.
This gets rid of paths looking in parent directory with '..' as well as
expecting a file to be in the same directory as the other file it points
to via the :doc: directive.
(From yocto-docs rev: b9457f2005b0bea49c54e9727eb30e9458084886)
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
KCONFIG_MODE defaults to 'allnoconfig' when not set, regardless of whether
KBUILD_DEFCONFIG points to an in-tree or a meta-layer defconfig.
(From yocto-docs rev: f374b9c426f6c10710e011a4ad660231ee26efb8)
Signed-off-by: Carlos Sánchez de La Lama <csanchezdll@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The project is switching the way handle our CDN provision of sstate objects,
update the URL accordingly.
(From yocto-docs rev: 406e8a8e30404c0538f5aa46f211540bae2b206b)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add documentation for the UBOOT_FIT_CONF_FIRMWARE variable, which allows
users to specify an image to be assigned to the "firmware" property of
the FIT configuration node. This explicitly defines the primary image
to boot, instead of relying on the first entry in the "loadables" list.
(From yocto-docs rev: f72fc69e2d2a074d5eaf1cc36b30726de58e3ab5)
Signed-off-by: Jamin Lin <jamin_lin@aspeedtech.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fix as many instances of unbalanced-inline-literals-delimiters as reported
by 'make sphinx-lint' as possible. Sphinx and/or its linter seem to get
tripped up randomly when references contain links to a heading which
contain literals enclosed in double-back-tics; especially in the cases
where a heading either contains multiple literals or when the literal is
not at the end of the heading. Not all of them can be "fixed" to pass both
building and linting.
(From yocto-docs rev: 3460177c46d360b0f2f852cdab23f21bd4ec6d5a)
Signed-off-by: Trevor Woerner <twoerner@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
