summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual/classes.rst: drop obsolete QA errorswalnascarAntonin Godard4 days1-13/+0
| | | | | | | | | | | | Drop after commit 068d38214307 ("insane: remove obsolete QA errors") from OE-Core. (From yocto-docs rev: 698253a6c95beb1219b7fed8a90d02fb6ddc5111) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit e5667ae2da1805327ecfff68300c0c460da49b91) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/classes.rst: insane: drop cve_status_not_in_dbAntonin Godard4 days1-5/+0
| | | | | | | | | | | | This was dropped by commit 452e605b55ad ("cve-check: annotate CVEs during analysis"). (From yocto-docs rev: 4c94ef90e01b6aa7e7eaae8776135b615d0d6069) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 55aedec94dce3e3c0541ffaea666cff02d63a708) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* variables.rst: remove references to obsolete tar packagingRobert P. J. Day4 days1-10/+4
| | | | | | | | | | | | | The tar packaging format was removed some time ago. Also, add some minor grammatical tweaking. (From yocto-docs rev: d62599595f68b75e5bf885367ca1f01a6d63bb3d) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 8e9fd1ca232f3c1e8be51cb881a68b4745ee548a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/structure.rst: remove shared PERSISTENT_DIR mentionsAntonin Godard2025-07-171-11/+0
| | | | | | | | | | | | | PERSISTENT_DIR should _not_ be shared, I got that wrong in my previous commit 741aa29898dc ("ref-manual/structure.rst: update with info on PERSISTENT_DIR"). Remove these mentions. (From yocto-docs rev: 9b04faeacad63ada93af3e31fa66fbfe387aa53a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 4c7fc7a6e9b0b957bcf0deb66adb0a6d9ebead00) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/structure.rst: update with info on PERSISTENT_DIRAntonin Godard2025-07-171-1/+13
| | | | | | | | | | | | | | Since we mention that SSTATE_DIR can be shared for multiple builds, also mention that PERSISTENT_DIR should be shared alongside SSTATE_DIR. [YOCTO #15921] (From yocto-docs rev: b2774467ed327baeddcc9161fe7ffee797f9158d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 741aa29898dc7f34ebd423ff7565334b2c89e18c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* 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>
* 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>
* 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>
* brief-yoctoprojectqs/ref-manual: Switch to new CDNRichard Purdie2025-06-131-1/+1
| | | | | | | | | | | | | | 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>
* sphinx-lint: unbalanced inline literal markupTrevor Woerner2025-06-025-9/+9
| | | | | | | | | | | | | | | | | | 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>
* 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>
* 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-191-2/+2
| | | | | | | | | | | | | | | | | 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>
* 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>
* 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>
* Fix dead links that use the DISTRO macroAntonin Godard2025-04-212-2/+2
| | | | | | | | | | | | | | | | | | 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>
* ref-manual/variables.rst: improve the PKGV documentationAntonin Godard2025-04-211-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: 39967b9cc87cf216c4658598806fd7a68db5053a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: HOST_CC_ARCH: fix wrong SDK referenceAntonin Godard2025-04-031-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: a4a8aca22bb854756eb2ed1e652331bec3c7c68e) 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: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document HOST_*_ARCH variablesAntonin Godard2025-04-031-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: 8f070b788c9cd6cc16e03505d978177b4c82de03) 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: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document missing SDK_*_ARCH variablesAntonin Godard2025-04-031-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: 978300e5f14874f2586efa3474c6f3803e3d9031) 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: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: add missing documentation for BUILD_* variablesAntonin Godard2025-04-031-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: e42d49218945a030f300dbb608e7cfb0611f5733) 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: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: add manpage links for toolchain variablesAntonin Godard2025-04-031-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: 8a25963c8dfc36482582294f0d2e7c7555d96399) 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: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/conf.py: define a manpage urlAntonin Godard2025-04-031-2/+1
| | | | | | | | | | | | | | | | 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: 0d0115cb2d96960837678f775cf5c2297494c51c) 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: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes: ptest-python-pytest: improve the current documentationAntonin Godard2025-04-032-5/+4
| | | | | | | | | | | | Improve the current ptest-python-pytest documentation and PTEST_PYTEST_DIR variable definition. Namely remove the default value that may evolve over time. Suggested-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: a83406103ca73d84fc8f5c50a8968faf91276a62) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the SPDX_PACKAGE_VERSION variableAntonin Godard2025-03-281-0/+5
| | | | | | | | | | | This variable controls the package version as seen in the SPDX 3.0 JSON output (software_packageVersion). The default value for this variable is PV. (From yocto-docs rev: 3b483c5295b26748c6f2cd63074b20ac3da97b32) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the GRUB_MKIMAGE_OPTS variableAntonin Godard2025-03-281-0/+5
| | | | | | | | | | This new Grub variable controls the options passed to the grub-mkimage command in the Grub recipe. (From yocto-docs rev: 2e5a3c3d5199cad6fb90e0218cdd4a1779743644) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/system-requirements.rst: update list of supported distributionsAntonin Godard2025-03-281-4/+6
| | | | | | | | | | Before the 5.2 release, update the list of supported distributions to match the SANITY_TESTED_DISTROS variable in poky.conf. (From yocto-docs rev: 9dac392c0d834c0089c514d7ad85beeb04d1b698) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* requirements: move Ubuntu-20.04 into unsupported category due to pythonPaul Gortmaker2025-03-281-3/+5
| | | | | | | | | | | | | | | | | | | | | | | Bitbake commit 0d2e682d00df ("bitbake: lib/bb: Bump minimum python version requirement to 3.9" -- poky commit 67566c7410e1) means that Ubuntu 20.04 is no longer supported out-of-the-box as detailed further in the respective commit log. While it is true that it can still be used with buildtools, that can also be said for nearly every other unsupported distro out there, including Ubuntu 18.04 that we listed as unsupported some years ago. Hence continuing to list it as supported with the new python requirement in place does not make sense. So we move it alongside of the 18.04 entry, into the "possibly tested, but you get what you get" category. And add an explicit mention of the buildtools, so people have a thread to pull on. (From yocto-docs rev: b1c09003dc304b1e65044f343fb341aaed58e6f3) Signed-off-by: Paul Gortmaker <paulg@kernel.org> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: add a link for BB_USE_HOME_NPMRCAntonin Godard2025-03-271-0/+3
| | | | | | | | | Documented in the BitBake manual. (From yocto-docs rev: f58b8c80b7665ab5e67398a4ce4bfaa035114278) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document autotools class related variablesAntonin Godard2025-03-271-0/+17
| | | | | | | | | Document the AUTOTOOLS_SCRIPT_PATH and the CONFIGURE_SCRIPT variables. (From yocto-docs rev: b3964a89fd6a5f19a8f45f9b46e8eaa8b8bff38e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the NVD_DB_VERSION variableAntonin Godard2025-03-271-0/+12
| | | | | | | | | | This variable allows choosing the CVE feed when using the cve-check class. (From yocto-docs rev: 639ea86c5034d7706faf14a2ff52b603c3ccd905) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the MESON_INSTALL_TAGSAntonin Godard2025-03-271-0/+4
| | | | | | | | | | This variable can be used to add install tags to the 'meson install' command. (From yocto-docs rev: 72b502cfb67345cda17bc2ae7af222b7cecb9a0c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/features.rst: drop ld-is-goldAntonin Godard2025-03-271-3/+0
| | | | | | | | | | Dropped in OE-Core after commit a4addb9ab630 ("recipes: Drop ld-is-gold support"). (From yocto-docs rev: 95645cb765b20c3215defe165e7d886da98c1787) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the MOUNT_GROUP variableAntonin Godard2025-03-271-0/+5
| | | | | | | (From yocto-docs rev: 959735468264bac1bdd7b274fc1477635817c208) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the WATCHDOG_RUNTIME_SEC variableAntonin Godard2025-03-271-0/+5
| | | | | | | | | | This variable controls the RuntimeWatchdogSec option in /etc/systemd/system.conf. (From yocto-docs rev: 6d6b638ee94c3ba36a02ef2289bf246392d8c854) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: WATCHDOG_TIMEOUT: fix recipe nameAntonin Godard2025-03-271-2/+2
| | | | | | | | | | This variable affects the watchdog-config recipe, not the watchdog recipe. (From yocto-docs rev: d3350c38910c47c76ed17f24579120013589ca1f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: document the ptest-python-pytest class and variablesAntonin Godard2025-03-272-0/+25
| | | | | | | | | | Add documentation for the ptest-python-pytest class, and the PTEST_PYTEST_DIR variable which can be overriden. (From yocto-docs rev: 1abee62c2b9f32dfa42782893940f211db930b4c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: uboot-sign: Add how to enable ATF, TEE and User defined snippet ↵Jamin Lin2025-03-242-0/+151
| | | | | | | | | | | | ITS for U-Boot FIT image Add how to enable ATF, TEE and User defined ITS for U-Boot FIT image generation. (From yocto-docs rev: ee6b3698da044e290dbc4fbb852f3cc37638e689) 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>
* ref-manual: variable FIT_SIGN_INDIVIDUAL mix-and-match attacksAdrian Freihofer2025-03-241-7/+29
| | | | | | | | | | | | | | | | | | | | Incorporate the lessons learned from a regression introduced with commit OE-Core rev: 259bfa86f384206f0d0a96a5b84887186c5f689e u-boot: kernel-fitimage: Fix dependency loop if UBOOT_SIGN_ENABLE and UBOOT_ENV enabled and fixed with commit OE-Core rev: 0106e5efab99c8016836a2ab71e2327ce58a9a9d u-boot: kernel-fitimage: Restore FIT_SIGN_INDIVIDUAL="1" behavior into the documentation. The use of the variable FIT_SIGN_INDIVIDUAL is explicitly discouraged. (From yocto-docs rev: d34e1d4e3f229bcd6560fe7df544869b0cd9875f) 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/variables: document KMETA* and KCONF_AUDIT* variablesAntonin Godard2025-03-071-0/+68
| | | | | | | | | | | | | Document the variables used to control the outcome of the kernel configuration auditing done by the kernel-yocto bbclass. [YOCTO #13835] Acked-by: Bruce Ashfield <bruce.ashfield@gmail.com> (From yocto-docs rev: f75a1c1a1447ed52dc6561c67e6afb5fd1413f28) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove OE_IMPORTSRoss Burton2025-03-071-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: d03dad11974ada7a99b4406e2350b9f5f0acc746) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: don't refer to poky-lsbRoss Burton2025-03-071-1/+1
| | | | | | | | | | | This was removed in 2019, so swap it for poky-altcfg. (From yocto-docs rev: 7f7f6570befdda280c174a5f9776b20f53f3ea0d) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Remove all mention of core-image-lsbRoss Burton2025-03-071-21/+0
| | | | | | | | | | | | | | 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: 062445a49919eff117b5478c1fb18d125c1f895c) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-08-08 09:19:00 +0000