Commit Graph

177 Commits

Author SHA1 Message Date
Michael Opdenacker
945c669138 manuals: split dev-manual/common-tasks.rst
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>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
4d01625794 manuals: fix paragraphs with the "inherit" word
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>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
55621c31f1 manuals: add missing references to classes
Sometimes fixing line length in modified paragraphs too.

[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 885b60f5540849bf19240a01a77efce1d1b5d9f0)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01 19:20:29 +00:00
Michael Opdenacker
51b6a55a80 ref-manual/variables.rst: expand PARALLEL_MAKE description
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>
2022-11-10 22:12:56 +00:00
Michael Opdenacker
15a8edcead ref-manual/variables.rst: expand BB_NUMBER_THREADS description
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>
2022-11-10 22:12:56 +00:00
Michael Opdenacker
3a7dd1d368 manuals: add shortcut for Wikipedia links
(From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07 21:31:32 +00:00
Michael Opdenacker
1d2681fa72 manuals: document "mime-xdg" class and MIME_XDG_PACKAGES
(From yocto-docs rev: dabd2e95cf8ba8ed620bfd135deb6cfcf5d74b16)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07 21:31:32 +00:00
Michael Opdenacker
a6f7c43e92 ref-manual: variables.rst: document spdx-create class variables
(From yocto-docs rev: fd9ee9e1701a90c19d4957ec387e0ad17757aa06)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07 21:31:32 +00:00
Michael Opdenacker
b44fbe5b1b manuals: use references to the "Build Directory" term
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>
2022-10-28 15:48:03 +01:00
Michael Opdenacker
6f4ccc4dad manuals: stop referring to the meta-openembedded repo from GitHub
(From yocto-docs rev: de6e7c05fbcff99a6f1fe2a2bf889b559b9b576b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Michael Opdenacker
4def515eeb manuals: replace "_" by "__" in external links
(From yocto-docs rev: 25142cd8121fdd6a8e0524fc8417fc666c498981)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28 15:48:03 +01:00
Mikko Rapeli
8a9ac57515 ref-manual: variables.rst: add documentation for CVE_VERSION
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>
2022-10-28 15:48:03 +01:00
Paul Eggleton
ae9eb5684a ref-manual: add OVERLAYFS_QA_SKIP
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
01372ac01c ref-manual: add overlayfs class variables
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
7a417c450e ref-manual: add WIRELESS_DAEMON
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
0aa40dc125 ref-manual: add OVERLAYFS_ETC_EXPOSE_LOWER
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>
2022-10-19 17:32:57 +01:00
Paul Eggleton
d73883dfef ref-manual: add previous overlayfs-etc variables
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>
2022-10-19 17:32:57 +01:00
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
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
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
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
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
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
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
0e8d0ecc6c manuals: add references to the "do_deploy" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: b607a0578e8edd3e4ee013b4438481cb82bc106e)

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
6ade5d2d0e manuals: add reference to the "do_compile" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: e88f11002032e30bbe2dd0049e307a431a70aaef)

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
5d1e8104cd manuals: add reference to "do_configure" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: 5ddc1a40c9004d814472bdd385f456afa7a9c4e3)

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
9fece9c361 manuals: add reference to the "do_install" task
[YOCTO #14508]
(From yocto-docs rev: 933ad27b81dfc4a28e7c48ca7bb2d1363e8c037f)

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:25 +01:00
Michael Opdenacker
9dbd27a48a manuals: improve initramfs details
- 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>
2022-10-07 10:54:25 +01:00
Michael Opdenacker
1bdbc6c926 ref-manual: variables.rst: correct templateconf.cfg file name
According to code in
https://git.openembedded.org/openembedded-core/tree/meta/classes-recipe/populate_sdk_ext.bbclass

(From yocto-docs rev: 454a828103aeb9b3ad3985f07d89f418213f5471)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24 17:44:56 +01:00
Michael Opdenacker
2311ec16a5 ref-manual: variables.rst: remove BBPATH
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>
2022-09-24 17:44:56 +01:00
Johan Korsnes
c66e7b9479 ref-manual: variables: document KERNEL_IMAGETYPES
Cc: He Zhe <zhe.he@windriver.com>
Cc: Ross Burton <ross.burton@arm.com>
Cc: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: aef81b8d19a31dcd1eef5a0023f43d81875ca215)

Signed-off-by: Johan Korsnes <johan.korsnes@remarkable.no>
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>
2022-09-24 17:44:56 +01:00
Ulrich Ölmann
b26546f537 manuals: fix typos in the context of 'icecc' & clean up whitespaces
(From yocto-docs rev: cce3eece0886b5446774e6a5cc57c28d13c58fdd)

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>
2022-09-24 17:44:55 +01:00