summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual/yocto-project-supported-features: Update to match current statusRichard Purdie3 days1-10/+13
| | | | | | | | A few items were in the wrong sections or needed clarification, tweak accordinly. (From yocto-docs rev: 85e58c4fc5d1be9a2ea9ed6b813d0168e3162dab) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add SPDX_INCLUDE_COMPILED_SOURCES documentationDaniel Turull3 days2-0/+25
| | | | | | | | | | | | | | | Adding documentation for the new feature to store in SPDX only the compiled sources. Merged in oe-core: c6a2f1fca76fae4c3ea471a0c63d0b453beea968 - spdx: add option to include only compiled sources CC: Antonin Godard <antonin.godard@bootlin.com> (From yocto-docs rev: 4dbc63ed1381fe47723d6ba5b7baf2a3b7fd19aa) Signed-off-by: Daniel Turull <daniel.turull@ericsson.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: update all of section 1.8.2 to reflect current beaglebone conf fileRobert P. J. Day3 days1-18/+9
| | | | | | | | (From yocto-docs rev: 5fc7794e9ae326eead16552726d74ea801fe535b) Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: update lonely "4.12" kernel reference to "6.12"Robert P. J. Day3 days1-1/+1
| | | | | | | | | | | To accompany earlier updating of kernel version, update this lonely reference to be consistent. (From yocto-docs rev: e26c2018cd663de91ee08e0cba55eda1a4c30210) Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* document how to use :doc: directiveQuentin Schulz3 days2-1/+20
| | | | | | | | | | | Let's specify that we are only expecting "absolute" paths in the docs directive for local document referencing. (From yocto-docs rev: 2729250bf1068814e5106d1e71796e8a505963d7) 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>
* tree-wide: make the :doc: directive use absolute pathsQuentin Schulz3 days14-24/+24
| | | | | | | | | | | | | | | | | | | This makes all :doc: directives use an absolute paths (with the root directory being documentation/ in the repo). This is then consistent across the whole source and is easier to review and move files around, you just need to know where a file is located relative to documentation/ directory and use that. This gets rid of paths looking in parent directory with '..' as well as expecting a file to be in the same directory as the other file it points to via the :doc: directive. (From yocto-docs rev: b9457f2005b0bea49c54e9727eb30e9458084886) 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>
* bsp guide: update kernel version example to 6.12Robert P. J. Day3 days1-8/+13
| | | | | | | | | | | | Change the sample kernel version being used from 4.4 to a more modern 6.12. (From yocto-docs rev: 1bad12b6ccfe1c0d26918926176a0c743568de26) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yp-intro: new doc reference is missing leading slashRobert P. J. Day3 days1-1/+1
| | | | | | | | | | | The new ":doc:" reference for yocto-project-supported-features appears to be missing a leading slash, causing HTML generation to fail. (From yocto-docs rev: 4114399711ff82893a10c9eba0ff66c9af7b1c9e) Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guide: add release notes for 5.0.10Lee Chee Yang3 days2-0/+209
| | | | | | | | (From yocto-docs rev: 5bc4c98987ff809294541657b20d2e44f70e1d2c) 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>
* overview-manual: small number of pedantic cleanupsRobert P. J. Day3 days1-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: 1cf769e3c8a8442cd05449dc97e91ad482d635f3) Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-5.3: replace kernel-fitimage by kernel-fit-imageAdrian Freihofer3 days1-0/+42
| | | | | | | | | | | Add migration documentation for users moving from the removed kernel-fitimage.bbclass to the new kernel-fit-image.bbclass. (From yocto-docs rev: 4c3552940a6ff89824845473317b7f5d741d4635) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes: drop references to kernel-fitimageAdrian Freihofer3 days2-3/+3
| | | | | | | | | | | This commit drops references to the kernel-fitimage.bbclass to prevent from build errors when the label is no longer available. (From yocto-docs rev: 3610cfd76d1491d9ecff9816ab36df8d1b2a83c6) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: replace kernel-fitimage by kernel-fit-imageAdrian Freihofer3 days2-100/+179
| | | | | | | | (From yocto-docs rev: 93c92dd2837708ba00a4ca47667e60d7bb09430b) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes: nativesdk: move note to appropriate sectionQuentin Schulz3 days1-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: 15fe239e1e62b9add737aa732dd7f5e9948ee03d) 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: classes: reword to clarify that native/nativesdk options are ↵Quentin Schulz3 days1-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: 6d0d338a5f2686ddeee5eed7b6e05f3db800d33a) 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/yocto-project-supported-features: move meta-exein to primaryAntonin Godard6 days1-4/+4
| | | | | | | | | | Exein is a platinum member and has primary support (https://www.yoctoproject.org/members). (From yocto-docs rev: b13bccbf3fb1890ac428a396f8c5081057edf555) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual/yp-intro.rst: add RISC-V to supported archsAntonin Godard6 days1-4/+6
| | | | | | | | | | And mention the new supported features document. Suggested-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: d852a2d20e876440a48a240ca68d5f440ef2cfbe) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/yocto-project-supported-features: add a contact for meta-armRoss Burton6 days1-1/+1
| | | | | | | | | | Set the contact address for meta-arm. (From yocto-docs rev: 8ad91366ed89204affef6a72bd403b0d0a4525fa) Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add a document to list supported Yocto featuresAntonin Godard7 days2-0/+264
| | | | | | | | | | | | | | | | Add a "Yocto Project Supported Architectures And Features" document that aims at: - Defining the different levels of support for features - Listing the maintainers for a feature - Listing the existing builders on the Autobuilder for the feature Co-developed-by: Richard Purdie <richard.purdie@linuxfoundation.org> Cc: Yocto TSC <tsc@lists.yoctoproject.org> (From yocto-docs rev: 197f28439c44e3fb7507f97be57a0c94be4a8eed) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: remove lz4 from required packagesQuentin Schulz2025-06-064-4/+4
| | | | | | | | | | | | Since commit b13654a4fc2f ("bitbake.conf: Drop lz4 from HOSTTOOLS") in OE-Core, lz4 isn't an expected host dependency anymore so let's drop it from the list of required packages. (From yocto-docs rev: 040556cc9bc998970eb6152f8748d359b15b4bf9) 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>
* docs: conf.py: silence SyntaxWarning on js_splitter_codeQuentin Schulz2025-06-061-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: c1056672ef45b197136eb8815728d426337a5901) 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>
* docs: README: specify how to contribute instead of pointing at another fileQuentin Schulz2025-06-061-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: 0298318cea2947e65754eab97255164e64a862de) 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>
* migration-guides: add release notes for 4.0.27Lee Chee Yang2025-06-062-0/+154
| | | | | | | | (From yocto-docs rev: 612f8c6f99297c1c3a7347be93fe713dccabeffb) 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.1Lee Chee Yang2025-06-062-0/+162
| | | | | | | | (From yocto-docs rev: 0624495c4584fafffaedcdef21d65686043f45b0) 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>
* ref-manual: clarify KCONFIG_MODE default behaviourCarlos Sánchez de La Lama2025-06-061-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: f374b9c426f6c10710e011a4ad660231ee26efb8) Signed-off-by: Carlos Sánchez de La Lama <csanchezdll@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Clean up explanation of minimum required version numbersRobert P. J. Day2025-06-061-2/+2
| | | | | | | | | | | Some simple rendering and grammar fixes. (From yocto-docs rev: 9a9624bfc4c523a6edf6f3f0c336e663cc939e75) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs/ref-manual: Switch to new CDNRichard Purdie2025-05-292-2/+2
| | | | | | | | | The project is switching the way handle our CDN provision of sstate objects, update the URL accordingly. (From yocto-docs rev: 406e8a8e30404c0538f5aa46f211540bae2b206b) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: uboot-sign: Support firmware property in FIT configJamin Lin2025-05-262-0/+11
| | | | | | | | | | | | | Add documentation for the UBOOT_FIT_CONF_FIRMWARE variable, which allows users to specify an image to be assigned to the "firmware" property of the FIT configuration node. This explicitly defines the primary image to boot, instead of relying on the first entry in the "loadables" list. (From yocto-docs rev: f72fc69e2d2a074d5eaf1cc36b30726de58e3ab5) Signed-off-by: Jamin Lin <jamin_lin@aspeedtech.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs/index.rst: replace removed macroAntonin Godard2025-05-261-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: 1316bd95f4c4107549de34b78bca0499233497e8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx-lint: unbalanced inline literal markupTrevor Woerner2025-05-2616-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: 3460177c46d360b0f2f852cdab23f21bd4ec6d5a) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx-lint: superfluous backtick in front of roleTrevor Woerner2025-05-261-2/+2
| | | | | | | | | | Fix all instances of backtick-before-role as reported by 'make sphinx-lint'. (From yocto-docs rev: d38f9b25c0bd095fe1158f14226fb74f8645496a) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document INHIBIT_UPDATERCD_BBCLASSAlper Ak2025-05-261-0/+19
| | | | | | | | | | Fix [YOCTO #15753] (From yocto-docs rev: 5f5a406d4acdfcbf655ac014d0d2807056f95291) Signed-off-by: Alper Ak <alperyasinak1@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document SSTATE_SKIP_CREATIONEtienne Cordonnier2025-05-261-0/+20
| | | | | | | | (From yocto-docs rev: 3982720668aafa18c9ed27304d09f896740b1653) Signed-off-by: Etienne Cordonnier <ecordonnier@snap.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document INHIBIT_DEFAULT_RUST_DEPSAlper Ak2025-05-261-0/+17
| | | | | | | | | | Fix [YOCTO #15755] (From yocto-docs rev: fd143a04bab38f6aeec23ec229657b16fcaecdf1) Signed-off-by: Alper Ak <alperyasinak1@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* conf.py: tweak SearchEnglish to be hyphen-friendlyEnrico Jörns2025-05-261-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: d4a98ee19e0cbd6be96923dc72faee143a6b294b) Signed-off-by: Enrico Jörns <ejo@pengutronix.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variableChristos Gavros2025-05-261-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: 07bcdddaf71c76cdec186cf0ddd97a47eec54972) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the IMAGE_ROOTFS_MAXSIZE variableChristos Gavros2025-05-261-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: f3ddc92081363aa7ef7d4fc2c3b918f32f7bda05) Signed-off-by: Christos Gavros <gavrosc@yahoo.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document INHIBIT_AUTOTOOLS_DEPSAlper Ak2025-05-261-0/+18
| | | | | | | | | | | Fix [YOCTO #15756] (From yocto-docs rev: 18a2686b530ae428103653450d8963d38dcdef46) Signed-off-by: Alper Ak <alperyasinak1@gmail.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>
* set_versions.py: mark Styhead as EoLQuentin Schulz2025-05-191-1/+1
| | | | | | | | | | Styhead is now EoL, let's remove it from the active releases. (From yocto-docs rev: f2e3cf2637ce3ed3475faa472b134a29f019681b) 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/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: f1cdecb6da91dbfac59359c83038cb4a4c36ad0a) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: 6d4c67457e00a80dda4cd05bc5f05d8ebd8da5fc) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: bcd58b7a9455fbb0ea5944089d663e327f0eb38f) Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: 2e3a37c4607b296956993e557d1786c4876e5722) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 5.0.9Lee Chee Yang2025-05-192-0/+207
| | | | | | | | (From yocto-docs rev: 0d070439259d72f66a71c148f6c7926f6f233b6d) 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>
* 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: 50e92009d309fc4ae406174feb8f6578142748cc) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: 8ceffee908a039deb1021361faa7637e83ef26f3) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add placeholders for 5.3Antonin Godard2025-05-194-0/+204
| | | | | | | | | | | Add placeholder files to be populated for the next 5.3 release. Relevant section names from the previous 5.2 release migration guide/release note have been left with their content empty. (From yocto-docs rev: 2822bf71ee7cd2fa48f2f802eaab236538112d85) 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.26Lee Chee Yang2025-05-192-0/+264
| | | | | | | | (From yocto-docs rev: c883b519ea7163b2c69d749ff4912e89528964b4) 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>
* 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: 6d471e8483cc8d797eff7916120f91fab44487d1) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: 270cd833f7d680c6def21376c7ece488479023ed) Signed-off-by: Leonard Anderweit <l.anderweit@phytec.de> 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-06-23 03:08:44 +0000