summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* manuals: split dev-manual/common-tasks.rstMichael Opdenacker2022-12-0113-107/+107
| | | | | | | | | | | | | | 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>
* ref-manual/classes.rst: remove reference to sip.bbclassMichael Opdenacker2022-12-011-8/+0
| | | | | | | | | Removed in version 2.2 (From yocto-docs rev: ff2ad887bcac5dd209ce781488e1ca73c43e148b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix paragraphs with the "inherit" wordMichael Opdenacker2022-12-013-30/+27
| | | | | | | | | | | 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>
* manuals: add missing references to classesMichael Opdenacker2022-12-013-68/+73
| | | | | | | | | | | 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>
* ref-manual/variables.rst: expand PARALLEL_MAKE descriptionMichael Opdenacker2022-11-101-12/+16
| | | | | | | | | | 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>
* ref-manual/variables.rst: expand BB_NUMBER_THREADS descriptionMichael Opdenacker2022-11-101-0/+27
| | | | | | | | | | 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>
* docs: ref-manual: classes: add missing closing parenthesisQuentin Schulz2022-11-101-1/+1
| | | | | | | | | | | The closing parenthesis is missing in the sentence so let's add it. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 93bb2654905ad7f32082bb7acd3630ef390dc4b9) 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>
* docs: ref-manual: classes: fix section name for github-releasesQuentin Schulz2022-11-101-2/+2
| | | | | | | | | | | | All other classes are suffixed with .bbclass so let's stay consistent and add it to github-releases section too. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 461bc36839278e69a3d2511ca15fae80a6140d77) 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>
* manuals: add shortcut for Wikipedia linksMichael Opdenacker2022-11-075-21/+19
| | | | | | | (From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document "mime-xdg" class and MIME_XDG_PACKAGESMichael Opdenacker2022-11-073-4/+32
| | | | | | | (From yocto-docs rev: dabd2e95cf8ba8ed620bfd135deb6cfcf5d74b16) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: terms.rst: add reference to new SBOM/SPDX section in dev manualMichael Opdenacker2022-11-071-1/+3
| | | | | | | (From yocto-docs rev: 908c985b0a9ad98d1e6610c36a057501be1900e9) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes.rst: expand documentation of create-spdx classMichael Opdenacker2022-11-071-2/+20
| | | | | | | (From yocto-docs rev: 4c6a4121d7f63e56f2743216e8219f92ed5eb94e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables.rst: document spdx-create class variablesMichael Opdenacker2022-11-071-0/+82
| | | | | | | (From yocto-docs rev: fd9ee9e1701a90c19d4957ec387e0ad17757aa06) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: terms.rst: add SBOM and SPDX termsMichael Opdenacker2022-11-071-0/+26
| | | | | | | (From yocto-docs rev: 2c53ac40e99a7957736276c5bf925b3f81544aa5) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: use references to the "Build Directory" termMichael Opdenacker2022-10-285-80/+70
| | | | | | | | | | | | | | 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>
* manuals: stop referring to the meta-openembedded repo from GitHubMichael Opdenacker2022-10-282-8/+5
| | | | | | | (From yocto-docs rev: de6e7c05fbcff99a6f1fe2a2bf889b559b9b576b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: replace "_" by "__" in external linksMichael Opdenacker2022-10-283-8/+8
| | | | | | | (From yocto-docs rev: 25142cd8121fdd6a8e0524fc8417fc666c498981) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes.rst: improve documentation for cve-check.bbclassMikko Rapeli2022-10-281-2/+50
| | | | | | | | | | | It is a quite important tool for maintaining yocto based products so documentation should include the best practices. (From yocto-docs rev: 3f7d09fc3c96f29ab80a2cb893c9b4b19a75a769) 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>
* ref-manual: variables.rst: add documentation for CVE_VERSIONMikko Rapeli2022-10-281-0/+12
| | | | | | | | | | 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>
* ref-manual: add info on buildtools-make-tarballPaul Eggleton2022-10-281-1/+25
| | | | | | | | | | | | | PENDING ON THIS OE-CORE PATCH: install-buildtools: support buildtools-make-tarball and update to 4.1 https://lists.openembedded.org/g/openembedded-core/message/171522 Cover the use case and the new provided tarball. (From yocto-docs rev: 3a06c35d059d7d43f7eb33a4f490f5d76afe6cb6) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add wic command bootloader ptable optionAdrian Freihofer2022-10-281-6/+11
| | | | | | | | | | Reordering the bootloader command options alphabetically (From yocto-docs rev: 9d43fcf8ba023be1350ed2b26482d2d5e44cf0cb) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes.rst: add links to all references to a classMichael Opdenacker2022-10-251-227/+225
| | | | | | | | | | | | | | | | | | | | | | | | [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 664b658d9d23bb97b236bc0d09c9d3f118c582fc) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> -- 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 <richard.purdie@linuxfoundation.org>
* manuals: updates for building on Windows (WSL 2)Michael Opdenacker2022-10-251-5/+5
| | | | | | | | | | | | | - Use the Wikipedia naming scheme: WSL 2 instead of WSLv2 - Take into account Windows Server 2019 and 2022 which are supported too. - Improve some explanations (From yocto-docs rev: 35c5fb01d3543ef5e1f4edf337a2ab080b4e7956) 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>
* manuals: fix misc typosMichael Opdenacker2022-10-191-1/+1
| | | | | | | (From yocto-docs rev: 988efd0d1663e4369043c5b53d7e1dcd9e54d3cd) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: faq.rst: reorganize into subsections, contents at topMichael Opdenacker2022-10-191-298/+314
| | | | | | | | | | | | | | | | | | Reorganize the FAQ into sections and subsections, which allows to have a table of contents at the top. This makes it easier to find relevant questions without having to scroll down the entire page. Reduce the size of questions so that they fit in a subsection title. Merged two redundant questions about fetching sources and working through proxies. Minor updates to other sections. (From yocto-docs rev: 3e24f94e9c2186a6e1d65d82a87323ef2fc6f87d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add OVERLAYFS_QA_SKIPPaul Eggleton2022-10-191-0/+13
| | | | | | | | | 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>
* ref-manual: add overlayfs class variablesPaul Eggleton2022-10-191-0/+24
| | | | | | | | | 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>
* ref-manual: add section for create-spdx classPaul Eggleton2022-10-191-0/+8
| | | | | | | | | | | 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 <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add WIRELESS_DAEMONPaul Eggleton2022-10-191-0/+5
| | | | | | | | | 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>
* ref-manual: add OVERLAYFS_ETC_EXPOSE_LOWERPaul Eggleton2022-10-191-0/+6
| | | | | | | | | 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>
* ref-manual: add previous overlayfs-etc variablesPaul Eggleton2022-10-191-0/+38
| | | | | | | | | 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>
* ref-manual: add serial-autologin-root to IMAGE_FEATURES documentationPaul Eggleton2022-10-191-0/+6
| | | | | | | | | New IMAGE_FEATURES item in 4.1. (From yocto-docs rev: 0fdd9079743a4a4205afcaaaa783af855ce5f21f) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add missing featuresPaul Eggleton2022-10-191-0/+50
| | | | | | | | | | | | | | | Add missing IMAGE_FEATURES, DISTRO_FEATURES and MACHINE_FEATURES items. Additionally, add a note that DISTRO_FEATURES doesn't have any impact on the kernel configuration so that users are aware they have to take care of that as well. (I thought the same was true of MACHINE_FEATURES, but it seems we have a couple of isolated cases where that will adjust the kernel configuration - few enough that I suspect they might have slipped in and thus probably shouldn't be documented yet.) (From yocto-docs rev: 488a5896feefd6d0dbc197e7cc431b4d23085104) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove reference to largefile in DISTRO_FEATURESPaul Eggleton2022-10-191-3/+0
| | | | | | | | | This no longer does anything in 4.1. (From yocto-docs rev: a288b422cf9753a393e0c6791292ac5dad2fe732) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: complementary package installation recommendsPaul Eggleton2022-10-191-6/+9
| | | | | | | | | | | | | 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>
* Update documentation for classes splitPaul Eggleton2022-10-195-42/+49
| | | | | | | | | | | | | | | | | | * 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>
* ref-manual: remove reference to testimage-auto classPaul Eggleton2022-10-193-10/+11
| | | | | | | | | 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>
* ref-manual: add MOUNT_BASE variablePaul Eggleton2022-10-191-0/+5
| | | | | | | | | 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>
* ref-manual: add KERNEL_DEPLOY_DEPENDPaul Eggleton2022-10-191-0/+6
| | | | | | | | | 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>
* ref-manual: add CVE_DB_UPDATE_INTERVALPaul Eggleton2022-10-191-0/+7
| | | | | | | | | 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>
* ref-manual: add FIT_PAD_ALGPaul Eggleton2022-10-191-0/+4
| | | | | | | | | 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>
* ref-manual: add CVE_CHECK_SHOW_WARNINGSPaul Eggleton2022-10-191-0/+7
| | | | | | | | | 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>
* ref-manual: update pypi documentation for CVE_PRODUCT default in 4.1Paul Eggleton2022-10-192-2/+5
| | | | | | | | | | 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>
* ref-manual: add pypi classPaul Eggleton2022-10-192-0/+23
| | | | | | | | | 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>
* ref-manual: add SDK_TOOLCHAIN_LANGSPaul Eggleton2022-10-191-0/+4
| | | | | | | | | 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>
* ref-manual: add DEV_PKG_DEPENDENCYPaul Eggleton2022-10-191-0/+5
| | | | | | | | | 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>
* ref-manual: add UBOOT_MKIMAGE_KERNEL_TYPEPaul Eggleton2022-10-191-0/+4
| | | | | | | | | 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>
* ref-manual: update buildpaths QA check documentationPaul Eggleton2022-10-192-2/+18
| | | | | | | | | | | 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>
* ref-manual: add a note to ssh-server-dropbear featurePaul Eggleton2022-10-191-0/+15
| | | | | | | | | | 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>
* ref-manual: document new github-releases classPaul Eggleton2022-10-192-0/+21
| | | | | | | | | 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-06-14 03:15:32 +0000