summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual/start.rst: remove shared PERSISTENT_DIR mentionsAntonin Godard5 days1-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 Godard5 days1-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örns5 days1-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 Godard5 days1-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 Godard5 days1-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 Godard5 days1-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 Godard5 days1-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 Godard5 days1-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 Godard5 days1-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 Yang5 days2-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>
* conf.py: tweak SearchEnglish to be hyphen-friendlyEnrico Jörns2025-06-021-0/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This modifies the default indexer split() and js splitQuery() methods to support searching for words with hyphens. While this might not be an ideal, rock solid, and fully future-proof solution, it allows at least to search for strings inlcuding hyphens, such as 'bitbake-layers', 'send-error-report', or 'oe-core'. Below is a bit more detailed explanation of the two modifications done: 1) The default split regex in the sphinx-doc SearchLanguage base class is: | _word_re = re.compile(r'\w+') which we simply extend to include hyphens '-'. This will result in a searchindex.js that contains words with hyphens, too. 2) The 'searchtool.js' code notes for its splitQuery() implementation: | /** | * Default splitQuery function. Can be overridden in ``sphinx.search`` with a | * custom function per language. | * | * The regular expression works by splitting the string on consecutive characters | * that are not Unicode letters, numbers, underscores, or emoji characters. | * This is the same as ``\W+`` in Python, preserving the surrogate pair area. | */ | if (typeof splitQuery === "undefined") { | var splitQuery = (query) => query | .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) | .filter(term => term) // remove remaining empty strings | } The hook for this is documented in the sphinx-docs 'SearchLanguage' base class. | .. attribute:: js_splitter_code | | Return splitter function of JavaScript version. The function should be | named as ``splitQuery``. And it should take a string and return list of | strings. | | .. versionadded:: 3.0 We use this to define a simplified splitQuery() function with a split argument that splits on empty spaces only. We extend SearchEnglish (which extends SearchLanguage) here to retain the stemmer code and stopwords for English. [YOCTO #14534] (From yocto-docs rev: 15c2965bdb0040e5745022c8098f434cd1a156e9) Signed-off-by: Enrico Jörns <ejo@pengutronix.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit d4a98ee19e0cbd6be96923dc72faee143a6b294b) 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-06-021-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: 33dd2be43418bfdb61b73abc82e9aa8bdc331e70) 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-06-021-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: 7b3996064f539474d2204da7a8bb9ff531cf8b0c) 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>
* 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: 6b7019c13054bf11fb16657a3fac85831352cea9) 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>
* sphinx-lint: various fixesTrevor Woerner2025-05-195-8/+8
| | | | | | | | | | | | | | | | | A 'make sphinx-lint' pass found the following issues: trailing-whitespace missing-space-after-literal role-with-double-backticks missing-space-before-role (role missing opening tag colon) (From yocto-docs rev: 9f4fab1727bcf010cd3631ce5ae769797b9fba99) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1020d82aff4dab5b3d64e7035e87763a80cf5b70) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* sbom.rst: how to disable SPDX generationMikko Rapeli2025-05-191-3/+11
| | | | | | | | | | | | | | Generating SPDX is enabled by default in poky but it can take a lot of build time resources so document how to disable it. (From yocto-docs rev: d26a3f2ed8f24e1b72f58ecb8b7cdba7007ba77b) Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit bcd58b7a9455fbb0ea5944089d663e327f0eb38f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide/submit-changes: encourage patch version changelogsTrevor Woerner2025-05-191-0/+32
| | | | | | | | | | | | | | Add a section after the 'git format-patch' information encouraging developers to add patch version changelogs to their patch updates. (From yocto-docs rev: dff4d470193c1b5c961f4725b796050fb79b2b5c) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 2e3a37c4607b296956993e557d1786c4876e5722) 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.9Lee Chee Yang2025-05-192-0/+207
| | | | | | | | | | (From yocto-docs rev: f27d37d4b657dd5a0c93a5749ba7b288f5303f5c) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 0d070439259d72f66a71c148f6c7926f6f233b6d) 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: 84c55a224f16644a42e51294a6ad0b2568f84ea2) 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: 4a836be25193aeff2b03bd5b49959d41d7752dfa) 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>
* migration-guides: add release notes for 4.0.26Lee Chee Yang2025-05-192-0/+264
| | | | | | | | | | (From yocto-docs rev: 73ace7506bb27ebd6c9c2d16bdfe465a871d6a24) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 656dc03101705bba718517b7017f71ce00541b72) 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: 63d00925b77a723750ee1126a1242e332d052689) 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>
* ref-manual: classes: uki: Fix git linksLeonard Anderweit2025-05-191-4/+4
| | | | | | | | | | | | Fix links to files in git by adding a leading / to the path. (From yocto-docs rev: 20447dbf40b07f6b7493dee0b4c4082376d96796) Signed-off-by: Leonard Anderweit <l.anderweit@phytec.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit cc5daf15f5999bc217f8729e259ae720736beaaa) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* test-manual/intro: remove Buildbot version usedAntonin Godard2025-05-191-7/+5
| | | | | | | | | | | | | | The version has changed now (3.10.12 as of writing). Avoid having to maintain this information by removing the version info from the intro. Also fix a typo ("uses now uses") and give a link to yocto-autobuilder2. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: cdfa58f08ab98b233c466501e1a3567b869d312b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1ed64dbdf4a60b000305cdc2c67dc24f4bc97ef7) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides/release-notes-5.2.rst: add missing cvesyocto-5.2walnascar-5.2Antonin Godard2025-04-231-8/+16
| | | | | | | | | | | | | | | | | | | | | Add missing fixed CVEs to the release note as reported here: https://lore.kernel.org/r/5fc0d33e-4ba5-4f8d-80c2-c5c87be79680@gmail.com Additions can be verified at the following links: - https://gstreamer.freedesktop.org/security/ - https://www.openssh.com/txt/release-9.9p2 - http://www.dest-unreach.org/socat/ libssh2 CVE-2023-48795 was already fixed in previous releases so remove it. See the previous migration guides. Otherwise the CVE entries have been sorted. Reported-by: Takayasu Ito <ypa.takayasu.ito@gmail.com> (From yocto-docs rev: b8d9cf79d299b2e553e6bc962527d835206022ec) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides/release-notes-5.2.rst: fix badly formatted gstreamer entriesAntonin Godard2025-04-231-18/+18
| | | | | | | | Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 22babeaa9ef4c0e6706c6de8f16fbd0e8d505818) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides/{migration,release-notes}-5.2.rst: notes for systemd pni-namesAntonin Godard2025-04-232-3/+11
| | | | | | | | | | | Add a note to the migration guide regarding the pni-names behavior change. Suggested-by: Enrico Jörns <ejo@pengutronix.de> (From yocto-docs rev: 9a1b9778c296351a575501a4abc5317e9be954bc) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Fix dead links that use the DISTRO macroAntonin Godard2025-04-219-12/+12
| | | | | | | | | | | | | | | | | | 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: 29be069ebbf2c55d72fc51d99ed5a558af37c05e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: introduce DISTRO_LATEST_TAGAntonin Godard2025-04-212-2/+25
| | | | | | | | | | | | | | | | | | | | | | | Introduce the DISTRO_LATEST_TAG macro, which should always point to the latest existing tag in the documentation, unlike DISTRO which may point to A.B.999 to represent the tip of a branch. This variable is needed to fix dead links in the documentation that currently use the DISTRO macro. Also, make DISTRO_REL_TAG use the DISTRO macro directly, to avoid repetition, and add a DISTRO_REL_LATEST_TAG macro that has the same role as DISTRO_LATEST_TAG but with "yocto-" prepended to it. In set_versions.py, run the "git describe --abbrev=0 --tags --match='yocto-*'" command to get the latest existing tag on the currently checked out commit. Fallback to ourversion in case we didn't find any. (From yocto-docs rev: a85b0e500c94921f77fa7b7dbb877e4945f96d1e) 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-07-22 23:32:43 +0000