Commit Graph

6569 Commits

Author SHA1 Message Date
Paul Eggleton
1bdb6457dd ref-manual: complementary package installation recommends
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
b1d1777865 Update documentation for classes split
* 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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
c29eb10e31 ref-manual: remove reference to testimage-auto class
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
335a230a35 ref-manual: add MOUNT_BASE variable
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
a9a00a6004 ref-manual: add KERNEL_DEPLOY_DEPEND
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
260d09106f ref-manual: add CVE_DB_UPDATE_INTERVAL
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
256dcac518 ref-manual: add FIT_PAD_ALG
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
81f311e347 ref-manual: add CVE_CHECK_SHOW_WARNINGS
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
f4d633a7c2 ref-manual: update pypi documentation for CVE_PRODUCT default in 4.1
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
af3beeecfb ref-manual: add pypi class
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
9dd5d8d1ad ref-manual: add SDK_TOOLCHAIN_LANGS
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>
2022-10-19 17:32:56 +01:00
Paul Eggleton
c81fd60784 ref-manual: add DEV_PKG_DEPENDENCY
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>
2022-10-19 17:32:56 +01:00
Paul Eggleton
776ec078c4 ref-manual: add UBOOT_MKIMAGE_KERNEL_TYPE
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>
2022-10-19 17:32:56 +01:00
Paul Eggleton
3dbc1e83f2 ref-manual: update buildpaths QA check documentation
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 <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:56 +01:00
Paul Eggleton
32ba43072b ref-manual: add a note to ssh-server-dropbear feature
Add a note regarding the 4.1 change to add openssh-sftp-server as a
recommends from ssh-server-dropbear.

(From yocto-docs rev: dd4775d666ca8309ef029fd329a248397bcdedc6)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:56 +01:00
Paul Eggleton
e6fb7f27f6 ref-manual: document new github-releases class
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>
2022-10-19 17:32:56 +01:00
Paul Eggleton
98893c4ddf ref-manual: correct default for BUILDHISTORY_COMMIT
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>
2022-10-19 17:32:56 +01:00
Paul Eggleton
72b7a67743 ref-manual: add WATCHDOG_TIMEOUT to variable glossary
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>
2022-10-19 17:32:56 +01:00
Paul Eggleton
8ba77dd403 ref-manual: expand documentation on image-buildinfo class
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>
2022-10-19 17:32:56 +01:00
Paul Eggleton
500d5bc5c9 ref-manual: add DISABLE_STATIC
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>
2022-10-19 17:32:56 +01:00
Paul Eggleton
83495559d9 migration-general: add section on using buildhistory
Add a short section recommending the use of buildhistory to compare
the build output before and after migration.

(From yocto-docs rev: e4a83dadbda563e08302055538203c9b1ac9e992)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:56 +01:00
Michael Opdenacker
3e78c41c22 ref-manual/variables.rst: clarify sentence
(From yocto-docs rev: 9ecbf388bb0e5de4d4d65a3cf24caeb5d65f67dc)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19 17:32:56 +01:00
Michael Opdenacker
3e5faccfaf ref-manual/faq.rst: update references to products built with OE / Yocto Project
(From yocto-docs rev: 42d3e26a0d04bc5951e640b471686f347dc9b74a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
ba08db9817 overview-manual: concepts.rst: fix formating and add references
(From yocto-docs rev: c123815c664717e051456cc8142ba6d0b3369c62)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
f2803414b9 ref-manual: system-requirements: Ubuntu 22.04 now supported
Following its addition to meta-poky/conf/distro/poky.conf
https://git.yoctoproject.org/poky/commit/?id=7786b09212d6ab582db39d0d7d1a4209d36db2ba

(From yocto-docs rev: 393e9ae7c37544fd5c2841d99dd9bcd6db03dbbd)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
9d597ea614 ref-manual: tasks.rst: add reference to the "do_image_complete" task
(From yocto-docs rev: ebaf978cb7e682b724d9993cd0cd739ecb1c52b5)

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>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
4d2159d107 ref-manual: tasks.rst: add reference to the "do_validate_branches" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: abda9c0ee2835f9fdca54d7770678b0188c68e17)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
623720dcf4 migration-guides: add reference to the "do_shared_workdir" task
(From yocto-docs rev: a549b39a56c69beecd309ae0621ca673537a467e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
e95e686e0c ref-manual: tasks.rst: add reference to the "do_kernel_metadata" task
(From yocto-docs rev: 85c12756a3e0fefdb5b5aec3ee317a6c0e4f0030)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
5f5d993bae manuals: add references to the "do_kernel_configme" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: f926e67d5c7ff4475e24ee7dd4f6c4b3ba7e9896)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
3784c57c04 manuals: add reference to the "do_kernel_configcheck" task
(From yocto-docs rev: 8356996e66c4a45f9f15b30950c6c61a0d50c2c9)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
c4e05c5223 ref-manual: tasks.rst: add reference to the "do_kernel_checkout" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: d45cffba8995b5a76a495f73e46852696a3bf645)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
40b7725212 manuals: add references to the "do_rootfs" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 926c836e5184243fb1aee113962e11c01f0297ee)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
b42af6aa4a manuals: add references to the "do_bundle_initramfs" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 84c024455a36f4b40cd8401715f30b0af74af8a7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
6660c0603a dev-manual: common-tasks.rst: add reference to "do_listtasks" task
(From yocto-docs rev: 4352e14f82a45444acb2d8df11552b2265471ab1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
ba478645a3 manuals: add references to the "do_devshell" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 53141101fc1a8dc8b4007adcded3c7c6b9738f48)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
2aae1accee ref-manual: tasks.rst: add references to the "do_cleansstate" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 2d48187906e289caf33bf53e6ddecfe56f6fd74b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
66a523d7e7 manuals: add references to the "do_cleanall" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 4c815875b7c716f421bbcd11ce26703867f11741)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
c99fdab612 dev-manual: common-tasks.rst: add reference to "do_clean" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 68261dc8b8c26df7aad19b37c2300ec5174525c9)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
c9c7ace795 manuals: add references to the "do_unpack" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 1ca57f8ec322d5777bf31829e659d62e82986be1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
a8b6712dfd manuals: add references to "do_populate_sysroot" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: a010e2eafa6754c46faac6f6dfd02dc6152d274f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
8f39d1812b overview-manual: concepts.rst: add reference to "do_populate_sdk_ext" task
(From yocto-docs rev: 763eb0b85052f2013b481017d432fc95ae5869a5)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
97495b4c89 manuals: add reference to the "do_populate_sdk" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 6d262b676ed1e8b6b404050dad20e85e7ceb28c2)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
2102333157 ref-manual: variables.rst: add reference to "do_populate_lic" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: b58444010ebe359d11884ad4bde505ccd1813e79)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
ec31647110 manuals: add references to "do_package_write_*" tasks
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>
2022-10-07 10:54:26 +01:00
Michael Opdenacker
a6a7676910 manuals: add references to the "do_patch" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 1e38ceafb25aac13bb9dd45626fd39ad1b68852d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
020c44eb3b overview-manual: concepts.rst: add reference to "do_packagedata" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: d2cc5f2f667b357c770eeb69a7e8b6fef4f9c447)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
67a72fc3f7 manuals: add references to the "do_package_qa" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: af27370fd4ffd0e0455187aa9fc5349d39403ae7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
b3dc55b051 manuals: add references to the "do_package" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 179139e6710f6dde0de25200c372705ed8ef13bc)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
3c6b2798a0 manuals: add references to the "do_image" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 2f53d0a52a48f828f00d3bc3f887fd537692a256)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07 10:54:25 +01:00