summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* The poky repository master branch is no longer being updated.Richard Purdie2025-11-0722-24211/+0
| | | | | | | | | | | | | | | | | | | | | You can either: a) switch to individual clones of bitbake, openembedded-core, meta-yocto and yocto-docs b) use the new bitbake-setup You can find information about either approach in our documentation: https://docs.yoctoproject.org/ Note that "poky" the distro setting is still available in meta-yocto as before and we continue to use and maintain that. Long live Poky! Some further information on the background of this change can be found in: https://lists.openembedded.org/g/openembedded-architecture/message/2179 Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/terms.rst: update Poky descriptionAntonin Godard2025-11-071-2/+17
| | | | | | | | | | | Poky as in the repository will no longer be updated. Update the description of Poky to remove the last bullet point, and add a note to say that Poky was used before. (From yocto-docs rev: c6f5de9fdbab3f29336ac3bf30150de8777bcad7) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: switch to bitbake-setupAntonin Godard2025-11-071-0/+5
| | | | | | | | | | | | | | | | Switch to bitbake-setup as it has been merged in BitBake with commit b96154aeb1fc ("bitbake-setup: add the initial implementation"). This is the default way to setup repositories now, so describe it in brief-yoctoprojectqs.rst. Update the BSP layer addition section to use meta-raspberrypi as meta-altera seems abandoned (latest compatible version: mickedore). Co-developed-by: Tim Orling <tim.orling@konsulko.com> (From yocto-docs rev: 868da60dd90ee6c8710df1ed14b046d809d25b52) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/fragments.rst: document core/yocto/root-login-with-empty-password ↵Antonin Godard2025-11-071-0/+9
| | | | | | | | | | | | fragment Added by commit e135458415de ("fragments: add a 'root-login-with-empty-password' fragment") in OE-Core. (From yocto-docs rev: 072ac843992189f836f72f4be8d873cc8657a918) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/structure.rst: document the site.conf fileAntonin Godard2025-11-071-0/+29
| | | | | | | | | | | | This was not documented and its usage is going to increase massively once users start using bitbake-setup. Add a description for this file as well as an example on how bitbake-setup shares it for multiple builds, to insist on the "site-wide" usage of this file. (From yocto-docs rev: 42f68f7de7f0cf74ebdd31fae3173dd3a80386ff) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/structure.rst: update the description of local.conf and bblayers.confAntonin Godard2025-11-071-20/+16
| | | | | | | | | | | | | | | | | The local.conf file is now mostly empty with the default way of setting up the environment (with bitbake-setup), and this file is meant to hold local user configurations, rather than an extensive list of variables. Adjust the description to reflect the intended way of using this configuration file. Also, for both local.conf and bblayers.conf, rephrase the current usage of the template files (.sample files) to _not_ imply that it is the default way the OpenEmbedded build system sets things up. (From yocto-docs rev: 24f24d07fd688825b2ec39dcf0daf8203577f87a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document UBOOT_MAKE_OPTSAntonin Godard2025-10-292-2/+12
| | | | | | | | | | | | This variable was added by commit 3338330e0c46 ("u-boot: Add specifying make options as part the config looping") in OE-Core. Document how to use the option in UBOOT_CONFIG. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 0fc14dca55d3760491cc40ac8c136c9dbdd23dbb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: document the relative_symlinks classAntonin Godard2025-10-291-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: c0dc554eba7d421023ecc68a70b7a19df38628b0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/features.rst: add entry for the coresight machine featureAntonin Godard2025-10-291-0/+5
| | | | | | | | | | | Added by commit c455bd039104 ("perf: enable coresight if enabled in MACHINE_FEATURES") in OE-Core. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 4b010341a83f515140cb52329107d6da04590a8c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: document the rust-target-config classAntonin Godard2025-10-291-0/+13
| | | | | | | | | Document the rust-target-config class. (From yocto-docs rev: a9dc48f4bbfb9abfdffc7f0caa8285f7c72cc2d9) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: gettext: extend the documentation of the classAntonin Godard2025-10-291-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: d877e54f1c85cefc00dd674d60f2db81446bd95a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the USE_NLS variableAntonin Godard2025-10-291-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: 92a55345a56b5038c0344669daaa7a3a99dd0fc0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the REQUIRED_IMAGE_FEATURES variableAntonin Godard2025-10-291-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: 860ddbd491ee9db291868bd939392538a2c64a4b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the REQUIRED_COMBINED_FEATURES variableAntonin Godard2025-10-291-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: bbc7f26240c2db5cd4179f297ae49c778789514e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the REQUIRED_MACHINE_FEATURES variableAntonin Godard2025-10-291-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: c0551456cba6016d5014c2be8d6906e58a324cc4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the REQUIRED_TUNE_FEATURES variableAntonin Godard2025-10-291-0/+9
| | | | | | | | | | | | Very similar to REQUIRED_DISTRO_FEATURES, added by commit a8ef7339ecb9 ("features_check.bbclass: Add support for required TUNE_FEATURES") in OE-Core. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 9652c101092c34233f00418fcc2a84a86fbc9a9b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes,variables: document the CCACHE_DISABLE variableAntonin Godard2025-10-292-0/+9
| | | | | | | | | | | 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: b1b4adc8d4d9d23ff6fd91bca632bb0f5277e72b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: ccache: mention that the host's ccache can be usedAntonin Godard2025-10-291-2/+9
| | | | | | | | | | | This feature was added by commit cc91a0f6500e ("ccache: enable ccache for all recipes if it is in HOSTTOOLS") in OE-Core. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 47ded4e32c28420ddb47278b299093af649fab75) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: document the python_pdm classAntonin Godard2025-10-291-0/+13
| | | | | | | | | | | This class was added by commit 20758865e9e0 ("classes/python_pdm: add PEP517 build class for PDM") in OE-Core. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: bbec8adf0fb2dfa8b34e631249a6d6e71aa08386) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/features.rst: add new opencl featureAntonin Godard2025-10-291-0/+3
| | | | | | | | | | | Added by commit 3061d6061e74 ("mesa: add opencl DISTRO_FEATURE") in OE-Core. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 202adb84fdad6673ed5b91a6c9642791237cf76b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/qa-checks.rst: drop var-undefinedAntonin Godard2025-10-291-11/+0
| | | | | | | | | | | Drop the var-undefined after it was dropped in OE-Core cb69d7eba802 ("package: Drop var-undefined QA check"). Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 5429187f5f034cf86628fb794ded91cdec731123) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document IMAGE_EXTRA_PARTITION_FILESPierre-Loup GOSSE2025-10-291-0/+64
| | | | | | | | | | | | Added by commit 3892912bd7e0 ("wic: extra partition plugin") in OE-Core. [AG: formatting tweaks] (From yocto-docs rev: 3d2aaec8218a7cad5653face152e9cd45257aefe) Signed-off-by: Pierre-Loup GOSSE <pierre-loup.gosse@smile.fr> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* variables.rst: fix LAYERDEPENDS descriptionJoão Marcos Costa2025-10-291-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: eec26e11adb6e3a9c4f53f825b9a1730c9ddee12) Signed-off-by: João Marcos Costa <joaomarcos.costa@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: uboot-config: improve documentationAntonin Godard2025-10-291-6/+52
| | | | | | | | | | | Improve the documentation of the uboot-config class. It was not explaining any of its entry in UBOOT_CONFIG. Mention that using UBOOT_CONFIG and UBOOT_MACHINE at the same time is not possible. (From yocto-docs rev: 3bbd85798f4c9a8b7f930e9f156cf6e970593da0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: fix a typo in UNPACKDIR descriptionAntonin Godard2025-10-291-1/+1
| | | | | | | (From yocto-docs rev: abcb3b7aa449e2cdab9bda1a96b5c63c4e376759) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: extend the uninative class documentationAntonin Godard2025-10-291-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: 68996f0f3bf882714e8d96a0aa7b2492fe16d0c3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document UNINATIVE_URL/CHECKSUMAntonin Godard2025-10-291-0/+16
| | | | | | | | | Document the UNINATIVE_URL and UNINATIVE_CHECKSUM variables. (From yocto-docs rev: 974fe4e1c5db65b462a382e089e016326e7b3f26) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: add note about PSEUDO ignore/include precedenceGyorgy Sarvari2025-10-141-2/+7
| | | | | | | | | | | | | | This commit[1] in pseudo introduced the PSEUDO_INCLUDE_PATHS variable, however the previous PSEUDO_IGNORE_PATHS variable is still present also. Add a clarifying note about the order of precedence of the two. [1]: https://git.yoctoproject.org/pseudo/commit/?id=2c43381180f9cfef4c0a8bb0c1658a86c3fcc876 (From yocto-docs rev: 8b85245490ae0b19a9c3880ec31e55b42e19d094) Signed-off-by: Gyorgy Sarvari <skandigraun@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/fragments.rst: remove duplicated built-in fragment noteAntonin Godard2025-10-141-9/+1
| | | | | | | | | | | This behavior was removed in commit aea2d69d0533 ("lib/bbconfigbuild/configfragments: disable the previous builtin fragment when enabling a new one") in OE-Core. (From yocto-docs rev: e420f0f90614b13fc92654219296182858ca17b9) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/qa-checks.rst: fix referencesAntonin Godard2025-10-141-461/+643
| | | | | | | | | | | | | | | | | | The references in this document do not work because references need to be associated to a title. Change the bullet list into a section separated document. This way we can cross-reference QA checks in other parts of the documentation (it was previously failing when attempted). The diff is a bit hard to digest, but there are no changes to content except for: - A fixed typo (inhert -> inherit) - Indentation (From yocto-docs rev: 93c30b8a430a981e8b89061c968a006a3e086353) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: correctly document the difference between auto.conf and newly ↵Alexander Kanavin2025-10-142-5/+14
| | | | | | | | | | | | added toolcfg.conf [AG: Add reference to YP Autobuilder] (From yocto-docs rev: f23b93594dbe7e5df9ec55371e4aab4b7b8c50b9) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/system-requirements.rst: update supported distributionsAntonin Godard2025-10-031-2/+3
| | | | | | | | | After 837a650aac17 ("poky: Update SANITY_TESTED_DISTROS") in meta-yocto. (From yocto-docs rev: 4e7ce89ff91f5fa7ade1feb7be96f898b56068ed) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: fix the description of STAGING_DIRAdam Blank2025-10-031-1/+1
| | | | | | | | | | | There is no single "recipe-sysroots" directory, but rather many "recipe-sysroot*" directories. (From yocto-docs rev: f2d6e228409cb1dd1dbf339c405699ac6d3900be) Signed-off-by: Adam Blank <adam.blank.g@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add documentation on fragmentsAntonin Godard2025-10-034-0/+390
| | | | | | | | | | | | | | | - terms.rst: Provide the definitions of a Configuration Fragment and a Built-in Fragment. - ref-manual: Add a quick reference guide on bitbake-config-build, and list the available fragments in OE-Core. Document the underlying variables related to fragments in the glossary. - dev-manual: give instructions on how to create new custom fragments. (From yocto-docs rev: 0820b71c830cab4151b0219b6d4013c41f461c6e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/structure: document the auto.conf fileAntonin Godard2025-10-031-0/+9
| | | | | | | | | | Add documentation for auto.conf, which is used by external tools for automatically setting variables. (From yocto-docs rev: 134e54a75e0144c4629f702c6f43e92ed1f12dce) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: fix the description of KBUILD_DEFCONFIGAdam Blank2025-10-031-2/+1
| | | | | | | | | | Remove some leftover confusing mention of KMACHINE. (From yocto-docs rev: 582ee9e0b4930aea03255542b3d3913df19af8b0) Signed-off-by: Adam Blank <adam.blank.g@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/structure.rst: extend PERSISTENT_DIR descriptionAntonin Godard2025-09-261-0/+11
| | | | | | | | | | | | | | Extend the description of PERSISTENT_DIR to mention that it should not be shared between builds. Add a note on sharing the hash equivalence database by setting up a server and not sharing the file in this directory. [YOCTO #15727] (From yocto-docs rev: 0ff0233770b77f9e74f4241dfb555dac2741d8b9) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/kickstart.rst: add extra-partition-spacePierre-Loup GOSSE2025-09-161-1/+11
| | | | | | | | | | | | | | | | After commits 47533f20a7ec ("wic: rename wks flag --extra-space to --extra-filesystem-space") and c7f51c23fd268 ("wic: add --extra-partition-space option to set unused space") in openembedded-core, document the new Wic-specific option extra-partition-space and rename the extra-space option to extra-filesystem-space. CC: Alexander Kanavin <alex.kanavin@gmail.com> (From yocto-docs rev: cba5dbb32a24c9e20e5a6066ec382cf7ff9b93e2) Signed-off-by: Pierre-Loup GOSSE <pierre-loup.gosse@smile.fr> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: expand IMAGE_OVERHEAD_FACTOR glossary entryJoao Marcos Costa2025-09-161-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: b9040e20b015e9b02683ec3014e4ade5eb59d41a) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/terms.rst: sort entriesAntonin Godard2025-08-081-13/+13
| | | | | | | | | | | | | | | | | | | | | | | documentation/scripts/check-glossaries returns: WARNING: ref-manual/terms.rst: entries are not properly sorted: --- original_list +++ sorted_list @@ -17,8 +17,8 @@ LTS Metadata Mixin +OpenEmbedded Build System OpenEmbedded-Core (OE-Core) -OpenEmbedded Build System Package Package Groups Poky (From yocto-docs rev: e3c05f82596239c12dcb9871e6dac434c46bacec) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: sort variablesAntonin Godard2025-08-081-129/+129
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | documentation/scripts/check-glossaries returns: WARNING: ref-manual/variables.rst: entries are not properly sorted: --- original_list +++ sorted_list @@ -12,8 +12,8 @@ ASSUME_PROVIDED ASSUME_SHLIBS AUTO_LIBNAME_PKGS +AUTO_SYSLINUXMENU AUTOREV -AUTO_SYSLINUXMENU AUTOTOOLS_SCRIPT_PATH AVAILTUNES AZ_SAS @@ -28,8 +28,8 @@ BB_CACHEDIR BB_CHECK_SSL_CERTS BB_CONSOLELOG +BB_CURRENT_MC BB_CURRENTTASK -BB_CURRENT_MC BB_DEFAULT_TASK BB_DEFAULT_UMASK BB_DEFER_BBCLASSES @@ -188,13 +188,13 @@ CVE_CHECK_REPORT_PATCHED CVE_CHECK_SHOW_WARNINGS CVE_CHECK_SKIP_RECIPE +CVE_CHECK_STATUSMAP +CVE_CHECK_VEX_JUSTIFICATION CVE_DB_INCR_UPDATE_AGE_THRES CVE_DB_UPDATE_INTERVAL CVE_PRODUCT CVE_STATUS CVE_STATUS_GROUPS -CVE_CHECK_STATUSMAP -CVE_CHECK_VEX_JUSTIFICATION CVE_VERSION CVSDIR CXX @@ -254,9 +254,8 @@ EXCLUDE_FROM_WORLD EXTENDPE EXTENDPKGV +EXTERNAL_KERNEL_DEVICETREE EXTERNAL_KERNEL_TOOLS -EXTERNAL_KERNEL_DEVICETREE -KERNEL_LOCALVERSION EXTERNAL_TOOLCHAIN EXTERNALSRC EXTERNALSRC_BUILD @@ -267,8 +266,8 @@ EXTRA_OECMAKE EXTRA_OECONF EXTRA_OEMAKE +EXTRA_OEMESON EXTRA_OESCONS -EXTRA_OEMESON EXTRA_USERS_PARAMS EXTRANATIVEPATH FAKEROOT @@ -300,8 +299,8 @@ FIT_KEY_GENRSA_ARGS FIT_KEY_REQ_ARGS FIT_KEY_SIGN_PKCS +FIT_PAD_ALG FIT_SIGN_ALG -FIT_PAD_ALG FIT_SIGN_INDIVIDUAL FIT_SIGN_NUMBITS FIT_UBOOT_ENV @@ -431,6 +430,7 @@ KERNEL_IMAGE_NAME KERNEL_IMAGETYPE KERNEL_IMAGETYPES +KERNEL_LOCALVERSION KERNEL_MODULE_AUTOLOAD KERNEL_MODULE_PROBECONF KERNEL_PACKAGE_NAME @@ -505,15 +505,15 @@ OBJCOPY OBJDUMP OE_BINCONFIG_EXTRA_MANGLE -OECMAKE_GENERATOR OE_INIT_ENV_SCRIPT OE_SHARED_UMASK OE_TERMINAL -OEROOT +OECMAKE_GENERATOR OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS OEQA_REPRODUCIBLE_TEST_PACKAGE +OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS OEQA_REPRODUCIBLE_TEST_TARGET -OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS +OEROOT OLDEST_KERNEL OPKG_MAKE_INDEX_EXTRA_PARAMS OPKGBUILDCMD @@ -691,11 +691,11 @@ SPDX_ARCHIVE_PACKAGED SPDX_ARCHIVE_SOURCES SPDX_CUSTOM_ANNOTATION_VARS +SPDX_INCLUDE_COMPILED_SOURCES SPDX_INCLUDE_SOURCES -SPDX_INCLUDE_COMPILED_SOURCES SPDX_NAMESPACE_PREFIX +SPDX_PACKAGE_URL SPDX_PACKAGE_VERSION -SPDX_PACKAGE_URL SPDX_PRETTY SPDXLICENSEMAP SPECIAL_PKGSUFFIX @@ -707,12 +707,12 @@ SPL_SIGN_KEYNAME SPLASH SPLASH_IMAGES -SRCREV_FORMAT SRC_URI SRC_URI_OVERRIDES_PACKAGE_ARCH SRCDATE SRCPV SRCREV +SRCREV_FORMAT SRCTREECOVEREDTASKS SSTATE_DIR SSTATE_EXCLUDEDEPS_SYSROOT @@ -779,9 +779,9 @@ TARGET_PREFIX TARGET_SYS TARGET_VENDOR +TC_CXX_RUNTIME TCLIBC TCMODE -TC_CXX_RUNTIME TEMPLATECONF TEST_EXPORT_DIR TEST_EXPORT_ONLY @@ -804,9 +804,9 @@ TOOLCHAIN TOOLCHAIN_HOST_TASK TOOLCHAIN_HOST_TASK_ESDK +TOOLCHAIN_NATIVE TOOLCHAIN_OPTIONS TOOLCHAIN_OUTPUTNAME -TOOLCHAIN_NATIVE TOOLCHAIN_TARGET_TASK TOPDIR TRANSLATED_TARGET_ARCH @@ -860,13 +860,13 @@ UBOOT_SUFFIX UBOOT_TARGET UBOOT_VERSION -UKIFY_CMD UKI_CMDLINE UKI_CONFIG_FILE UKI_FILENAME UKI_KERNEL_FILENAME UKI_SB_CERT UKI_SB_KEY +UKIFY_CMD UNKNOWN_CONFIGURE_OPT_IGNORE UNPACKDIR UPDATERCPN @@ -897,7 +897,7 @@ WKS_FILES WORKDIR XSERVER +XZ_MEMLIMIT XZ_THREADS -XZ_MEMLIMIT ZSTD_COMPRESSION_LEVEL ZSTD_THREADS (From yocto-docs rev: 5cc4f262844a202553112a01f7203c9220d30fae) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: fix the glossaryAntonin Godard2025-08-081-2/+2
| | | | | | | | | | | | documentation/scripts/check-glossaries returns: WARNING: ref-manual/variables.rst: The variable EFI_PROVIDER shouldn't be in the glossary. WARNING: ref-manual/variables.rst: The variable ZSTD_THREADS shouldn't be in the glossary. (From yocto-docs rev: 4d3952414d109f9c9ebb029f3e20018664eacc86) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add a script to validate documentation glossariesAntonin Godard2025-08-081-0/+6
| | | | | | | | | | | | | | | | | | | | Instead of tracking the glossary manually, add a small script that checks if it is properly sorted. Add two comments between the start and end of the glossary for the script to know where it's located. The script also checks if the variables are properly sorted. It uses difflib and returns the diff if there's a difference between the unsorted and sorted list. Messages beginning with "WARNING:" are reported by the Autobuilder, which is the reason for this format. (From yocto-docs rev: 416d50c0c322eb88bf13353a198db7211e4d665a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs-wide: fix space around equal assignmentsAntonin Godard2025-08-081-3/+3
| | | | | | | | | | | | | Since commit 24772dd2ae6c ("parse/ConfHandler: Add warning for deprecated whitespace usage") in BitBake, a warning is printed when there are no spaces around an `=` assignment. Adjust the documentation to show good examples only. (From yocto-docs rev: 77ce1544dd793036b1135817c02e090138fe6407) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/qa-checks.rst: add space around equal warningAntonin Godard2025-08-081-0/+16
| | | | | | | | | | | | | After commit 24772dd2ae6c ("parse/ConfHandler: Add warning for deprecated whitespace usage") in BitBake, a warning is printed is there's a missing space around an equal assignment in recipes. Add a qa-check entry to qa-checks.rst. (From yocto-docs rev: da2e9d45a4c70c5d78d225277a85cc4173e4ee7a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/tasks.rst: do_package_qa: update link to qa checksAntonin Godard2025-08-081-1/+1
| | | | | | | | | | | Link to the updated qa-checks document that contains the entire list of checks. The insane class was recently updated to remove all its checks description and move them to qa-checks.rst. (From yocto-docs rev: 0fcd1a352ae364bee191e7d160b2fec35431fcfd) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs-wide: update wic source plugin namesAntonin Godard2025-08-082-3/+3
| | | | | | | | | | | WIC plugins were renamed after commit 2de444fc3ef4 ("wic: plugins source bootimage/isoimage rename to allow be imported") in OE-Core. They no longer contain dashes, but underscores. (From yocto-docs rev: 7224d7733e9e0f423475e1b9c5b48aff0de1f744) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: document the testexport classAntonin Godard2025-08-081-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: 362a331255525fc853dab3af4ec905c417fabb0b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document CVE_CHECK_VEX_JUSTIFICATIONAntonin Godard2025-08-081-0/+7
| | | | | | | | | | Added by commit c0fa3d92cefa ("spdx30: Allow VEX Justification to be configurable") in OE-Core. (From yocto-docs rev: cee3eb30cc736d990f2232ede0bc6d9686a63713) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document OE_SHARED_UMASKAntonin Godard2025-08-081-0/+5
| | | | | | | | | | Added by commit ce32daa9843b ("bitbake.conf/sstate: Introduce OE_SHARED_UMASK to standarise shared area umask") in OE-Core. (From yocto-docs rev: b0a6f80a3216faf6c6add785aab2257a53b667dc) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-12-08 14:54:08 +0000