linux/poky.git/documentation/ref-manual/classes.rst, branch yocto-4.1.1

ref-manual: classes.rst: add links to all references to a class

2022-10-25T12:41:36+00:00

[YOCTO #14508] Reported-by: Quentin Schulz (From yocto-docs rev: 664b658d9d23bb97b236bc0d09c9d3f118c582fc) Signed-off-by: Michael Opdenacker -- Doing this to consistently replace any reference to a class by the corresponding link. This is a bit trivial within the declaration of a class, but helps making sure that this rule applies everywhere. This helps for example to rename or remove classes from the documentation. See https://bugzilla.yoctoproject.org/show_bug.cgi?id=14508 As this change is time consuming, submitting the first part of it as an RFC, to double check there is an agreement on doing this. Signed-off-by: Richard Purdie

manuals: fix misc typos

2022-10-19T16:32:57+00:00

(From yocto-docs rev: 988efd0d1663e4369043c5b53d7e1dcd9e54d3cd) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

ref-manual: add section for create-spdx class

2022-10-19T16:32:57+00:00

create-spdx was added in the honister release. This is a stub since I unfortunately don't have time to fully document this class and related variables, hopefully someone else can expand it in future. (From yocto-docs rev: 5a4aa9dca1468d56ab5ec2c3a5ebf1ea364df5d0) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie

Update documentation for classes split

2022-10-19T16:32:57+00:00

* 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 Signed-off-by: Richard Purdie

ref-manual: remove reference to testimage-auto class

2022-10-19T16:32:57+00:00

testimage-auto was removed in the thud release. (From yocto-docs rev: 618351169c09470280aeee53a63aba88788efc4b) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie

ref-manual: update pypi documentation for CVE_PRODUCT default in 4.1

2022-10-19T16:32:57+00:00

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 Signed-off-by: Richard Purdie

ref-manual: add pypi class

2022-10-19T16:32:57+00:00

Add missing documentation for the pypi class. (From yocto-docs rev: d387ca891ad3a7d00ec3cb5f994dc5832c885d54) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie

ref-manual: update buildpaths QA check documentation

2022-10-19T16:32:56+00:00

The buildpaths QA check is now practically usable and enabled by default, so update the comment and add a section with the warning message since users may start seeing it in their builds. (From yocto-docs rev: a14997e3b8576cd1a6e1c38d13b5b8e05ac03b88) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie

ref-manual: document new github-releases class

2022-10-19T16:32:56+00:00

Newly added class in 4.1. (From yocto-docs rev: 391750e417d7a6b88222e03aa0a57ea87d9f618a) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie

ref-manual: expand documentation on image-buildinfo class

2022-10-19T16:32:56+00:00

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 Signed-off-by: Richard Purdie