summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
Commit message (Collapse)AuthorAgeFilesLines
...
* ref-manual: variables: FIT_KERNEL_COMP_ALG: add lzoRichard Leitner2023-02-101-2/+3
| | | | | | | | | | | | | | OE-Core rev f1257d61b76d027d4ece734439993b6bf4e48907 introduced support for using lzo as compression algorithm for fitImage contained kernel images. This patch adds the corresponding documentation to FIT_KERNEL_COMP_ALG and FIT_KERNEL_COMP_ALG_EXTENSION. (From yocto-docs rev: aba0ab326ea72ff10492e73b452b51d1beaa50d6) Signed-off-by: Richard Leitner <dev@g0hl1n.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix typo in the MLPREFIX descriptionLuca Ceresoli2023-01-251-1/+1
| | | | | | | | (From yocto-docs rev: 71535ccea091f130e94339072e3c579661dbf3d8) Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: initial documentation for go and go-mod classesMichael Opdenacker2023-01-251-0/+67
| | | | | | This addresses [YOCTO #14582] Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: simplify references to classesMichael Opdenacker2023-01-061-368/+322
| | | | | | | | | | | | | | | Now that .bbclass is removed from class section titles. We can now have, for example, :ref:`ref-classes-insane` instead of :ref:`insane <ref-classes-insane>`. Then, when necessary, rework paragraphs so that they have lines of even length, not exceeding 80 characters. (From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: final removal of SERIAL_CONSOLE variableMichael Opdenacker2022-12-181-13/+0
| | | | | | | | | | This deprecated variable has been removed for good through https://git.openembedded.org/openembedded-core/commit/?id=9d053af1fb570b4e3483de4ecd6827e1e0be61b7 (From yocto-docs rev: db22748d8a2bc4c53c6415537c772d2c49220aec) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: define proper numbered listsMichael Opdenacker2022-12-181-6/+6
| | | | | | | | | | Using "#." instead of "1.", "2.", "3.", etc. (From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manual: improve documentation about using external toolchainsMichael Opdenacker2022-12-181-5/+15
| | | | | | | | | | | | | | | | | - Remove the redundant FAQ entry about this topic, already covered in a specific section of the Development Tasks manual - Document the TOOLCHAIN_LOCATION variable - Expand both the Development Tasks manual and the TCMODE variable description using details from the FAQ entry. - Mention the "meta-arm-toolchain" layer too. (From yocto-docs rev: 53faa54a8e6311b4d3d41d96cb1a497d0f6502fb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: update references to release notesMichael Opdenacker2022-12-181-6/+4
| | | | | | | | | Now part of the Yocto Project manual. (From yocto-docs rev: fe23084f746f0959afbf7d4a49e00299e39fba09) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix double colonsMichael Opdenacker2022-12-181-24/+12
| | | | | | | | | | | | | | | Fixing double colons appearing alone on a line, while they could be put at the end of the previous line. Sometimes placing a note after the quoted text to avoid such a situation. It's more natural too not to have a note between the introduction text and the quoted section. (From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add missing references to variablesMichael Opdenacker2022-12-181-7/+7
| | | | | | | | [YOCTO #14508] (From yocto-docs rev: 7878a21be8fb6c7a1ab88ae44aa5f7bf0079391a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add references to variables only documented in the BitBake manualMichael Opdenacker2022-12-181-0/+204
| | | | | | | | | | | | | | | This makes the Yocto Project manual variable list and index more useful, not missing any potentially useful variable. The price to pay is that a reference to such variables now has to go through the intermediate reference in the Yocto Project variable list, instead of going straight to the Bitbake manual. (From yocto-docs rev: 3d308812cd9aa906890a0f8562fc28c1cd8aaab6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: split dev-manual/common-tasks.rstMichael Opdenacker2022-12-011-56/+56
| | | | | | | | | | | | | | 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>
* manuals: fix paragraphs with the "inherit" wordMichael Opdenacker2022-12-011-13/+10
| | | | | | | | | | | 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-011-61/+64
| | | | | | | | | | | 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>
* manuals: add shortcut for Wikipedia linksMichael Opdenacker2022-11-071-3/+3
| | | | | | | (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-071-0/+7
| | | | | | | (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: 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>
* manuals: use references to the "Build Directory" termMichael Opdenacker2022-10-281-35/+28
| | | | | | | | | | | | | | 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-281-3/+2
| | | | | | | (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-281-3/+3
| | | | | | | (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: 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 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 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: 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-191-28/+31
| | | | | | | | | | | | | | | | | | * 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-191-1/+1
| | | | | | | | | 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-191-1/+3
| | | | | | | | | | 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-191-0/+8
| | | | | | | | | 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: document new github-releases classPaul Eggleton2022-10-191-0/+7
| | | | | | | | | 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>
* ref-manual: correct default for BUILDHISTORY_COMMITPaul Eggleton2022-10-191-3/+3
| | | | | | | | | | | 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>
* ref-manual: add WATCHDOG_TIMEOUT to variable glossaryPaul Eggleton2022-10-191-0/+4
| | | | | | | | | | 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>
* ref-manual: expand documentation on image-buildinfo classPaul Eggleton2022-10-191-0/+16
| | | | | | | | | | | 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>
* ref-manual: add DISABLE_STATICPaul Eggleton2022-10-191-0/+12
| | | | | | | | | 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>
* ref-manual/variables.rst: clarify sentenceMichael Opdenacker2022-10-191-1/+1
| | | | | | | (From yocto-docs rev: 9ecbf388bb0e5de4d4d65a3cf24caeb5d65f67dc) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add references to the "do_bundle_initramfs" taskMichael Opdenacker2022-10-071-1/+1
| | | | | | | | | [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>
* manuals: add references to "do_populate_sysroot" taskMichael Opdenacker2022-10-071-2/+2
| | | | | | | | | [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>
* ref-manual: variables.rst: add reference to "do_populate_lic" taskMichael Opdenacker2022-10-071-1/+1
| | | | | | | | | [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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2026-07-21 04:30:49 +0000