- Add COMMERCIAL_[AUDIO|VIDEO]_PLUGINS variables to the
variable index.
- Clarify that these plugins are still open-source
- Improve line width
(From yocto-docs rev: 8b161faad6b698b33165f02e1f5e78a693c7817b)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since release 4.1, the variable DEV_PKG_DEPENDENCY sets RRECOMMENDS instead
of RDEPENDS for the -dev package on the main package, this change fixes the
documentation to match the actual state
Reviewed-by: Yoann CONGAL <yoann.congal@smile.fr>
(From yocto-docs rev: 0e0790e7bcf4ee2d31301b4351528eb124a1fe98)
Signed-off-by: Fawzi KHABER <fawzi.khaber@smile.fr>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Although in the example case of a "raspberrypi2" the variable KMACHINE has the
same value as MACHINE, only the latter is an allowed override. So do not set the
reader on the wrong track.
Suggested-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
(From yocto-docs rev: 565ebcfe3ed68a9ea036f11cddafb36023f72099)
Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Additionally use more common syntax to indicate that an actual machine name is
supposed to be filled in for a concrete use case as has been suggested by Peter
Kjellerstedt (and particularly no KMACHINE). Furthermore add missing quotes in
the reference manual.
Suggested-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
(From yocto-docs rev: b66c035970f860b65cf712285f2d5a023620e6c3)
Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These :yocto_docs: references were making external references
to another section of the manual, using the https://docs.yoctoproject.org
website. It's actually better to use internal references (:doc: for an
entire document, and :ref: for a specific section, as they will cause
an error in Sphinx if one day they are no longer valid.
(From yocto-docs rev: 0beff9dea986a2ea4b496180b29a99490416eeeb)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
OE-Core rev f1257d61b76d027d4ece734439993b6bf4e48907 introduced support
for using lzo as compression algorithm for fitImage contained kernel
images.
This patch adds the corresponding documentation to FIT_KERNEL_COMP_ALG
and FIT_KERNEL_COMP_ALG_EXTENSION.
(From yocto-docs rev: aba0ab326ea72ff10492e73b452b51d1beaa50d6)
Signed-off-by: Richard Leitner <dev@g0hl1n.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Now that .bbclass is removed from class section titles.
We can now have, for example, :ref:`ref-classes-insane`
instead of :ref:`insane <ref-classes-insane>`.
Then, when necessary, rework paragraphs so that they
have lines of even length, not exceeding 80 characters.
(From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using "#." instead of "1.", "2.", "3.", etc.
(From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Remove the redundant FAQ entry about this topic,
already covered in a specific section of the Development Tasks manual
- Document the TOOLCHAIN_LOCATION variable
- Expand both the Development Tasks manual and
the TCMODE variable description using details from the FAQ entry.
- Mention the "meta-arm-toolchain" layer too.
(From yocto-docs rev: 53faa54a8e6311b4d3d41d96cb1a497d0f6502fb)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Now part of the Yocto Project manual.
(From yocto-docs rev: fe23084f746f0959afbf7d4a49e00299e39fba09)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixing double colons appearing alone on a line, while
they could be put at the end of the previous line.
Sometimes placing a note after the quoted text
to avoid such a situation. It's more natural too
not to have a note between the introduction text
and the quoted section.
(From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This makes the Yocto Project manual variable list and index more useful,
not missing any potentially useful variable.
The price to pay is that a reference to such variables now has to go through
the intermediate reference in the Yocto Project variable list, instead
of going straight to the Bitbake manual.
(From yocto-docs rev: 3d308812cd9aa906890a0f8562fc28c1cd8aaab6)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A 500 KB source file is always harder to manage,
and can have section title conflicts.
So, the "Common Tasks" document is gone and all
its constituents are moved up one level.
You now have 40 chapters in the Development Tasks Manual.
(From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Nothing wrong with this word, but instances of "inherit"
were looked for while looking for class names without references.
Fixing alignment and sometimes syntax.
(From yocto-docs rev: c418c645a360e74ebb91765a3041336f03097e0d)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Explain that this variable apply not only to make, but also
to ninja, and to other build tools which support parallel jobs.
(From yocto-docs rev: d3fe2aba3948040a01b9068df5085453ad65309c)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Explain that reducing its value to reduce system load
is not sufficient if PARALLEL_MAKE is not reduced as well.
(From yocto-docs rev: f4986faa5576ec1c146e606220421a686c4a9b57)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replace instances of "Build Directory" and "build directory"
(when applicable) by :term:`Build Directory` as already
done in most places.
Doing this, fix the indentation of the paragraphs with
this term.
(From yocto-docs rev: dce50679242d39f133e0cde5c8483b5e69f3eb54)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Related to cve-check.bbclass.
(From yocto-docs rev: 1218775a9b32ac16556645c5d186007c19a5baf4)
Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable in 4.1.
(From yocto-docs rev: 105a44efe290ac36a370a4946aadc2e046a86e64)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The overlayfs class was added in the honister release.
(From yocto-docs rev: cff6b5a167d8f7d99a351c7989bc86af5e553552)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Not new in 4.1, but the syntax and usage in packagegroup-base is.
(From yocto-docs rev: 01f8393989528ed655fd20338c8764ac12bba010)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable in 4.1.
(From yocto-docs rev: a410d4b7a5cd38badc318508f003e3151846776e)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These were supported in releases prior to 4.1.
(From yocto-docs rev: 86f367fc9946904b5056fb86fb2cc339a0f96b0a)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a note to the COMPLEMENTARY_GLOB variable glossary entry mentioning
that recommends aren't installed (since this seems to be the only place
that complementary package installation is really discussed). Also turn
the paragraph about globbing into a regular paragraph as I don't think
it should be called out in a note block.
(From yocto-docs rev: abc67b101b0821b174eb65bc13922a8bee1016eb)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Make reference to meta/classes* instead of just meta/classes
* Update each reference to the path where the class has moved
* Add a brief explanation to the classes reference explaining the split
* Add a note to INHERIT, INHERIT_DISTRO, IMAGE_CLASSES and USER_CLASSES
variable glossary entries mentioning where the specified classes must
be located. I contemplated adding the same note to PACKAGE_CLASSES
but decided against it, as it has a very specific usage and such a
note might distract from the narrative of that entry.
* Also trim the IMAGE_CLASSES entry which was quite outdated.
* INHERIT += no longer works with testimage so drop the note about that
(From yocto-docs rev: e76bed00b452d3049f6c22afbfb980b557a141bd)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
testimage-auto was removed in the thud release.
(From yocto-docs rev: 618351169c09470280aeee53a63aba88788efc4b)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable for 4.1.
(From yocto-docs rev: 91c6c3dcb36e52e276f000b0e60aba02d546e994)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable in 4.1.
(From yocto-docs rev: efd1a6f5d13a031c0c093bbcfb4bcf935e37ed25)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable in 4.1.
(From yocto-docs rev: 580e0f3b23ee3a553ffc797b97c5b146316e32e4)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable in 4.1.
(From yocto-docs rev: 78199299405ae0ed3da543773859dc6309144cf6)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable in 4.1.
(From yocto-docs rev: ddf89c32f774bf6217c9bf02fa07603bf0fcfc4e)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In 4.1 the pypi class has been updated to set a default CVE_PRODUCT
value.
(From yocto-docs rev: e4b25d6790c3966bad3c63818729c1baaf2b3ca9)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add missing documentation for the pypi class.
(From yocto-docs rev: d387ca891ad3a7d00ec3cb5f994dc5832c885d54)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable in 4.1.
(From yocto-docs rev: d8d9f9fb8b8acc47888cc61fa5565806b100eba4)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable in 4.1.
(From yocto-docs rev: 5be23dc56574697cf18cbc4f3b7130cefe84abfd)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable in 4.1.
(From yocto-docs rev: d79c1c29607bc3750bcb4e4c171593f4d7ac89cb)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Newly added class in 4.1.
(From yocto-docs rev: 391750e417d7a6b88222e03aa0a57ea87d9f618a)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The default changed to "1" back in 2017 (OE-Core revision
8018a2349b7ad5ab27731c93a49603adf5f72fc2). It seems I missed updating
the documentation to match.
(From yocto-docs rev: f5eb40a361661d8399c5bafeda3e76ed45d0e3fb)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In 4.1 the WATCHDOG_TIMEOUT variable is now used in two places, so let's
actually document it.
(From yocto-docs rev: c8e51a968a5942cd153dd4bcf82ba9d1cc5340c0)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Expand the documentation on the image-buildinfo class, and add variable
glossary entries for IMAGE_BUILDINFO_FILE, IMAGE_BUILDINFO_VARS and
SDK_BUILDINFO_FILE (latter is new in 4.1).
(From yocto-docs rev: f69b2f614aaa56a19432538cb1adf33a441ea31d)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was added all the way back in krogoth.
(From yocto-docs rev: 932870c5746718fb6ac3073bb4c79f4e085b089f)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using a reference to "do_package_write_deb", the first entry
in the list.
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 237cebcfa6215d75bbe28df677f18ebf7e1bb4f6)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Create a new entry in the glossary
- Add implementation details
- Replace the mention of "init ramdisk" by "initramfs¨
whenever possible
- Remove obsolete and duplicate information
- Fix spacing issues in the Sphinx code
(From yocto-docs rev: 952c7e6dee49532705b2c162f4728e635c38df3f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As reported in [YOCTO #14502], the description of BBPATH in the
Yocto Project Manual is redundant with its description in the
BitBake User Manual.
(From yocto-docs rev: 5feb4e174e0aec6a48b1131889a5b8547b9b9921)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable is used to denote the C/C++ compiler runtime to use.
Right now there are few alternatives out of the core which could
use this variable to define this property, the values it can take
are 'gnu' for gcc runtime. 'llvm' for using compiler-rt+libc++ and
'android' to use android runtime. Default settings is to use gnu
which is current silent default also.
(From yocto-docs rev: 9094510e08b3a7b215b0d3ebecf66475a57b4c7e)
Signed-off-by: Khem Raj <raj.khem@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The templates have recently been moved by meta-yocto's commit [1].
Clean up some whitespace issues along the way.
[1] 29608bd03e1b ("meta-poky/conf: move default templates to conf/templates/default/")
(From yocto-docs rev: 661c554224dd79e79afd22b84608e248d3336aac)
Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Literal blocks make sphinx take their text verbatim. This means that
directives cannot be used in literal blocks. This means :term:`S` was
printed as-is, without actually creating a link to the S variable
definition as would be expected outside of literal blocks.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: ca5e076a413b0e1241eefdfccfee5bfa652cf6f8)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable has been obsoleted, so remove it from the documentation.
(From yocto-docs rev: 30ed4323e7fb482e4f6f47755314354a2e5e3871)
(From yocto-docs rev: afa895871e8ec18f4861f48f70b8a54cc2e4cb98)
Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fix some hyphens being improperly used as em dashes.
See https://www.grammarly.com/blog/hyphens-and-dashes/
Using em dashes may also allow Sphinx to hyphenate
and break lines in the best way.
Note that the first character after an em dash not
supposed to be capitalized, unless a specific
rule applies, typically when what follows is a proper noun.
Fix a few misuses of parentheses in following text.
(From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Make DISTRO_FEATURES description more explicit by specifying
that DISTRO_FEATURES alone can't select build configurations,
and need mechanisms like PACKAGECONFIG setup to take care of
selecting build configurations.
Signed-off-by Aatir Manzur <aatrapps@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
(From yocto-docs rev: 4b39a4434ee658512050c50f6ebd5ad5dc900fb1)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
[YOCTO #14660]
(From yocto-docs rev: d5bcdf9a8b357b96656b62c41834410e662d8546)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Multiconfigs now work from layers. Update the documentation to match this change.
Also fix a incorrect reference to different distros working within the same TMPDIR,
that is incorrect.
[YOCTO #13566]
(From yocto-docs rev: cb35f75bfc98c9098f9af64b9dd040b25779da36)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add detail that package overrides are only available if
specified in SYSTEMD_PACKAGES.
(From yocto-docs rev: 9466c0b79348e68b1db7aefd3d95f8e7c903f1d4)
Signed-off-by: Paulo Neves <ptsneves@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
State that SYSTEMD_SERVICE allows for multiple space
separated systemd services
(From yocto-docs rev: 68f7009b06007b925e7a5b6ab085ec813d85b0bc)
Signed-off-by: Paulo Neves <ptsneves@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add it to the variable index
Misc improvements to the documentation for this variable
(From yocto-docs rev: fb460a7c7aba1ad5754806f9cfad9ef591420317)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Using "BitBake" instead of "Bitbake" or "bitbake", aligning with the
title of the "BitBake User Manual".
- Using "OpenEmbedded" instead of "Openembedded"
- Using "Python" instead of "python"
(From yocto-docs rev: 0b893e2a15aefedd7100445fc9d7eeed07b6afc6)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add examples for hashed hardcoded passwords from extrausers.bbclass so
that this feature is not hidden away.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 5db73c7c5668144ed4629f95378e44f0bd8c8256)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
ZSTD_THREADS is new for kirkstone.
(From yocto-docs rev: b970936b89bebb184c82be3a9514a9eba7c04f9b)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
XZ_THREADS and XZ_MEMLIMIT were introduced in dunfell.
[RP improved an original patch from Paul]
(From yocto-docs rev: 96defb66b775093b5270bd1ebad0461c2bba1e5b)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This check is new in kirkstone.
(From yocto-docs rev: baa483e75538013be3261f8c115b8a5364b24c60)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable in kirkstone.
(From yocto-docs rev: 2c5d4938a09fd35f9e86f682cde89d4693762725)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add this since the INCOMPATIBLE_LICENSE wildcard support has changed in
the 4.0 release.
(From yocto-docs rev: c7946863e5a9d62a49131b92cc9549da9b799bbd)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The AVAILABLE_LICENSES variable has been removed from OE-Core.
(From yocto-docs rev: dd687b10e1a21222e8dcc3be29635fd3200a205b)
Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add new PEP517_* variables, remove obsolete variables, and update for
renamed classes.
(From yocto-docs rev: 3984d4d0804125ba6fba7bf712edb81f97b4bec7)
Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
By alphabetical order, to get the same order as in the HTML
output, sorted thanks to the ":sorted:" directive.
That was needed after the recent variable renaming for
inclusive language, but other variables were already
out of order anyway.
(From yocto-docs rev: 371c30d2f95fa32239c82d4ad8a6329ab191acca)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As already done in the BitBake manual.
Even though we're trying to keep the variable
definitions in alphabetical order, it's useful
to make sure that the variables are ordered in the
generated output.
(From yocto-docs rev: a43887858f46d2870443f7664487a36def23a90e)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A number of classes and variables have been renamed, so update the
documentation as needed.
(From yocto-docs rev: 35b2e1757f5f2f09bb899ed24ffea50e5041b471)
Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes identified by OE core's
scripts/contrib/convert-variable-renames.py script
Original variable names are kept in old migration notes,
but references to the new ones are provided.
(From yocto-docs rev: 1a35380ca80509fee036018a2bbb22ba9b44d47a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Branch information is now mandatory for git:// and gitsm:// URIs
(From yocto-docs rev: b862655d812e358dd15b06c0548a276a90666423)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This has recently been changed in expand_wildcard_licenses().
(file: OECORE/meta/classes/license.bbclass).
(From yocto-docs rev: 5121da30350a4edeef07f6722222c9e364617f0e)
Signed-off-by: Christian Eggers <ceggers@arri.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This change better aligns the name of the variable with its
purpose. Since we removed the older class, the associated
documentation is also removed.
(From yocto-docs rev: aa136a0fb552339db5475fff7947d2248f8af3e1)
Signed-off-by: Saul Wold <saul.wold@windriver.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixing documentation and updating examples containing "prelink"
in their output.
(From yocto-docs rev: 8927b8fff55fac1bd1fefcff2d16141dbd1ebc51)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add the new variables used to install Python `wheel` binary archives:
* PIP_INSTALL_ARGS
* PIP_INSTALL_DIST_PATH
* PIP_INSTALL_PACKAGE
* PYPA_WHEEL
(From yocto-docs rev: cb213b5682e37873ac0ec457d6f5a52639c4b24a)
Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The distutils*.bbclasses have been moved to meta-python, so remove
mention of them from ref-manual/variables.rst
(From yocto-docs rev: af3d465c5d50edd27957c205dd26aae6843ee3b2)
Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is similar to the recent change in meta to only use SPDX license
identifiers in the recipes.
(From yocto-docs rev: 147ce973d08f0bfb59b7b87fec8c8cc997d57112)
Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since commit 98b3ed1b2e "meta/scripts: Handle bitbake variable
renaming", the new name of the variable is BB_BASEHASH_IGNORE_VARS
so let's update it so that Sphinx can resolve the Bitbake reference.
Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: a6c6283e9cc30ca580f1719d8e22fca5f79c1e50)
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since commit 044fb04d in bitbake (fetch2: Allow whitespace only mirror
entries) there is no need to separate the entries in SSTATE_MIRRORS
with "\n".
(From yocto-docs rev: 87b34b69b2df72d4e6edbd81839622fffd560331)
Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Stop mentioning the long gone POKYLIBC variable and fix punctuation
(From yocto-docs rev: d90be3bbfd45317ce07d1715af3d65ffb1e24ac7)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
dev-manual/common-tasks.rst: Add section to create an initramfs
image from a separate multiconfig.
ref-manual/variables.rst: Add new variable definitions for
INITRAMFS_DEPLOY_DIR_IMAGE and INITRAMFS_MULTICONFIG
(From yocto-docs rev: 7853ab3df82c27ba309879a66a084b2e597dc1e5)
Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Both http and https work, but https should raise fewer questions
from users.
(From yocto-docs rev: e3bf892b1328b5c43ab041ba6c850e2782f54bdf)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Simplify references to class sections, by replacing references such as
:ref:`image.bbclass <ref-classes-image>`
by
:ref:`ref-classes-image`
That's equivalent, because the class sections always called <class>.bbclass
- Adding references to class sections, by replacing strings such as
``image.bbclass``
by
:ref:`ref-classes-image`
- Simplifying a few class section links
(From yocto-docs rev: 29d66aaa898390c19f121baf0f4fdcc178e4cd80)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Following their removal from openembedded-core
(From yocto-docs rev: bf98f5a15c33e75315cd14e653f253ef078da614)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add SETUPTOOLS_BUILD_ARGS variable which can be used to pass additional
arguments to `setup.py build`.
Add SETUPTOOLS_INSTALL_ARGS variable which can be used to pass
additional arguments to `setup.py install`.
[YOCTO #14610]
(From yocto-docs rev: 4e8c911b73f511f1fb7b557f12d5c87129bc2593)
Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add SETUPTOOLS_SETUP_PATH for setuptools3 class.
Deprecate DISTUTILS_SETUP_PATH and drop mention of ref-classes-setuptools3 as
that class has moved to new variable.
[YOCTO #14610]
(From yocto-docs rev: 6a314a9217206f572289b484e59076483391868c)
Signed-off-by: Tim Orling <tim.orling@konsulko.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replace
":ref:`classname.bbclass <ref-classes-classname>`" section
by
":ref:`ref-classes-classname`" section
because each section has "classname.bbclass" as title,
therefore the result is the same.
(From yocto-docs rev: e3f438e4a71b155bd09bc7988c8e5626a063fde3)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Modules specified as part of module_conf must be listed in
KERNEL_MODULE_PROBECONF, not KERNEL_MODULE_AUTOLOAD.
(From yocto-docs rev: 5720fb534dc343675f8be6369b9661512e3968f2)
Signed-off-by: Robert Joslyn <robert.joslyn@redrectangle.org>
Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Almost everyone understands "rootfs", but "root filesystem"
is real English.
(From yocto-docs rev: 3d610f15e5b6be3435e9e81e4498a676671e5b39)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Except the name of variables which can't be changed only in the
documentation for obvious reasons and workflow or developement
explanations around the use of the "master" branch which cannot be
replaced with "development" branch instead, most of the non-inclusive
words that appear in https://inclusivenaming.org/word-lists/tier-1/
should have been replaced in this patch.
(From yocto-docs rev: 2755f35060084f7af356091de9dc144f85530fe2)
Signed-off-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
According to the syntax simplification brought by
https://git.openembedded.org/bitbake/commit/?id=044fb04d
(From yocto-docs rev: 19090efa1268fcb1fcfd3a2dc637d10d8a50dfad)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After some features that also apply to BitBake
were moved to the BitBake manual.
(From yocto-docs rev: 1415521656427f351ab2d3f8bc498130c4653396)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Already described in BitBake's manual
As it is not specific to OE / Yocto Project
(From yocto-docs rev: 150d5e938e9f413ade8bd6211ee7d55a2819a431)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the reference to the code that computes this default
value for this variable.
(From yocto-docs rev: b115a1c07f76d2cca37565ac678c21e0e6056fff)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
https has been the preferred way to access websites for many years now.
Change all of the URLs with a _working_ https server/certificate to use
that URL.
(From yocto-docs rev: c77868c780df94356d5f21453f80ace073fade9b)
Signed-off-by: Jon Mason <jdmason@kudzu.us>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The URL for the sources mirror no longer works. Update to the new
location.
(From yocto-docs rev: 616c326437c03d7f4530168c4c9d6ef50743952e)
Signed-off-by: Jon Mason <jdmason@kudzu.us>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This fixes font inconsistencies, mixing a ``text`` string
with another string with the regular font, where the whole string
makes more sense with a single font.
The result is also much simpler and will make future
searches easier.
(From yocto-docs rev: e6d1c166a97a1b6bb42ca49dfcbd3d39f8eadc16)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Ensure users are aware that usage of INITRAMFS_IMAGE_BUNDLE is only
appropriate for use with GPLv2 compatible software.
(From yocto-docs rev: ecf4582b454aa301905f0f9e3c6f5adb98dc1991)
Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Following a detailed discussion of PACKAGE_DEBUG_SPLIT_STYLE, it seems
only appropriate to refer the reader to INHIBIT_PACKAGE_DEBUG_SPLIT.
(From yocto-docs rev: d12a6149ed9ec4a5f7c47f4a8c0330c6024c9de5)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The current explanation of this variable seems incomplete, so be a
bit more verbose to make sure the reader understands the packaging
possibilities.
(From yocto-docs rev: 1914705f062b232c10624c11fc85935cc454d2eb)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This add a description of this variable to the variable index,
and clarifies the explanations given in the devtool reference
section.
(From yocto-docs rev: 034b976addd0db6da31c4bacdbea21f2d47c00dc)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It doesn't exist any more and its functionality is now taken care
of by "devtool check-upgrade-status"
(From yocto-docs rev: 9c155e91dc57cb49b97805805e802330188a2c04)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Both SYSROOT_DIRS and SYSROOT_DIRS_BLACKLIST have more current
values.
(From yocto-docs rev: 750ae3fca42e273cd533f9c8b678c2e144164191)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: c4e986364fc67799a9cba8fa1e9d33481bebaa8c)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There are many more instances of "filename" or "filenames" than
of "file name" or "file names".
The winner takes it all!
(From yocto-docs rev: 13ef92bc301166c2e21d2603b2501749248dbe91)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated with openembedded-core/scripts/contrib/convert-overrides.py
(From yocto-docs rev: 23ee6fbdf429d4cf1de4129e92dc7de4e6e9d184)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This adds details about the actual implementation
of vulnerability checks, about how to fix or ignore
vulnerabilities in recipes, and documents the
CVE_CHECK_PN_WHITELIST and CVE_CHECK_WHITELIST variables.
(From yocto-docs rev: 55886d211218b3a604c2f8a29c854685ebf284dd)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This starts to document vulnerability management
and the use of the CVE_PRODUCT variable
(From yocto-docs rev: 2b9199fe490cb3ec126bffc6518646194a94ace4)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The standard :term:`VARIABLE` will refer to the
description of the variable in the YP variable index. If it
doesn't exist, it will refer to the description of the variable
in the BitBake manual.
(From yocto-docs rev: 34cb466caf872f9284eb81f6a5f31ad606214dee)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replacing ":ref:`section name<bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name>`"
by ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-<section>:section name`"
when the reference description is the same as the section name.
In this case, that's unnecessary to repeat the section name in the description part.
(From yocto-docs rev: 6a1a590f9ef77dc8842ea5945661135992eb94e1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A few occurences appeared between the time the original patch was sent
and it was applied, this fixes it.
Also, the original patch didn't take into account lowercase terms, this
is now fixed, see module_autoload for example.
Finally, as is often the case with regexp, there was a typo in it that
didn't make it match as much as it should have.
The script that is used to do the replacement of ``FOO`` by :term:`FOO`
is the following Python code:
import re
from pathlib import Path
from runpy import run_module
import contextlib
import io
import sys
re_term = re.compile(r'variables.html#term-([a-zA-Z_0-9]*)')
terms = []
new_terms = set()
with contextlib.redirect_stdout(io.StringIO()) as f:
run_module('sphinx.ext.intersphinx', run_name='__main__')
objects = f.getvalue()
match = re_term.search(objects)
while match:
if match.group(1):
terms.append(match.group(1))
match = re_term.search(objects, match.end())
for rst in Path('.').rglob('*.rst'):
with open(rst, 'r') as f:
content = "".join(f.readlines())
for term in terms:
content = re.sub(r'``({})``(?!.*\s+[~=-]{{{:d},}})'.format(term, len(term)), r':term:`\1`', content)
with open(rst, 'w') as f:
f.write(content)
This script takes one argument as input: an objects.inv. Bitbake's can
be gotten from https://docs.yoctoproject.org/bitbake/objects.inv. The
objetcs.inv from the current git repo can be gotten from
documentation/_build/html/objetcs.inv after running `make html`.
Note that this excludes from replacement terms that appear in section
titles as it requires refs to be changed too. This can be automated too
if need be but right now it looks a bit confusing to have an anchor link
(for sections) also have a term/reference link in it. I am not sure this
is desired today.
This is the result of two runs of the aforementioned script, once with
Bitbake objects.inv and once with this repo's.
Fixes: ba49d9babfcb "docs: replace ``FOO`` by :term:`FOO` where possible"
(From yocto-docs rev: 1e1b0c4dd241b6657035172b1f7b5f341afa8b25)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The image-mklibs bbclass was removed from OE-Core with
commit 908df863b419d1cad7317153101fc827e7e3a354 and
corresponding changes to local.conf.sample were made
in meta-yocto with c8c8f284eb2abe7e1352850a885454487cc01986.
Remove all references to image-mklibs from the documentation
as it is no longer supported.
(From yocto-docs rev: f45b378eb2cb08c173620cffb17cbcc8b402da0d)
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
If a variable has a glossary entry and some rST files write about those
variables, it's better to point to the glossary entry instead of just
highlighting it by surrounding it with two tick quotes.
This was automated by the following python script:
"""
import re
from pathlib import Path
with open('objects.inv.txt', 'r') as f:
objects = f.readlines()
with open('bitbake-objects.inv.txt', 'r') as f:
objects = objects + f.readlines()
re_term = re.compile(r'variables.html#term-([A-Z_0-9]*)')
terms = []
for obj in objects:
match = re_term.search(obj)
if match and match.group(1):
terms.append(match.group(1))
for rst in Path('.').rglob('*.rst'):
with open(rst, 'r') as f:
content = "".joing(f.readlines())
for term in terms:
content = re.sub(r'``({})``(?!.*\s*[~-]+)'.format(term), r':term:`\1`', content)
with open(rst, 'w') as f:
f.write(content)
"""
(From yocto-docs rev: ba49d9babfcb84bc5c26a68c8c3880a1d9c236d3)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The definition of IMAGE_MANIFEST was moved to a different class. Fixup
the documentation to reflect this change.
(From yocto-docs rev: 15c0a09154de2a1f6d36e1bb5bf283bd08c9ec3d)
Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example for IMAGE_CMD_jffs2 given in the glossary for IMAGE_CMD
didn't align with the implementation anymore. Update it to match the
implementation.
(From yocto-docs rev: 4db4efc42af89a109313c4cf33ae13e8236215e9)
Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
DEPLOY_DIR_IMAGE has been replaced by IMGDEPLOYDIR for most use cases
since OE-Core rev 6d969bacc718e21a5246d4da9bf9639dcae29b02. Document
IMGDEPLOYDIR and add a note to DEPLOY_DIR_IMAGE about it.
(From yocto-docs rev: dad7046f9428bde476d2241209c118d52529bed5)
Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
DEPLOY_DIR_IMAGE has been replaced by IMGDEPLOYDIR for most use cases
since OE-Core rev 6d969bacc718e21a5246d4da9bf9639dcae29b02. Update
examples given in the documentation to use IMGDEPLOYDIR and match their
implementation.
(From yocto-docs rev: 6cad5984306ffbf748a888cedc1a5015105e89fa)
Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The automated script used back then didn't take into account that
terms could be lowercase which is the case for module_autoload and
module_conf, so let's add a link to those too.
Fixes: 9e468274eaad "docs: ref-manual: ref-variables: add links to terms in glossary"
(From yocto-docs rev: beeaf0c48dcd79626c1591a68da4b13387aa0c3f)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 6ed8e747265df899d8ce464d83281b0e0f04f9b2)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: c3e8eb234c9d1cf67dc46666ea26c1e4eb945c2c)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add some links to a small set of glossary variables that I happened
to be perusing at the time.
(From yocto-docs rev: d71d8da78285f2314bfd27a821b26434e39622a8)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Particularly,
- correctly describe the use of DEBUGINFOD_URLS; drop it from bitbake variables
- all necessary component tweaks are enabled by default via DISTRO_FEATURES
- provide on-target examples of what to look for when things work properly
(From yocto-docs rev: 6d5d568d427b22675b999f94ead829ab1bef0b21)
Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
See [YOCTO #13921]
Add details to the SERIAL_CONSOLES_CHECK entry to clarify that it
doesn't work with read-only rootfs.
(From yocto-docs rev: cefd66301a40f9048499879674e467543f704c44)
Signed-off-by: Trevor Gamblin <trevor.gamblin@windriver.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This simplifies paragraphs ending with a colon and followed
by code insertion.
Automatically substituted through the command:
sed -i -z "s/:\n\s*::/::/g" file.rst
This generates identical HTML output.
(From yocto-docs rev: 28e2192a7c12d64b68061138a9f6c796453eebb1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This replaces instances of ": ::" by "::", which
generates identical HTML output
(From yocto-docs rev: 1f410dfc7c16c09af612de659f8574ef6cff4636)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a variable glossary entry and corresponding 3.3 migration
section entry for DISTUTILS_SETUP_PATH.
(From yocto-docs rev: 0823237e6f4b9dbdf48500b3c1e8cc61696fa2d2)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add FIT_KERNEL_COMP_ALG and FIT_KERNEL_COMP_ALG_EXTENSION. Examining
OE-Core commit 5c72105e2973e613b5c0f0e6310ffdea6e56c6c7 and the
associated code, these do not enable arbitrary selection of compression
algorithm - only disabling compression - so document them accordingly.
(From yocto-docs rev: 41640526dd87153fdf802b058336c6fb466b8ade)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a reference to the recently added passwd-expire command in
EXTRA_USERS_PARAMS.
(From yocto-docs rev: 9a6c8b37a1e6baab4dfb2ffe7b4abdf7dcbb8822)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add the recently added python3targetconfig class. Also, we no longer
have the python 2 classes, remove all references to those.
(From yocto-docs rev: c63d88656e2fc5361c512d4d9b426260c3e339f3)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add REQUIRED_VERSION, add a reference to it in PREFERRED_VERSION and
adjust the opening statement to read slightly better.
(From yocto-docs rev: c1c0b3600f2f6e752faacfc877b80c2dda7cf522)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
DISTRO_VERSION snapshot versions use METADATA_REVISION not DATE in
hardknott and thus the default for SDK_VERSION has been updated, so
update it here as well. Additionally, fix the text so it makes sense.
(From yocto-docs rev: 7b0c4229591d6325384800137e9242c2b030e118)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These are not new variables, but we are using METADATA_REVISION in a new
place and thus need to refer to it.
(From yocto-docs rev: 3b80ece864e8cc06f09d3d4ee645ddeef5d4eaf6)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- That could originate from documentation migration issues
- Checked that the corresponding links still exist
(From yocto-docs rev: 38bae8f6067bc12f3617ed38587737d22dd7b32c)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Spelling fixes found using Emacs' spelling checker
configured for US English
- Fixes for some capitalization issues, especially some
project names (QEMU, openSUSE, BusyBox), that were not
consistently used with the same capitalization anyway.
- A few whitespace fixes too
(From yocto-docs rev: 05d69f17490dcc4933dcd85e57d9db53b912084a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added documentation on running debuginfod server and using it on the target.
Added the term DEBUGINFOD_URLS definition in ref-manual/variables.rst
(From yocto-docs rev: a16ae140e26482c81ce733f20f8c68c6eba55f35)
Signed-off-by: Dorinda Bassey <dorindabassey@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Not sure what those leading '\*' are doing, but they're rendered
verbatim and mess up creating a linkable item.
(From yocto-docs rev: dd2e5ef733f056900cc4c9746a1e8c688cc61920)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updates the documentation for PROVIDES so that it recommends "+="
instead of "=".
(From yocto-docs rev: 39b2ca1e27592488d396d5f0d76965f0006515a1)
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
poky.yaml references are only replaced in files if they are prefixed by
& and suffixed by ;.
Let's fix the missing surrounding characters.
(From yocto-docs rev: 7ee4ba7a27acd87d8c728639d1b053d2e26c6e58)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Change all instances of U-boot to U-Boot.
(From yocto-docs rev: 153c60fd9f2807c8e98105bcd4384e52e2adaa1a)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Make it clear that KERNEL_ALT_IMAGETYPE is intended to allow building an
additional image type.
(From yocto-docs rev: d2f51d310028dfa50584f7dc04ea3627d14d3f1e)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references
(From yocto-docs rev: bb7e4783f45a5f67e6e4b39968f3512f43738833)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
