summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual/variables.rst: document the CCACHE_TOP_DIR variableAntonin Godard2026-01-261-0/+6
| | | | | | | | | | | | | | Added by commit 35d7fe73bba1 ("ccache.bbclass: Make it can be shared between different builds") in OE-Core. Fixes [YOCTO #16052] (From yocto-docs rev: 32818c927bde8014e855b10b1d78d3f09beec024) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 550ef8340b550f8d4e9c3d0672190dc09592c621) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/release-process.rst: add a "Development Cycle" sectionAntonin Godard2026-01-261-0/+39
| | | | | | | | | | | | | | | Add a new section to release-process.rst to document the development cycle of each release and namely the milestones and feature freeze occuring after M3. Fixes [YOCTO #15979] (From yocto-docs rev: 1cc5321c162ce36079d661ea1d35c2694c20ed9b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 77c04cc5944acda7575546a7434e014e4a75ba58) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: document the image-container classAntonin Godard2026-01-262-0/+65
| | | | | | | | | | | | | | | | | | | Add documentation for the image-container class, which is a simple class to generate an image suitable for creating a container. This answers in part to questions asked in [YOCTO #14368]. It also adds documentation for IMAGE_CONTAINER_NO_DUMMY, which was added in OE-Core with commit f0645e172bb8 ("image-container.bbclass: Error if not using linux-dummy"). Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 85fb6e4a964ea2dea9c3083ba2c4ceb336f34b1a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6ce00e5875eb3469fefd55cc22acaaeaf620053a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/svg/releases.svg: mark whinlatter as current releaseAntonin Godard2026-01-261-5/+5
| | | | | | | | | | | | Whinlatter is the new current Yocto Project release, mark it as an active one. Move it as released in December 2025. (From yocto-docs rev: b0ae6483dd916eea3d144466e597a8e86187d9f7) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6f8e97c6e529f3c47f45f34d9e04e3ad7bddd587) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/svg/releases.svg: mark styhead and walnascar EOLAntonin Godard2026-01-261-3/+3
| | | | | | | | | | | | | Walnascar has stopped being updated a while ago, and Styhead is EOL since May 2025. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 71b03c21dc9d8a9fd0b5cc92808a7944f6c7fe28) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 834de77b543de43ee3c1c12ca1d6277e67e126de) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: link to the Releases page on yoctoproject.org instead of wikiRoss Burton2025-11-261-1/+2
| | | | | | | | | | | | | | | We have a machine-generated Releases page[1] which is preferable to the wiki. [1] https://www.yoctoproject.org/development/releases/ (From yocto-docs rev: 5af5e64e42732c0919cad499e79ff35ca4255a86) Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 46a9172fd17aa518028e35b8c874e74889079094) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: variables: migrate the OVERRIDES note to bitbake-getvarQuentin Schulz2025-11-261-2/+2
| | | | | | | | | | | | | Wherever possible, we should use bitbake-getvar as it's the recommended tool so let's do that. (From yocto-docs rev: b9453c7ce44a6bcae7cdc05f2b2cd47b525726e9) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 2293a3f2767895e9fb5c3e8f3ec11bb4951a7127) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/classes.rst: document the relative_symlinks classAntonin Godard2025-11-031-0/+19
| | | | | | | | | | | | Added by commit e478550c8cd8 ("openssl/fontconfig/bzip2: Use relative symlinks instead of absolute ones (using a new class)") in OE-Core. (From yocto-docs rev: a8687e4bb2e822670b6ad110613a12fa02943d3d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit c0dc554eba7d421023ecc68a70b7a19df38628b0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/classes.rst: gettext: extend the documentation of the classAntonin Godard2025-11-031-0/+8
| | | | | | | | | | | | | Mention the use of USE_NLS, INHIBIT_DEFAULT_DEPS and the cross-canadian class. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: b16f19e8004d571e7a6eadfa34983781ba6a7634) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit d877e54f1c85cefc00dd674d60f2db81446bd95a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document the USE_NLS variableAntonin Godard2025-11-031-0/+12
| | | | | | | | | | | | | Part of bitbake.conf, this variable allowing to enable or disable translation was undocumented. Add a entry to the glossary. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 675b776390c8079deb8f1912dac44b574688a9c7) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 92a55345a56b5038c0344669daaa7a3a99dd0fc0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document the REQUIRED_IMAGE_FEATURES variableAntonin Godard2025-11-031-0/+17
| | | | | | | | | | | | | Added by commit 96a9702a24a7 ("distro_features_check: expand with IMAGE_FEATURES") in OE-Core. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 7c387b11c9844809a0f8debb5b21f5c0a0220d97) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 860ddbd491ee9db291868bd939392538a2c64a4b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document the REQUIRED_COMBINED_FEATURES variableAntonin Godard2025-11-031-0/+10
| | | | | | | | | | | | | Added in OE-Core commit: 5f4875b950ce ("distro_features_check: expand with MACHINE_FEATURES and COMBINED_FEATURES, rename"). Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: b6dfa4af0bd0b7c8c2a642b377f8fbf7b24cc4e8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit bbc7f26240c2db5cd4179f297ae49c778789514e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document the REQUIRED_MACHINE_FEATURES variableAntonin Godard2025-11-031-0/+9
| | | | | | | | | | | | | Added in OE-Core commit: 5f4875b950ce ("distro_features_check: expand with MACHINE_FEATURES and COMBINED_FEATURES, rename"). Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 5270b62a0a10169710be11561f1c2623f550f567) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit c0551456cba6016d5014c2be8d6906e58a324cc4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/classes,variables: document the CCACHE_DISABLE variableAntonin Godard2025-11-032-2/+11
| | | | | | | | | | | | | Can be used in recipes that want to explicitly skip Ccache support when the ccache class is enabled. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: e4fb6cd20955046a397b63bfe57f6cb4020b9cbb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit b1b4adc8d4d9d23ff6fd91bca632bb0f5277e72b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* variables.rst: fix LAYERDEPENDS descriptionJoão Marcos Costa2025-11-031-1/+1
| | | | | | | | | | | | | This variable does not apply to the scope of a single recipe, but rather to the scope of the entire layer. (From yocto-docs rev: a86f2e5d291b86dbf56aefab08f4d3b0e5529801) Signed-off-by: João Marcos Costa <joaomarcos.costa@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit eec26e11adb6e3a9c4f53f825b9a1730c9ddee12) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/classes.rst: extend the uninative class documentationAntonin Godard2025-11-031-16/+45
| | | | | | | | | | | | | | Extend the documentation of the uninative class based on [1]. [1]: https://lore.kernel.org/r/061e6150ce177221f7b6ee8754b03a20347a92c3.camel@linuxfoundation.org Co-developed-by: Richard Purdie <richard.purdie@linuxfoundation.org> (From yocto-docs rev: 0193bfa7966f301e46253e25eaa0482aeb21d9d4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 68996f0f3bf882714e8d96a0aa7b2492fe16d0c3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document UNINATIVE_URL/CHECKSUMAntonin Godard2025-11-031-0/+16
| | | | | | | | | | | Document the UNINATIVE_URL and UNINATIVE_CHECKSUM variables. (From yocto-docs rev: 6b2440465ed6d48b2ec504940dda9517db863796) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 974fe4e1c5db65b462a382e089e016326e7b3f26) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: fix the description of STAGING_DIRAdam Blank2025-10-091-1/+1
| | | | | | | | | | | | | There is no single "recipe-sysroots" directory, but rather many "recipe-sysroot*" directories. (From yocto-docs rev: 6f086fd3d9dbbb0c80f6c3e89b8df4fed422e79a) Signed-off-by: Adam Blank <adam.blank.g@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit f2d6e228409cb1dd1dbf339c405699ac6d3900be) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/structure: document the auto.conf fileAntonin Godard2025-10-091-0/+9
| | | | | | | | | | | | Add documentation for auto.conf, which is used by external tools for automatically setting variables. (From yocto-docs rev: c16beccd7fa836a6bc77bb0a9d3274508bd3c6ff) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 134e54a75e0144c4629f702c6f43e92ed1f12dce) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: fix the description of KBUILD_DEFCONFIGAdam Blank2025-10-091-2/+1
| | | | | | | | | | | | Remove some leftover confusing mention of KMACHINE. (From yocto-docs rev: fd6f21b40b7fb58e7b465bbe97b8308f7a09313d) Signed-off-by: Adam Blank <adam.blank.g@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 582ee9e0b4930aea03255542b3d3913df19af8b0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: expand IMAGE_OVERHEAD_FACTOR glossary entryJoao Marcos Costa2025-09-171-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | There's a (second) overhead factor applied in images generated with Wic, and this is already documented in the .wks reference. However, the IMAGE_OVERHEAD_FACTOR entry does not mention it, and by looking at the partition sizes (e.g. with parted) one may find it confusing that they don't match with the expected rootfs size (e.g. in a scenario where the extra space is "0" and IMAGE_OVERHEAD_FACTOR="1.0"). This second overhead is already documented, though: https://docs.yoctoproject.org/ref-manual/kickstart.html#command-part-or-partition Mention the '--overhead-factor' option in the glossary entry and add a reference to the wks documentation. (From yocto-docs rev: 18a0dcefd4e688d60e57e8531b0ac283764e4e89) Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit b9040e20b015e9b02683ec3014e4ade5eb59d41a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/classes.rst: document the testexport classAntonin Godard2025-08-201-0/+16
| | | | | | | | | | | | | This class has been in OE-Core for a while but never documented in the reference manual. Add some description for it and link to the existing documentation on it. (From yocto-docs rev: dd665216fa578a1f2f268790d708c6a5d2912ecf) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 362a331255525fc853dab3af4ec905c417fabb0b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document SPL_DTB_BINARYAntonin Godard2025-08-202-0/+8
| | | | | | | | | | | This variable is part of uboot-sign but not documented. (From yocto-docs rev: 999e81f17bf60e187e709368ede3965df19bee59) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 05eb461cb1da76ad9cbaf634da7f47447b3f6765) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document the FIT_CONF_PREFIX variableAntonin Godard2025-08-201-0/+4
| | | | | | | | | | | | Added by commit 7892ee3dc37d ("kernel-fitimage: allow overriding FIT configuration prefix") in OE-Core, but never documented. (From yocto-docs rev: 47a0181cc471667d78f7810aa1ef55027a761a82) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 860891492b96eb127af5e7bab6348fca12167c68) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/system-requirements.rst: update supported distributionsAntonin Godard2025-08-201-23/+30
| | | | | | | | | | | | | | | | Update the distributions to match the list of workers on the Autobuilder. This list was generated with the help of yocto-autobuilder-helper/scripts/yocto-supported-distros. Also: - Sort the lists alphabetically. - Decrease spacing between entries for readability. (From yocto-docs rev: e99a9283e30ae2b844018d1ffb88560ab6877ab7) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* variables.rst: remove references to obsolete tar packagingRobert P. J. Day2025-08-041-10/+4
| | | | | | | | | | | | | The tar packaging format was removed some time ago. Also, add some minor grammatical tweaking. (From yocto-docs rev: 0c154c1f431be918c4c9ce3047c12099925a9c53) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 8e9fd1ca232f3c1e8be51cb881a68b4745ee548a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: document KERNEL_SPLIT_MODULES variableDixit Parmar2025-07-071-0/+21
| | | | | | | | | | | | | | This variable controls the kernel module spliting. [YOCTO #15771] (From yocto-docs rev: 80b3bb27e4efa73b982f4bfeccca4deedf78c0d7) Signed-off-by: Dixit Parmar <dixitparmar19@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 198179d9c6231b5934d4fb6ede716d1dcb1442bb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: classes: nativesdk: move note to appropriate sectionQuentin Schulz2025-06-201-10/+10
| | | | | | | | | | | | | | | | The nativesdk- prefix to the recipe filename should only be used when using the inherit method as the BBCLASSEXTEND method will do some magic when generating the "implicit" name of the recipe. This matches the instructions for the native class. (From yocto-docs rev: c44d05d11833de4645d72fb8f987123e693494f4) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 15fe239e1e62b9add737aa732dd7f5e9948ee03d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: classes: reword to clarify that native/nativesdk options are ↵Quentin Schulz2025-06-201-2/+4
| | | | | | | | | | | | | | | | | | | | exclusive We explain how to create a native (nativesdk) recipe in two different ways via a bullet list but reading quickly the instructions may mislead one into doing both options whereas they are incompatible. This rewords both the nativesdk and native sections so that the second bullet point starts with an Or and explicit that this applies to target recipes. (From yocto-docs rev: 70194ee42c946e1a2122ac143612e334fcbc5241) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6d0d338a5f2686ddeee5eed7b6e05f3db800d33a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: clarify KCONFIG_MODE default behaviourCarlos Sánchez de La Lama2025-06-111-9/+2
| | | | | | | | | | | | | KCONFIG_MODE defaults to 'allnoconfig' when not set, regardless of whether KBUILD_DEFCONFIG points to an in-tree or a meta-layer defconfig. (From yocto-docs rev: c9bceea147c807b942ce6bcf085a31d9388ecc79) Signed-off-by: Carlos Sánchez de La Lama <csanchezdll@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit f374b9c426f6c10710e011a4ad660231ee26efb8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* brief-yoctoprojectqs/ref-manual: Switch to new CDNRichard Purdie2025-06-111-1/+1
| | | | | | | | | | | | | | | The project is switching the way handle our CDN provision of sstate objects, update the URL accordingly. (cherry picked from commit 406e8a8e30404c0538f5aa46f211540bae2b206b) (From yocto-docs rev: bede97cfde51823e262e300aa346902d23530490) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Steve Sakoman <steve@sakoman.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document INHIBIT_UPDATERCD_BBCLASSAlper Ak2025-05-271-0/+19
| | | | | | | | | | | | Fix [YOCTO #15753] (From yocto-docs rev: 3996388e337377bedc113d072a51fe9d68dd40c6) Signed-off-by: Alper Ak <alperyasinak1@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 5f5a406d4acdfcbf655ac014d0d2807056f95291) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document SSTATE_SKIP_CREATIONEtienne Cordonnier2025-05-271-0/+20
| | | | | | | | | | (From yocto-docs rev: 40045299491087d3f7d269b696ae48d513dae435) Signed-off-by: Etienne Cordonnier <ecordonnier@snap.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 3982720668aafa18c9ed27304d09f896740b1653) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document INHIBIT_DEFAULT_RUST_DEPSAlper Ak2025-05-271-0/+17
| | | | | | | | | | | | Fix [YOCTO #15755] (From yocto-docs rev: 2eb345ffa74d58d209a6a8deb27b228c37628034) Signed-off-by: Alper Ak <alperyasinak1@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit fd143a04bab38f6aeec23ec229657b16fcaecdf1) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variableChristos Gavros2025-05-271-0/+14
| | | | | | | | | | | | | | | | | | This variable specifies the maximum allowed size of the initramfs image in Kbytes. Fixes [YOCTO #15797] CC: Yoann Congal <yoann.congal@smile.fr> CC: Randy MacLeod <randy.macleod@windriver.com> CC: Antonin Godard <antonin.godard@bootlin.com> (From yocto-docs rev: 123d1ec8e532751ac416c21e3eaa92fd904e2171) Signed-off-by: Christos Gavros <gavrosc@yahoo.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 07bcdddaf71c76cdec186cf0ddd97a47eec54972) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document the IMAGE_ROOTFS_MAXSIZE variableChristos Gavros2025-05-271-3/+27
| | | | | | | | | | | | | | | | | This variable specifies the maximum allowed size of the generated image in kilobytes. CC: Yoann Congal <yoann.congal@smile.fr> CC: Randy MacLeod <randy.macleod@windriver.com> CC: Antonin Godard <antonin.godard@bootlin.com> CC: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: d45174d03e1ccd422b9210e3ba1f648d2f6b5173) Signed-off-by: Christos Gavros <gavrosc@yahoo.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit f3ddc92081363aa7ef7d4fc2c3b918f32f7bda05) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* sphinx-lint: unbalanced inline literal markupTrevor Woerner2025-05-275-9/+9
| | | | | | | | | | | | | | Fix as many instances of unbalanced-inline-literals-delimiters as reported by 'make sphinx-lint' as possible. Sphinx and/or its linter seem to get tripped up randomly when references contain links to heading which contain literals enclosed in double-back-tics, and not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 0ba5429953dfa0cdc983ed13ddd06351116031c7) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document WIC_CREATE_EXTRA_ARGSTrevor Woerner2025-05-191-0/+14
| | | | | | | | | | | | | Fixes [YOCTO #15509] Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 38706f0e743447da9a39a6369620fa039ab6df3b) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit f1cdecb6da91dbfac59359c83038cb4a4c36ad0a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: update ROOT_HOME documentationEnrico Jörns2025-05-191-8/+3
| | | | | | | | | | | | | | | | | | | | | | * Since scarthgap [1], the default will be overridden when using 'systemd' as INIT_MANAGER. Reflect this in the documentation. * The distro configuration is probably the better place for customization, thus at least mention this together with the local.conf. * While at it, drop the probably redundant description on how to override weak default variables. The example on how to set "/root" is still given indirectly, anyway. [1] ebafe463 ("systemd: upgrade to 255.1") (From yocto-docs rev: f1f92f0a5a881c45ffecf9cf9bd070c992aff35a) Signed-off-by: Enrico Jörns <ejo@pengutronix.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 50e92009d309fc4ae406174feb8f6578142748cc) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: kernel-fitimage.bbclass does not use SPL_SIGN_KEYNAMEAdrian Freihofer2025-05-191-1/+1
| | | | | | | | | | | | | | The kernel-fitimage.bbclass uses the UBOOT_* variables. The SPL_* variables are handled by uboot-sign.bbclass. (From yocto-docs rev: 0d4cda12f2c3f89f64043c30cc0830dfa632e76e) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 8ceffee908a039deb1021361faa7637e83ef26f3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/release-process: update releases.svgAntonin Godard2025-05-191-86/+432
| | | | | | | | | | | | | - Add the future "Whinlatter" (5.3) and "Wrynose" (6.0) releases. - Make the "Walnascar" release a current release. - Update the month in Current. (From yocto-docs rev: 0c08c88aad0a2acf04d2da0f2935f29bc6a6eb99) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit adb8573b54626e033921a9f4e3db259312b79207) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* Fix dead links that use the DISTRO macroAntonin Godard2025-04-282-2/+2
| | | | | | | | | | | | | | | | | | | | After introducing the DISTRO_LATEST_TAG and DISTRO_REL_LATEST_TAG macros, use them in links that currently use DISTRO/DISTRO_REL_TAG. When building for the tip of a branch, this will replace the current A.B.999 in links to the latest existing tag. The links were found across the documentation by running 'grep -r "http.*5\.2\.999"' inside the _build/html output after building the docs. [YOCTO #14802] (From yocto-docs rev: d1f3616b373334a5aa75ad7874f05ee4b0e6591f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 29be069ebbf2c55d72fc51d99ed5a558af37c05e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: improve the PKGV documentationAntonin Godard2025-04-281-0/+17
| | | | | | | | | | It may be confusing for users that source control information is not present in the BitBake environment. Document it as a warning block. (From yocto-docs rev: 990b3708d7131ccfb4e435e8a53e987195de3e06) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: HOST_CC_ARCH: fix wrong SDK referenceAntonin Godard2025-04-281-2/+1
| | | | | | | | | | | | | When building for nativesdk recipes, HOST_CC_ARCH equals SDK_CC_ARCH, not BUILDSDK_CC_ARCH which doesn't exist. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: ba030d9d65702889b089bd3c9cb6a719a7e0a413) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 08fc3446cb13b5bd8781874d2d996899ce12b082) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document HOST_*_ARCH variablesAntonin Godard2025-04-281-0/+27
| | | | | | | | | | | | | These variables control the flags for the assembler, compiler and linker, but depend on the context. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 1520ba47f66c6d51f710005cdd4f4b880eccd5b0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit f8eb33569a5e8cadc036855e2d95eee77e627cb4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document missing SDK_*_ARCH variablesAntonin Godard2025-04-281-0/+15
| | | | | | | | | | | | | These variables control the flags for the assembler, compiler and linker when building for nativesdk recipes. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 95f4aabe48a6e06f8391e032c6a7038bf0e10332) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit c08f6d3c8aee86264c069b7c30850cb02de76076) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: add missing documentation for BUILD_* variablesAntonin Godard2025-04-281-20/+230
| | | | | | | | | | | | | | | | | | | | These toolchain variables are used in a native context. Some of the BUILD_* variables missed documentation. Also, some of the base commands were also not there so document them. Some of existing BUILD_* variable documentation were missing the note about their usage in a native context, so add it too so that all BUILD_* variables are documented the same way. [YOCTO #15719] Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: e692a7553ccf7496288f2eb7df71766cb5261eb4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 87103afa1cb6690e9aaa87ca1f23e45eaaa359ac) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: add manpage links for toolchain variablesAntonin Godard2025-04-281-9/+11
| | | | | | | | | | | | Use the :manpage: role to provide links to common toolchain utilities. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: adfb1a4a768f53a0404b65297f7fa9ed12b77088) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 7023e5f176efde05a6798476712c8a4e006a6b0d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* documentation/conf.py: define a manpage urlAntonin Godard2025-04-281-2/+1
| | | | | | | | | | | | | | | | By defining the manpages_url we can use the :manpage: role in the documentation for providing links to manpages. See: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url Replace existing manpages links to use this role. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 73faf4a4fdd3d536e8af92b49bf067746cd9fa05) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 4e63cd74cd1a330ea5e96bb04243a90f607b2857) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document autotools class related variablesAntonin Godard2025-04-281-0/+17
| | | | | | | | | Document the AUTOTOOLS_SCRIPT_PATH and the CONFIGURE_SCRIPT variables. (From yocto-docs rev: b63d665549e14e1a468ffbf07c8494a491833770) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2026-02-12 18:11:16 +0000