summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* migration-guide: add release notes for 5.0.10Lee Chee Yang2025-06-202-0/+209
| | | | | | | | | | (From yocto-docs rev: 32344c65b167cc19431902eba628bb321690a166) 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-111-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: 6f424ed4ce749a135be3145a2e9d04030fdbda39) 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-111-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: 01f1595d87dfb759071198d64c9a62fb00a48545) 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-111-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: c9bceea147c807b942ce6bcf085a31d9388ecc79) 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-111-2/+2
| | | | | | | | | | | | | Some simple rendering and grammar fixes. (From yocto-docs rev: 649a440c4f4ed9f2020622c10603489e7b9b27b6) 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-112-0/+154
| | | | | | | | | | (From yocto-docs rev: 223504ea6dca3fde55b14d95832bc3935229225c) 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>
* brief-yoctoprojectqs/ref-manual: Switch to new CDNRichard Purdie2025-06-112-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: bede97cfde51823e262e300aa346902d23530490) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Steve Sakoman <steve@sakoman.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> 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-05-271-0/+19
| | | | | | | | | | | | Fix [YOCTO #15753] (From yocto-docs rev: 3996388e337377bedc113d072a51fe9d68dd40c6) 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-05-271-0/+20
| | | | | | | | | | (From yocto-docs rev: 40045299491087d3f7d269b696ae48d513dae435) 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-05-271-0/+17
| | | | | | | | | | | | Fix [YOCTO #15755] (From yocto-docs rev: 2eb345ffa74d58d209a6a8deb27b228c37628034) 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-05-271-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: ce18901b1059746069a0dea8893ba4a357772b51) 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-05-271-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: 123d1ec8e532751ac416c21e3eaa92fd904e2171) 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-05-271-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: d45174d03e1ccd422b9210e3ba1f648d2f6b5173) 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>
* sphinx-lint: unbalanced inline literal markupTrevor Woerner2025-05-2715-28/+28
| | | | | | | | | | | | | | 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 heading which contain literals enclosed in double-back-tics, and not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 0ba5429953dfa0cdc983ed13ddd06351116031c7) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* sphinx-lint: missing space after literalTrevor Woerner2025-05-271-1/+1
| | | | | | | | | | | Fix all instances of missing-space-after-literal as reported by 'make sphinx-lint'. (From yocto-docs rev: b562ea5563adc744703b10e0c9a530ed7476d51a) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* sphinx-lint: trailing whitespaceTrevor Woerner2025-05-271-1/+1
| | | | | | | | | | Fix all instances of trailing-whitespace as reported by 'make sphinx-lint'. (From yocto-docs rev: d754df8f2084ad45305cfd9c1cf35da727240aa4) Signed-off-by: Trevor Woerner <twoerner@gmail.com> 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: 38706f0e743447da9a39a6369620fa039ab6df3b) 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>
* 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: 78fd3b3f1ec797dfe3648509a1945241b50640d5) 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: 5b91bfc02ad35fa7b391e39b9559c65dca808d1e) 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: f1f92f0a5a881c45ffecf9cf9bd070c992aff35a) 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: 0d4cda12f2c3f89f64043c30cc0830dfa632e76e) 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: 4bbf915547adcd667247df22a1ff2e7e5f223c3e) 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: 0c08c88aad0a2acf04d2da0f2935f29bc6a6eb99) 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>
* 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: a7000370ca9c1c623cd9272738f1a252e6556951) 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>
* dev-manual/sbom.rst: fix wrong build outputsAntonin Godard2025-05-191-11/+4
| | | | | | | | | | | | | | | | | This document was written with SPDX 3.0 in mind (create-spdx-3.0 class) on OE-Core's master, but Scarthgap only supports SPDX 2.2 (create-spdx-2.2). The create-spdx-2.2 class only generate a tar.zst output, so remove the other outputs listed here. Also, ancillary outputs are not only deployed in tmp/deploy/spdx/MACHINE but tmp/deploy/spdx in general. (From yocto-docs rev: deedc7395f565e9820d914de9ffc3b14f8b143eb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* Fix dead links that use the DISTRO macroAntonin Godard2025-04-289-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: d1f3616b373334a5aa75ad7874f05ee4b0e6591f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 29be069ebbf2c55d72fc51d99ed5a558af37c05e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* poky.yaml: introduce DISTRO_LATEST_TAGAntonin Godard2025-04-282-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: 4195f52117b8132b46dd562acaf40e6e4480be33) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a85b0e500c94921f77fa7b7dbb877e4945f96d1e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: remove repeated wordAndrew Kreimer2025-04-281-1/+1
| | | | | | | | | | The word "modern" appears twice, remove the extra one. (From yocto-docs rev: 6d2715b74d43c39fcee3ad7631d93b5396ce84bf) Signed-off-by: Andrew Kreimer <algonell@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: improve the PKGV documentationAntonin Godard2025-04-281-0/+17
| | | | | | | | | | It may be confusing for users that source control information is not present in the BitBake environment. Document it as a warning block. (From yocto-docs rev: 990b3708d7131ccfb4e435e8a53e987195de3e06) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: HOST_CC_ARCH: fix wrong SDK referenceAntonin Godard2025-04-281-2/+1
| | | | | | | | | | | | | When building for nativesdk recipes, HOST_CC_ARCH equals SDK_CC_ARCH, not BUILDSDK_CC_ARCH which doesn't exist. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: ba030d9d65702889b089bd3c9cb6a719a7e0a413) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 08fc3446cb13b5bd8781874d2d996899ce12b082) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document HOST_*_ARCH variablesAntonin Godard2025-04-281-0/+27
| | | | | | | | | | | | | These variables control the flags for the assembler, compiler and linker, but depend on the context. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 1520ba47f66c6d51f710005cdd4f4b880eccd5b0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit f8eb33569a5e8cadc036855e2d95eee77e627cb4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document missing SDK_*_ARCH variablesAntonin Godard2025-04-281-0/+15
| | | | | | | | | | | | | These variables control the flags for the assembler, compiler and linker when building for nativesdk recipes. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 95f4aabe48a6e06f8391e032c6a7038bf0e10332) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit c08f6d3c8aee86264c069b7c30850cb02de76076) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: add missing documentation for BUILD_* variablesAntonin Godard2025-04-281-20/+230
| | | | | | | | | | | | | | | | | | | | These toolchain variables are used in a native context. Some of the BUILD_* variables missed documentation. Also, some of the base commands were also not there so document them. Some of existing BUILD_* variable documentation were missing the note about their usage in a native context, so add it too so that all BUILD_* variables are documented the same way. [YOCTO #15719] Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: e692a7553ccf7496288f2eb7df71766cb5261eb4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 87103afa1cb6690e9aaa87ca1f23e45eaaa359ac) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: add manpage links for toolchain variablesAntonin Godard2025-04-281-9/+11
| | | | | | | | | | | | Use the :manpage: role to provide links to common toolchain utilities. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: adfb1a4a768f53a0404b65297f7fa9ed12b77088) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 7023e5f176efde05a6798476712c8a4e006a6b0d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* documentation/conf.py: define a manpage urlAntonin Godard2025-04-284-4/+6
| | | | | | | | | | | | | | | | By defining the manpages_url we can use the :manpage: role in the documentation for providing links to manpages. See: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url Replace existing manpages links to use this role. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 73faf4a4fdd3d536e8af92b49bf067746cd9fa05) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 4e63cd74cd1a330ea5e96bb04243a90f607b2857) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document autotools class related variablesAntonin Godard2025-04-281-0/+17
| | | | | | | | | Document the AUTOTOOLS_SCRIPT_PATH and the CONFIGURE_SCRIPT variables. (From yocto-docs rev: b63d665549e14e1a468ffbf07c8494a491833770) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: WATCHDOG_TIMEOUT: fix recipe nameAntonin Godard2025-04-281-2/+2
| | | | | | | | | | | | This variable affects the watchdog-config recipe, not the watchdog recipe. (From yocto-docs rev: b3676b26b02e6e3861dd1d7dcf05dfcf6836bcd5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit d3350c38910c47c76ed17f24579120013589ca1f) 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.8Lee Chee Yang2025-04-282-1/+227
| | | | | | | | | | (From yocto-docs rev: 0fad3824f060805c9c3e974c8db830bb03520d20) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 7494df521ed9c70e877dbdef1adfe38ad717682f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* overview-manual/concepts: remove PR from the build dir listAntonin Godard2025-03-261-3/+0
| | | | | | | | | | | | PR was removed by cc83e4548465 ("bitbake.conf: Drop PE and PR from WORKDIR and STAMP") on OE-Core. (From yocto-docs rev: 56db4fd81f6235428bef9e46a61c11ca0ba89733) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit d7a1038ee7c8c463623f0996963f9e8f29d40555) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: remove OE_IMPORTSRoss Burton2025-03-081-8/+0
| | | | | | | | | | | | | | | | oe-core no longer supports OE_IMPORTS[1], so remove the documentation. [1] oe-core 1f56155e ("base: Switch to use addpylib directive and BB_GLOBAL_PYMODULES") (From yocto-docs rev: 7d3cce5b962ca9f73b29affceb7ebc6710627739) Signed-off-by: Ross Burton <ross.burton@arm.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit d03dad11974ada7a99b4406e2350b9f5f0acc746) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: don't refer to poky-lsbRoss Burton2025-03-081-1/+1
| | | | | | | | | | | | | This was removed in 2019, so swap it for poky-altcfg. (From yocto-docs rev: f0348f44008b6f89ed1119497fe2dcd230691625) Signed-off-by: Ross Burton <ross.burton@arm.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 7f7f6570befdda280c174a5f9776b20f53f3ea0d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* Remove all mention of core-image-lsbRoss Burton2025-03-083-36/+13
| | | | | | | | | | | | | | | | core-image-lsb was removed in 2019[1], so remove all of the incredibly obsolete references in the documentation. [1] oe-core fb064356af615d67d85b65942103bf943d84d290 (From yocto-docs rev: 05029257d0c5f090d5c0a96c6244bfaf40615178) Signed-off-by: Ross Burton <ross.burton@arm.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 062445a49919eff117b5478c1fb18d125c1f895c) 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.25Lee Chee Yang2025-03-082-0/+168
| | | | | | | | | | (From yocto-docs rev: 0bf41c5366c4ca7982336e433f69f88c7ea98fa6) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 4649514cdfae496f43711d6b830a0a835c3a1534) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* vulnerabilities/classes: remove references to cve-check text formatMarta Rybczynska2025-02-282-29/+69
| | | | | | | | | | | | | The text format has been removed, so also remove references and examples using this format. Replace with examples with the JSON format. (From yocto-docs rev: 3757ace0581e6279aa7c065b21cee56edfe985dd) Signed-off-by: Marta Rybczynska <marta.rybczynska@ygreky.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a52cd7bcadccc53e982f90d6e170d00798322597) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: Add missing variable IMAGE_ROOTFS_MAXSIZEWeisser, Pascal2025-02-281-0/+6
| | | | | | | | | | | | | | This patch adds the missing documentation of variable IMAGE_ROOTFS_MAXSIZE to the reference manual. (From yocto-docs rev: c3c18c5f3d8f1ac8781dbc3fdbfdb53c94095f62) Signed-off-by: Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1dcc8cf7c49da449b324a7bd6bb22effe1d53d70) 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.7Lee Chee Yang2025-02-212-0/+333
| | | | | | | | | | (From yocto-docs rev: fb677d4289bb00b7807f512a1e3b7c89d3e3d92e) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 9f1f9f1a3a2a541ed70df72d4fe391b5b7fd3733) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* Add favicon for the documentation htmlAntonin Godard2025-02-212-0/+1
| | | | | | | | | | | | | Import the favicon from https://www.yoctoproject.org/, convert it to 16x16 (as per the Sphinx documentation) to make a 1291B image of the Yocto logo. (From yocto-docs rev: 14de49a1ec6d725764e2a968edd3386252e826fe) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit e3ee43e6d70685a2404aae2d60557a42879b0bb1) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide/submit-changes: add policy on AI generated codeAntonin Godard2025-02-211-0/+49
| | | | | | | | | | | | | | Based on message by Richard Purdie on the yocto-docs list: https://lists.yoctoproject.org/g/docs/message/6300 Re-formatted for the Yocto Project documentation syntax. (From yocto-docs rev: da3aa5ba9387ca5bb7ddd75fe6f7962d0629ea90) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a72dd13e6841b621c9e8f904dfaa440c186d2959) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* sdk-manual: extensible.rst: update devtool ide-sdkAdrian Freihofer2025-02-211-3/+4
| | | | | | | | | | | | | | | | | | | | Replace devtool ide-sdk --debug-build-config by devtool modify --debug-build This change was introduced with commit https://git.yoctoproject.org/poky/commit/?id=1f7eb26c947dde14698ae6e2ab88f0637027f4cb (From yocto-docs rev: 04b8b94a2fa892c3580a2a506dc5b40d6a176a41) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit e2b6a4c6c633e79d0e4975ba2e1a27a8c1b8c1c5) 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.24Lee Chee Yang2025-02-122-1/+384
| | | | | | | | | | (From yocto-docs rev: 0e9cc7e9ad5c8bbd7f12a192bff103c118d7f7bb) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1c848b4104ee0ba9b07cdb424bb829d14f9982d7) 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 2025-08-04 17:41:02 +0000