summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* migration-guides: add release notes for 5.0.12Lee Chee Yang2025-09-172-0/+185
| | | | | | | | | | (From yocto-docs rev: 29330751c8a2b82b4bd80659d2a0a8bac51afca5) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit e77139b5c616e6e5ad436eb91416fd804389425f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides: add release notes for 5.2.3Lee Chee Yang2025-09-172-0/+356
| | | | | | | | | | (From yocto-docs rev: 46b642658ce3fcf9402a1330c308e42f988ddd7e) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 3a73f28b3fffaa7abbb68dd164fa8615efbfece5) 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: 987929b349a927d6b243d351aebebfd160d1b097) 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>
* dev-manual/security-subjects.rst: update mailing listsAntonin Godard2025-09-171-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: cad5770b123a2e763b4026e4c6a5991286ba7fa0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 8066aa92a1acae6c99fbee92d24ee1feea65d974) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* sdk: The main in the C example should return an intJan Vermaete2025-09-171-1/+2
| | | | | | | | | | | | see C17 (ISO/IEC 9899:2018) (From yocto-docs rev: 9b7a4b503f6d0f2cd8b209ba9348a067a3846260) Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1ebaed299f7ef80a49b68608f45bf25884900d13) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* vulnerabilities: update nvdcve file namePeter Marko2025-09-171-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: 1b4d559ad5489a34cec26f9aad2687d2cb3ecc0a) Signed-off-by: Peter Marko <peter.marko@siemens.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a2f18cb23183401d9d8e2fd4499d164ef8d86e44) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides: add release notes for 4.0.29Lee Chee Yang2025-09-172-0/+179
| | | | | | | | | | (From yocto-docs rev: eca0629b779c2b96c812b68c42b83ed3589a6d87) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit d3bbfed9cad4cda0960ee0623c728ea2a18e1b29) 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-131-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: e664a70adb5bc19041b3b5f553fb90dcddff99d0) 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-132-0/+8
| | | | | | | | | | | This variable is part of uboot-sign but not documented. (From yocto-docs rev: ce4a0ec193301ed5373bab02938355ba222d2804) 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-131-0/+4
| | | | | | | | | | | | Added by commit 7892ee3dc37d ("kernel-fitimage: allow overriding FIT configuration prefix") in OE-Core, but never documented. (From yocto-docs rev: 1b6a3610d5d24580de34b7821413b0f1ea52b508) 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>
* overview-manual/yp-intro.rst: fix broken link to articleErik Lindsten2025-08-131-1/+1
| | | | | | | | | | (From yocto-docs rev: 2255bff51dc38897243fe48b28fa9773fb6a4e6d) Signed-off-by: Erik Lindsten <erik@awto.se> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit b9680ad83ad3fc5e2b87594f7c62c057134d198b) 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-131-27/+27
| | | | | | | | | | | | | | | | 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: 378bceec8f5a57d4961df178c141f627e48f0235) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/classes.rst: drop obsolete QA errorsAntonin Godard2025-08-042-14/+1
| | | | | | | | | | | | Drop after commit 068d38214307 ("insane: remove obsolete QA errors") from OE-Core. (From yocto-docs rev: 698253a6c95beb1219b7fed8a90d02fb6ddc5111) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit e5667ae2da1805327ecfff68300c0c460da49b91) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/classes.rst: insane: drop cve_status_not_in_dbAntonin Godard2025-08-041-5/+0
| | | | | | | | | | | | This was dropped by commit 452e605b55ad ("cve-check: annotate CVEs during analysis"). (From yocto-docs rev: 4c94ef90e01b6aa7e7eaae8776135b615d0d6069) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 55aedec94dce3e3c0541ffaea666cff02d63a708) 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: d62599595f68b75e5bf885367ca1f01a6d63bb3d) 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>
* dev-manual/start.rst: added missing command in Optimize your VHDX file using ↵Marco Cavallini2025-08-041-0/+1
| | | | | | | | | | | | | | | | | | | | | DiskPart After compact vsdisk you have to detach it before exiting otherwise the vdisk remains attached. DISKPART> select vdisk file="<path_to_VHDX_file>" DISKPART> attach vdisk readonly DISKPART> compact vdisk DISKPART> detach <------------ new missing command DISKPART> exit (From yocto-docs rev: 141eca08167d7e61a87dbe6e516e7f445d6bb417) Signed-off-by: Marco Cavallini <m.cavallini@koansoftware.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1cc65ddf1a074f61fe5a63d222f3079b7fcb4c1e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides: add release notes for 5.0.11Lee Chee Yang2025-08-042-0/+220
| | | | | | | | | | (From yocto-docs rev: 8343e69a59966a16b4351966ec44652e89bdb3e3) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit b5f6113cd95107132aac74b8f0e6e4895b7b0e90) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides: add release notes for 5.2.2Lee Chee Yang2025-08-042-0/+251
| | | | | | | | | | (From yocto-docs rev: 7b99a4c8339b78437c9bd2af316fed1c4ee4ef94) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit b1a19a8864ad248b712a6f2485320269b461005b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual/start.rst: remove basic setup for hash equivalenceAntonin Godard2025-08-041-6/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Quoting Alexander Kanavin [1]: > 1. BB_HASHSERVE and BB_SIGNATURE_HANDLER do not set up or start a > server, they set up the hash equivalence client built into bitbake. > > 2. The above client configuration (used by poky) also starts a private > server that is specific to a particular build directory. So hash equiv > information would not be shared between multiple build directories, > and this will cause sstate mismatches (as reported in the bug), if > sstate is shared. This setup does not shed light on the potential of the hash equivalence feature. So for now, remove this basic setup, and later rework the concepts (or create a new) document that explains how to set up a hash equivalence server shared between builds. [1]: https://lore.kernel.org/r/CANNYZj_kvLsZG3sgH+nPu9B=pqWBU785w0SGHGdQqB4UW-DtmA@mail.gmail.com Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> (From yocto-docs rev: 71c8b839e2621a048361d5518104099fee0f9e52) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 231fc9e710ab34db60263f8ae01d4f5970579203) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual/start.rst: remove shared PERSISTENT_DIR mentionsAntonin Godard2025-07-171-4/+10
| | | | | | | | | | | | | | | Remove the shared PERSISTENT_DIR mention introduced by 3954eda78f22 ("dev-manual/start.rst: mention that PERSISTENT_DIR should be shared too"), as it should _not_ be shared. Instead recommend setting up a hash equivalence server. (From yocto-docs rev: 98e71db7177257b340f5841bb9d7f8d83296c546) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit f9f1c87424d307d2df60024bc448bd6778605cf8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/structure.rst: remove shared PERSISTENT_DIR mentionsAntonin Godard2025-07-171-11/+0
| | | | | | | | | | | | | PERSISTENT_DIR should _not_ be shared, I got that wrong in my previous commit 741aa29898dc ("ref-manual/structure.rst: update with info on PERSISTENT_DIR"). Remove these mentions. (From yocto-docs rev: 9b04faeacad63ada93af3e31fa66fbfe387aa53a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 4c7fc7a6e9b0b957bcf0deb66adb0a6d9ebead00) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* conf.py: improve SearchEnglish to handle terms with dotsEnrico Jörns2025-07-171-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | While search queries already handled words with hyphens correctly, they did not do so for words with dots. To fix this, we - enhance the word tokenizer to treat both dots ('.') and hyphens ('-') as valid characters within words. (For robustness, explicitly exclude dots/hyphens at the start or end of a word from indexing.) - adjust query processing to avoid splitting on dots in search input This allows search queries to correctly match terms such as 'local.conf', 'site.conf', and similar ones now. Fixes: [YOCTO #14534] (From yocto-docs rev: 462059ebbf25ed362a5ace1987f0684444441a7f) Signed-off-by: Enrico Jörns <ejo@pengutronix.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 80084a4cabdf7f61c7e93eda8ddbd5bc7d54e041) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* overview-manual/concepts.rst: fix sayhello hardcoded bindirAntonin Godard2025-07-171-2/+2
| | | | | | | | | | | | Replace the hardcoded /usr/bin by ${bindir}, as it should be. Reported-by: Thomas Perrot <thomas.perrot@bootlin.com> (From yocto-docs rev: c5c8d7f1604e8a52f8f7fd4fe445db7b3cb02778) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 576677eae6960dbc2d2ececeba0fde5bba7bb69f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* overview-manual/concepts.rst: mention PERSISTENT_DIR for user configurationAntonin Godard2025-07-171-0/+3
| | | | | | | | | | | | The PERSISTENT_DIR directory can also be customized to be shared, so mention it in the list of configuration variables in local.conf. (From yocto-docs rev: 89adf577754244c8304ae4fa2d3c7f5f2fe00ecc) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit f3aa0e8f0d15f036b65253c1e0036eb7e1e16088) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual/start.rst: mention that PERSISTENT_DIR should be shared tooAntonin Godard2025-07-171-0/+5
| | | | | | | | | | | | | | | | | In the "Development environment summary", we mention that the shared state dir can be shared for developers, but PERSISTENT_DIR should be shared as well, otherwise bugs described in [1] can happen. [1]: https://bugzilla.yoctoproject.org/show_bug.cgi?id=15921 [YOCTO #15921] (From yocto-docs rev: 60a08db99a0562a7ff0856da2287d5339d37d239) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 3954eda78f22f205cbd31857f5b0992900fe7b02) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/structure.rst: update with info on PERSISTENT_DIRAntonin Godard2025-07-171-1/+13
| | | | | | | | | | | | | | Since we mention that SSTATE_DIR can be shared for multiple builds, also mention that PERSISTENT_DIR should be shared alongside SSTATE_DIR. [YOCTO #15921] (From yocto-docs rev: b2774467ed327baeddcc9161fe7ffee797f9158d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 741aa29898dc7f34ebd423ff7565334b2c89e18c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* test-manual/understand-autobuilder.rst: mention hashequiv serverAntonin Godard2025-07-171-0/+6
| | | | | | | | | | | | The autobuilder also uses a shared Hash Equivalence server, so mention it here too. (From yocto-docs rev: 32655d051eddbec6ab154609ace25b86975818bf) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a96640f98c91f147e05cf132efab114b1e7dc8eb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* poky.yaml.in: increase minimum RAM from 8 to 32Antonin Godard2025-07-171-1/+1
| | | | | | | | | | | | In the light of the recent LLVM addition, and other such heavier recipes, increase the minimum RAM requirement from 8Gb to 32Gb. (From yocto-docs rev: 459d461f1edebd65319e8b13386ab81b1bfcaeb0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 3055affc8a37a40d03206140e47caf3d1437ec35) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides: add release notes for 4.0.28Lee Chee Yang2025-07-172-0/+225
| | | | | | | | | | (From yocto-docs rev: 0c68697d49eaf19e733cb1712fd84eb8de022130) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6959193fddb039c34384fcc391195fdd7fd3dbb8) 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-041-0/+21
| | | | | | | | | | | | | | This variable controls the kernel module spliting. [YOCTO #15771] (From yocto-docs rev: 85f8e5c799ef38c6dcca615d7cc6baff325df259) 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>
* bsp-guide: update all of section 1.8.2 to reflect current beaglebone conf fileRobert P. J. Day2025-06-201-18/+9
| | | | | | | | | | (From yocto-docs rev: 0627cfafb9c191763855f5d31c09e88dc5495a87) Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 5fc7794e9ae326eead16552726d74ea801fe535b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* bsp-guide: update lonely "4.12" kernel reference to "6.12"Robert P. J. Day2025-06-201-1/+1
| | | | | | | | | | | | | To accompany earlier updating of kernel version, update this lonely reference to be consistent. (From yocto-docs rev: 87c97308cac2a1e94ad1f006c1226a9072200a5f) Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit e26c2018cd663de91ee08e0cba55eda1a4c30210) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* bsp guide: update kernel version example to 6.12Robert P. J. Day2025-06-201-8/+13
| | | | | | | | | | | | | | Change the sample kernel version being used from 4.4 to a more modern 6.12. (From yocto-docs rev: 1aaf4044ca3610740a38cd6a53dd11f2071f573b) Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1bad12b6ccfe1c0d26918926176a0c743568de26) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* overview-manual: small number of pedantic cleanupsRobert P. J. Day2025-06-201-13/+12
| | | | | | | | | | | | | | | | | | In Sections 4.3.1 and 4.3.2 of the Overview Manual, a bit of tidying including: - provide full list of packaging options - add monospaced rendering where appropriate - fix broken "ref" - make capitalization consistent (From yocto-docs rev: 4b79feb4dfdce35efff05f4316f56445d18e5247) Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1cf769e3c8a8442cd05449dc97e91ad482d635f3) 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: 4852b8be918be0d0e73d82fff458822100e2f49b) 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: 69ce7f06d3a736c3d8c7a1fffbdee16d14e2dcdf) 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>
* migration-guide: add release notes for 5.0.10Lee Chee Yang2025-06-202-0/+209
| | | | | | | | | | (From yocto-docs rev: 1a28231a78be428bc7adfd6d233b6ebb0cb1d4d4) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 5bc4c98987ff809294541657b20d2e44f70e1d2c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* docs: conf.py: silence SyntaxWarning on js_splitter_codeQuentin Schulz2025-06-131-1/+1
| | | | | | | | | | | | | | | | | | | | | The js_splitter_code string contains backslashes that Python tries to use as escape sequence but doesn't manage to, hence the following SyntaxWarning message: documentation/conf.py:188: SyntaxWarning: invalid escape sequence '\p' .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}-]+/gu) Considering that we want this to be sent verbatim to the JS, let's make this a raw string instead. Fixes: d4a98ee19e0c ("conf.py: tweak SearchEnglish to be hyphen-friendly") (From yocto-docs rev: 1fc92ff2af72118ae041183d395d0a0323ecc1a9) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit c1056672ef45b197136eb8815728d426337a5901) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* docs: README: specify how to contribute instead of pointing at another fileQuentin Schulz2025-06-131-2/+19
| | | | | | | | | | | | | | | | | | | This repository is partially included in another repository: poky. However its README isn't making it, so documentation/README pointing at the README at the root of the git repository would lead the contributor nowhere. Instead, let's include the appropriate information directly in documentation/README which does make it to the poky git repo. (From yocto-docs rev: 1b93a4122624b554243842822e7df209cc884b27) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 0298318cea2947e65754eab97255164e64a862de) 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-131-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: 77e401de547a67d1654480c3fb8df3693724a69f) 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>
* Clean up explanation of minimum required version numbersRobert P. J. Day2025-06-131-2/+2
| | | | | | | | | | | | | Some simple rendering and grammar fixes. (From yocto-docs rev: 9c6845efa9d69ff077fa470abe5aed8f1fc1ec61) Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 9a9624bfc4c523a6edf6f3f0c336e663cc939e75) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides: add release notes for 4.0.27Lee Chee Yang2025-06-132-0/+154
| | | | | | | | | | (From yocto-docs rev: dde9441de7c253fabc0927c7f56f15b1e1c1405c) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit c4748f5079e5193f82afc1b754816edd40ce9254) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides: add release notes for 5.2.1Lee Chee Yang2025-06-132-0/+162
| | | | | | | | | | (From yocto-docs rev: adc155685283f9ed11cb5e6cfd4424b35d5503f7) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit d0b702fa010a7c1141cc70ac7e6494cd5d60014a) 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-132-2/+2
| | | | | | | | | | | | | | 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: 6372e5c9ed5dc6fd3f93e1059a56a002ff1b5036) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* brief-yoctoprojectqs/index.rst: replace removed macroAntonin Godard2025-06-021-2/+3
| | | | | | | | | | | | | | The UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL macro was removed after 8d993022c2ae ("docs: use literalinclude for system requirements"). Replace by the literalinclude like in the reference manual. Reported-by: "Robert P. J. Day" <rpjday@crashcourse.ca> (From yocto-docs rev: 953c203cff5f936b34530c150343cf54ade16653) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1316bd95f4c4107549de34b78bca0499233497e8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* sphinx-lint: unbalanced inline literal markupTrevor Woerner2025-06-0216-29/+29
| | | | | | | | | | | | | | | | | | 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 a heading which contain literals enclosed in double-back-tics; especially in the cases where a heading either contains multiple literals or when the literal is not at the end of the heading. Not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 73f4a3e3efce8c4e43939e5053f128faae5b41b1) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 3460177c46d360b0f2f852cdab23f21bd4ec6d5a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* sphinx-lint: superfluous backtick in front of roleTrevor Woerner2025-06-021-2/+2
| | | | | | | | | | | | Fix all instances of backtick-before-role as reported by 'make sphinx-lint'. (From yocto-docs rev: 758e46b10926ca0ce8db59c9c5cd9c4ed6c8826e) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit d38f9b25c0bd095fe1158f14226fb74f8645496a) 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-06-021-0/+19
| | | | | | | | | | | | Fix [YOCTO #15753] (From yocto-docs rev: c808e7a080533d4b4deef318fb36a786ede4fb50) 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-06-021-0/+20
| | | | | | | | | | (From yocto-docs rev: b3720565e7df427eef78520173e11047a73aec76) 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-06-021-0/+17
| | | | | | | | | | | | Fix [YOCTO #15755] (From yocto-docs rev: fe915d6947b0835c481359f62c8b57721568644c) 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2026-01-24 01:39:53 +0000