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: 3de2ad1f8ff87aeec30088779267880306a0f31a)
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>
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>
