summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* test-manual/yocto-project-compatible.rst: fix a typoAntonin Godard7 days1-1/+1
| | | | | | | | | | Fix a typo in yocto-project-compatible.rst. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: a84c234acfedfa714419006c743405e2f9acaedc) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides/release-notes-5.3: using runqemu with compressed imagesYoann Congal7 days1-0/+7
| | | | | | | | | | | | | | | In OE-core commits: * b5f8c3e029 (selftest: runqemu: add tests for booting zst compressed image, 2025-07-31) * e069fe2480 (runqemu: Add support for running compressed .zst rootfs images, 2025-07-31) runqemu gained the ability to run compressed image (+associated test). Add this information to the release-notes for 5.3. (From yocto-docs rev: f268c1b649227d533d02e1a6df797b784fcf80de) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: submit-changes: make "Crediting contributors" part of ↵Quentin Schulz7 days1-25/+29
| | | | | | | | | | | | | | | | | | | | | "Commit your changes" There's no need to differentiate crediting contributors from committing your changes, so let's simply make it the last step of "Commit your changes" section. This simply indents the text so it's now part of "Commit your changes" list instead of the main list in the "Implement and commit changes" section. Because of this reorganisation, the instruction to use "git commit --amend" to add the contributors is moved to a note, and the first few sentences are reworded to better match the wording of other items in the "Commit your changes" list of instructions. (From yocto-docs rev: eff4d14e28d323ebfdaeb0c5c805b5f1e2ad153d) Signed-off-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>
* contributor-guide: submit-changes: number instruction list in commit your ↵Quentin Schulz7 days1-76/+76
| | | | | | | | | | | | | changes ... so that it's clear that you need to read and follow each and every instruction in this list. (From yocto-docs rev: c628a489f081925fabaabb5acac6752251150269) Signed-off-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>
* contributor-guide: submit-changes: reword commit message instructionsQuentin Schulz7 days1-9/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | This should hopefully make it clearer what is expected from the contributor. This follows my understanding of git-commit(1)[1] where the following is a git commit message: """ git commit title git commit description """ I'm putting the "Fixes [YOCTO" line in "body of the commit message" so it's understood as being different from the git commit description so that the note admonition allowing us to have an empty commit description doesn't apply to the "Fixes [YOCTO" line. [1] https://www.man7.org/linux/man-pages/man1/git-commit.1.html#DISCUSSION (From yocto-docs rev: b84903a760350bd118c56ea9ce4e98039edf6e55) Signed-off-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>
* contributor-guide: submit-changes: make the Cc tag follow kernel guidelinesQuentin Schulz7 days1-1/+1
| | | | | | | | | | | | | The kernel docs specifies[1] a Cc: tag and not CC: tag, so let's align with that. [1] https://www.kernel.org/doc/html/latest/process/submitting-patches.html#when-to-use-acked-by-cc-and-co-developed-by (From yocto-docs rev: f800fef4e9e2c1d3584ac49be8324638d2923b17) Signed-off-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>
* contributor-guide: submit-changes: align CC tag descriptionQuentin Schulz7 days1-1/+1
| | | | | | | | | | | | The other tag descriptions have the double colon outside of the highlight, and start the sentence with a lowercase word, so let's align the CC tag with those. (From yocto-docs rev: f116e93fb335e9d0f85891c4cb501bcf55b18ccf) Signed-off-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>
* contributor-guide: submit-changes: clarify example with Yocto bug IDQuentin Schulz7 days1-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | The example could be understood as the content of the commit message once the editor (git config core.editor) opens, where the first line is the actual commit title and not the commit description. This example would make the Fixes line the commit title, which is not what we want. In short, according to my understanding of git-commit(1): The following is a git commit message: """ git commit title git commit description """ Reported-by: Barne Carstensen <barne.carstensen@danfoss.com> (From yocto-docs rev: a5862406bf3230befe9db9f2539bbbc86c02015d) Signed-off-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>
* contributor-guide: submit-changes: fix improper bold stringQuentin Schulz7 days1-1/+1
| | | | | | | | | | | | | I don't know what was the initial intent but this doesn't seem right, so let's remove the bold formatting. Fixes: 4abe87cb20d3 ("contributor-guide: submit-changes: detail commit and patch creation") Cc: Michael Opdenacker <michael.opdenacker@rootcommit.com> (From yocto-docs rev: 6c499b3796a578a0fe4c319c9547b4321b0d41df) Signed-off-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/structure.rst: extend PERSISTENT_DIR descriptionAntonin Godard7 days1-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>
* migration-5.3.rst: Correct info about the removed libsoup-2.4 recipePeter Kjellerstedt7 days1-3/+3
| | | | | | | | | | | | It is the libsoup-2.4 recipe that has been removed, not libsoup. Also add that it has been moved to meta-oe. (From yocto-docs rev: ac2896c89df7e5dfa91b18a5e1681019f17182d3) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-5.3.rst: Correct a typoPeter Kjellerstedt7 days1-1/+1
| | | | | | | | (From yocto-docs rev: a87be4bc3c518fe92c5fc849975fcd233fdc51db) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual: update runtime-testing Exporting Tests sectionBarne Carstensen7 days1-7/+12
| | | | | | | | | | | | | This has changed since commit ed4238487c81 ("testexport: Fix to work as an image class") in OE-Core. [Antonin Godard: mention oecore commit in commit body] (From yocto-docs rev: 2caa8e581feaf3640bea68108f9a02583b17b21b) Signed-off-by: Barne Carstensen <barne.carstensen@danfoss.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 5.0.12Lee Chee Yang2025-09-162-0/+185
| | | | | | | | (From yocto-docs rev: e77139b5c616e6e5ad436eb91416fd804389425f) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 5.2.3Lee Chee Yang2025-09-162-0/+356
| | | | | | | | (From yocto-docs rev: 3a73f28b3fffaa7abbb68dd164fa8615efbfece5) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides/migration-5.3.rst: add note on systemd pni-names changeAntonin Godard2025-09-161-0/+16
| | | | | | | | | | | | | | Add a migration note on the pni-names default policy change after commit 9b34a810496f ("systemd: stop enabling non-standard "mac" policy when using the 'pni-names' DISTRO_FEATURE") in OE-Core. Cc: Koen Kooi <koen.kooi@oss.qualcomm.com> Cc: Ross Burton <Ross.Burton@arm.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 237f28de0bf8d1e1be60a0d9429b3a98740778e9) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides/release-notes-5.3.rst: new wic option extra-partition-spacePierre-Loup GOSSE2025-09-161-0/+3
| | | | | | | | | | | | | | After commit c7f51c23fd268 ("wic: add --extra-partition-space option to set unused space") in openembedded-core, document the new Wic-specific option extra-partition-space. CC: Alexander Kanavin <alex.kanavin@gmail.com> (From yocto-docs rev: 20c6e107af0441772cf986547a7d8131ec244c8c) 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>
* migration-guides/migration-5.3.rst: wic option extra-space renamingPierre-Loup GOSSE2025-09-161-0/+2
| | | | | | | | | | | | | | | After commit 47533f20a7ec ("wic: rename wks flag --extra-space to --extra-filesystem-space") in openembedded-core, document the renaming of the Wic-specific option extra-space to extra-filesystem-space. CC: Alexander Kanavin <alex.kanavin@gmail.com> (From yocto-docs rev: d3a34e8dca3c774234d3c6f4e575858869a7460d) 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/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>
* migration-5.3.rst: update removed recipes listGyorgy Sarvari2025-09-161-0/+5
| | | | | | | | | | Add a note about the removed xf86-input-mouse and xf86-input-vmmouse recipes. (From yocto-docs rev: ee0b46bd074dd34c3d6b401e65d2c519c2c3d47b) 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/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>
* vulnerabilities: update nvdcve file namePeter Marko2025-09-161-1/+1
| | | | | | | | | | | | | | The filename is outdated as its version was already bumped and there are also different files for different feed choices. Use glob to match any available file. Also the directory changed to CVE_CHECK2 meanwhile, so Update it, too. (From yocto-docs rev: a2f18cb23183401d9d8e2fd4499d164ef8d86e44) Signed-off-by: Peter Marko <peter.marko@siemens.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 4.0.29Lee Chee Yang2025-09-162-0/+179
| | | | | | | | (From yocto-docs rev: d3bbfed9cad4cda0960ee0623c728ea2a18e1b29) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/security-subjects.rst: update mailing listsAntonin Godard2025-09-161-9/+14
| | | | | | | | | | | | Update mailing lists following changes by Michael Halstead (https://lists.yoctoproject.org/g/yocto-security/message/1478). Also fix formatting/spacing. (From yocto-docs rev: 8066aa92a1acae6c99fbee92d24ee1feea65d974) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides/release-notes-5.3.rst: add x86 qemu micro-arch level bumpAntonin Godard2025-09-161-0/+19
| | | | | | | | | | | | After commit c9585bb8689b ("Revert "qemux86-64: Reduce tuning to core2-64"") in OE-Core, document the QEMU x86 micro-architecture level bump in the release notes for 5.3. Co-authored-by: Alexander Kanavin <alex.kanavin@gmail.com> (From yocto-docs rev: 22c0fc1943c23d6f927034afdfa25ce64c5ba79a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk: The main in the C example should return an intJan Vermaete2025-09-161-1/+2
| | | | | | | | | | see C17 (ISO/IEC 9899:2018) (From yocto-docs rev: 1ebaed299f7ef80a49b68608f45bf25884900d13) Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml.in: increase required disk space to 140GAntonin Godard2025-08-081-3/+3
| | | | | | | | | | | | | | | Increase the minimum size requirement to 140G, after running a build with distro Poky. The size after rm_work has increase of only 1G, so leave the current value for MIN_DISK_SPACE_RM_WORK. Also, update the comment to mention that this is for distro Poky. It was mentioned in commit message 285ba689ce3a ("manuals: update disk space requirements"), but not in the comment here. (From yocto-docs rev: dbc6137cd13f982a7fd4d1b2df79dccb177db0fc) 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>
* Makefile: add a checks ruleAntonin Godard2025-08-081-2/+5
| | | | | | | | | | | | | | | | The checks rule can be run to perform some checks on the docs. For now it only includes running the check-glossaries script. This rule should only run basic checks or should not prevent the user from building the docs in case of failure. This rule can be used in the future to run additional checks on the documentation. (From yocto-docs rev: 1d9a4a52fa9f2e2eb7f282324f85a46b28128fbf) 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-082-0/+96
| | | | | | | | | | | | | | | | | | | | 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>
* migration-guides/release-notes-5.3: updatesAntonin Godard2025-08-082-5/+648
| | | | | | | | | | | | Update the release notes and migration manual for 5.3. This covers commits from c4a5e590b53b ("rust-llvm: Compile llvm to use dynamic libraries") to 2a832e6af1b6 ("orc: set CVE_PRODUCT") in Poky. (From yocto-docs rev: c8d852ad63219d067e497a77d489a4011b0d0a26) 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-085-11/+11
| | | | | | | | | | | | | 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-084-13/+13
| | | | | | | | | | | 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>
* ref-manual/classes.rst: document the go-mod-update-modules classAntonin Godard2025-08-081-0/+15
| | | | | | | | | | Added by commit 34bb889ffaae ("classes/go-mod-update-modules: add class to generate module list") in OE-Core. (From yocto-docs rev: b1a9848d2bba9e1392d153ff992304b83b259318) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document UBOOT_VERSIONAntonin Godard2025-08-081-0/+6
| | | | | | | | | | Added by commit debc691853e2 ("u-boot: Allow for customizing installed/deployed file names") in OE-Core. (From yocto-docs rev: a9a4bcc754b9400fa6d3c0297e86771f03325590) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document SPL_DTB_BINARYAntonin Godard2025-08-082-0/+8
| | | | | | | | | This variable is part of uboot-sign but not documented. (From yocto-docs rev: 05eb461cb1da76ad9cbaf634da7f47447b3f6765) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: add link for BB_DEFER_BBCLASSESAntonin Godard2025-08-081-0/+3
| | | | | | | | | | Added by commit 8e741b2e885a ("ast/BBHandler: Add support for BB_DEFER_BBCLASSES") in BitBake. (From yocto-docs rev: bf3c2ade55e4d90dd50f39d01405352cd48c1703) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the FIT_CONF_PREFIX variableAntonin Godard2025-08-081-0/+4
| | | | | | | | | | Added by commit 7892ee3dc37d ("kernel-fitimage: allow overriding FIT configuration prefix") in OE-Core, but never documented. (From yocto-docs rev: 860891492b96eb127af5e7bab6348fca12167c68) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Drop the icecc class and related variablesAntonin Godard2025-08-084-168/+9
| | | | | | | | | | | | | Dropped by commit ecf8c386cf83 ("classes/recipes-devtools: Drop icecc from OE-Core") in OE-Core. Remove documentation for the class and the related variables. Remove the references to this class. (From yocto-docs rev: 30c9413c5106bcbcc1600ef16b8d0cece86d8158) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document PSEUDO_INCLUDE_PATHSAntonin Godard2025-08-081-0/+7
| | | | | | | | | | Added by commit 2502da81709f ("bitbake.conf/pseudo: Switch from exclusion list to inclusion list") in OE-Core. (From yocto-docs rev: 5fc49ee007d22c7dc28c11ea579c804881b9cb8f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document TESTSDK_SUITESAntonin Godard2025-08-082-0/+9
| | | | | | | | | | The TESTSDK_SUITES variable can be used to control the list of test modules run with the testsdk class. (From yocto-docs rev: fbc6db0ab525c7e46774c01fc595f30d6d0fe3c1) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document KMETA_CONFIG_FEATURESAntonin Godard2025-08-081-0/+13
| | | | | | | | | | The KMETA_CONFIG_FEATURES variable defines kernel-yocto features to enable. (From yocto-docs rev: 1a9f68b875a78c1c7681ed300111399de97631e6) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document SPDX_PACKAGE_URLAntonin Godard2025-08-081-0/+6
| | | | | | | | | Used for SPDX3 software_packageUrl field. (From yocto-docs rev: 108549dae76a582bc98d3b7bd976e0239a6b92a6) 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-10-03 19:46:27 +0000