summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual/yocto-project-supported-features: add ppc maintainersAdrian Freihofer4 days1-1/+2
| | | | | | | | | | | | | | | | PowerPC (32-bit) remains relevant for our use cases, and we aim to maintain support as long as it is feasible with reasonable effort. For transparency, our primary focus is on maintaining core-image-minimal. Support for more complex images may be limited unless additional contributors join, as ongoing testing and maintenance of these images may not be feasible otherwise. (From yocto-docs rev: 63f0053f0f0201529bfad3e3f1b0211ac40ad1c2) 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.rst: document BB_GIT_DEFAULT_DESTSUFFIXAntonin Godard4 days1-0/+7
| | | | | | | | | | Recently added in BitBake with 378db0fdd95f ("fetch2/git: allow overriding default unpack directory with a variable"). (From yocto-docs rev: c696f78107a4e0a26329faad11212eb7949e0c70) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: correct references to WORKDIR to account for recent do_unpack ↵Alexander Kanavin4 days2-14/+4
| | | | | | | | | | changes (From yocto-docs rev: 2e83260484c102fe7b788585cbdd7ca91ba91d85) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: drop a sentence about a 'legacy way' to specify UNPACKDIRAlexander Kanavin4 days1-2/+1
| | | | | | | | | | | | This wasn't specific, and is obsolete: UNPACKDIR should not be set by recipes at all, except in very special circumstances (e.g. gcc/clang unpacking into work-shared). (From yocto-docs rev: a880d94d70c7ed1da8e40a02dae43ff1699941a6) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document KERNEL_SPLIT_MODULES variableDixit Parmar4 days1-0/+21
| | | | | | | | | | | | This variable controls the kernel module spliting. [YOCTO #15771] (From yocto-docs rev: 198179d9c6231b5934d4fb6ede716d1dcb1442bb) Signed-off-by: Dixit Parmar <dixitparmar19@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/yocto-project-supported-features: Set riscv32 maintainers as TBDRichard Purdie10 days1-1/+1
| | | | | | | | This isn't committed to by anyone at this point to mark as TBD. (From yocto-docs rev: 6b45207c8db40ef416f12348e066601975a0ca36) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/yocto-project-supported-features: Update to match current statusRichard Purdie2025-06-201-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 Turull2025-06-201-0/+22
| | | | | | | | | | | | | | | 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>
* tree-wide: make the :doc: directive use absolute pathsQuentin Schulz2025-06-203-4/+4
| | | | | | | | | | | | | | | | | | | 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>
* ref-manual: replace kernel-fitimage by kernel-fit-imageAdrian Freihofer2025-06-202-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 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: 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 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: 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 Godard2025-06-171-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>
* ref-manual/yocto-project-supported-features: add a contact for meta-armRoss Burton2025-06-171-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 Godard2025-06-162-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>
* 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>
* brief-yoctoprojectqs/ref-manual: Switch to new CDNRichard Purdie2025-05-291-1/+1
| | | | | | | | | 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>
* sphinx-lint: unbalanced inline literal markupTrevor Woerner2025-05-265-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: 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>
* 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>
* 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>
* 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-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: 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>
* 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>
* 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>
* 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>