summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
...
* 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>
* migration-guides/release-notes-5.2: add known issue on stalled NVDAntonin Godard2025-03-241-0/+17
| | | | | | | | | | | | | Add an entry to the known issue as the NVD is not up-to-date, the impact on current CVE reports and future plans for the Yocto Project. Follows the discussion on: https://lists.openembedded.org/g/openembedded-core/message/212446 (From yocto-docs rev: c83aa6649fb7bca7e6b393356c8268aa4f18dc4b) 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>
* overview-manual/concepts: add UNPACKDIR in the directory descriptionAntonin Godard2025-03-241-6/+9
| | | | | | | | | | | | | | | | Mention that UNPACKDIR is used as a location to unpack the source code, and that S is the final location of the source code. This is deliberately vague, because as there are multiple instances of how these directories can be defined and used. The proper explanation of how the UNPACKDIR and S directories interact is left to the reference manual, under the UNPACKDIR variable description. (From yocto-docs rev: 76361ae37bd45c9ce5190fb6c7c400bf2fc14003) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual/concepts: remove PR from the build dir listAntonin Godard2025-03-241-3/+0
| | | | | | | | | | PR was removed by cc83e4548465 ("bitbake.conf: Drop PE and PR from WORKDIR and STAMP") on OE-Core. (From yocto-docs rev: 569c707c69a7a858553e40b26cb36db18f2a42fc) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: convert analysis-for-package-splitting.png to svgAntonin Godard2025-03-243-1/+1863
| | | | | | | | | | | | | - Convert the png file to an SVG file - Add the UNPACKDIR reference. - Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf: Drop PE and PR from WORKDIR and STAMP") on OE-Core. - Change S value to BP (equal to ${BPN}-${PV}, but more accurate). (From yocto-docs rev: 6fd6af3ea9e556e481cc3c0358c0357b6060798f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: convert configuration-compile-autoreconf.png to svgAntonin Godard2025-03-243-1/+1498
| | | | | | | | | | | | | - Convert the png file to an SVG file - Add the UNPACKDIR reference. - Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf: Drop PE and PR from WORKDIR and STAMP") on OE-Core. - Change S value to BP (equal to ${BPN}-${PV}, but more accurate). (From yocto-docs rev: f24b00200ac49cda07e4c77e3e1b161a5b78b006) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: convert patching.png to svgAntonin Godard2025-03-243-1/+1225
| | | | | | | | | | | | | | - Convert the png file to an SVG file. - Add the new UNPACKDIR directory to the image. - Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf: Drop PE and PR from WORKDIR and STAMP") on OE-Core. - Change S value to BP (equal to ${BPN}-${PV}, but more accurate).- Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 73b6c0c5e5470d4a929fd3d5cde6d4fb0ace53b8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: convert source-fetching.png to svg and fix UNPACKDIRAntonin Godard2025-03-243-1/+1095
| | | | | | | | | | | | | | | | - Convert the png file to an SVG file. - Add the new UNPACKDIR directory to the image. - Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf: Drop PE and PR from WORKDIR and STAMP") on OE-Core. - Change S value to BP (equal to ${BPN}-${PV}, but more accurate).- This fixes [YOCTO #15730]. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 9fc105137d54523b1f9a477fe7b52587a6bcb6c8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: remove qemu machine name list in runqemu invocationRoss Burton2025-03-241-3/+0
| | | | | | | | | | | This list of "valid" qemu machine names is obsolete and incorrect, so just remove it as it serves no real purpose. (From yocto-docs rev: ee8839480fe574598b4d52a8fd6c11bb301ad3d9) 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>
* migration-guides: cover FIT_UBOOT_ENVAdrian Freihofer2025-03-241-0/+8
| | | | | | | | | | | | Add a hint for users using the UBOOT_ENV variable and the kernel-fitimage.bbclass. (From yocto-docs rev: 4d04531d4015bb61e68dfbed87d743772b6178b7) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.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.1.3Lee Chee Yang2025-03-072-0/+161
| | | | | | | | (From yocto-docs rev: e608902ffae3af5ab0c5308b0550e49a790482f0) 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: 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-073-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: 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>
* ref-manual: cover UBOOT_ENV variablesAdrian Freihofer2025-03-071-0/+63
| | | | | | | | | (From yocto-docs rev: dc2ff96a3401eba8dac86fc8305b261be52c8a13) 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 release notes for 4.0.25Lee Chee Yang2025-03-072-0/+168
| | | | | | | | (From yocto-docs rev: 4649514cdfae496f43711d6b830a0a835c3a1534) 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>
* dev-manual/multiconfig: add suggested best practices and baremetal sectionsAntonin Godard2025-02-261-0/+136
| | | | | | | | | | | | | | | | | | | | | | After the suggestions from Mark Hatle on the list (https://lists.yoctoproject.org/g/docs/topic/110487932), add two sections to the multiconfig doc: - Suggested best practices: suggestion for better design of multiconfig builds. - Common use case: baremetal build. This section applies the guidelines from the first sections and apply it to a real-life example of how to use multiconfig. This one to build some baremetal firmware alongside a regular Linux build. Suggested-by: Mark Hatle <mark.hatle@kernel.crashing.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 36fb1e9e5099aa0d858d5478530143e9bac39588) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/multiconfig: improve the current docAntonin Godard2025-02-261-26/+42
| | | | | | | | | | | | | | | | | After the suggestions from Mark Hatle on the list (https://lists.yoctoproject.org/g/docs/topic/110487932), rewrite the introduction to multiconfig with the following changes: - Move the part of overriding TMPDIR or not to a note. - Use BB_CURRENT_MC in the example. - Various additions of references & improved formatting. Suggested-by: Mark Hatle <mark.hatle@kernel.crashing.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 8cedef6d5b701235325e6e0bdd793f8c06dfef57) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/multiconfig: rename to use Multiconfig termAntonin Godard2025-02-261-2/+2
| | | | | | | | | | | Rename this section to explicitely name the multiple configuration feature "multiconfig". Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 286db24f37bf16a157d3897a046f1fc0d33a44b4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-5.2: fix references to BB_CURRENT_MCAntonin Godard2025-02-261-2/+2
| | | | | | | | | | Now part of the documentation. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 2a50504bd5c211bfae26db64190863fdf53fc3c9) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* variables.rst: add a reference to BB_CURRENT_MC from bbdocsAntonin Godard2025-02-261-0/+3
| | | | | | | | | | | BB_CURRENT_MC is documented in the Bitbake user manual. Add a reference to it here. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: a9aaef86bf76027f602546b5d4a3dffc6168d9b4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: move multiconfig documentation to its own documentAntonin Godard2025-02-263-154/+163
| | | | | | | | | | | In preparation of more section and examples to multiconfig, move the section about it in building.rst into its own document. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 6f60fb09976540dd320816684684c14f6b7ab460) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* vulnerabilities/classes: remove references to cve-check text formatMarta Rybczynska2025-02-262-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: a52cd7bcadccc53e982f90d6e170d00798322597) Signed-off-by: Marta Rybczynska <marta.rybczynska@ygreky.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add missing variable IMAGE_ROOTFS_MAXSIZEWeisser, Pascal2025-02-261-0/+6
| | | | | | | | | | | | This patch adds the missing documentation of variable IMAGE_ROOTFS_MAXSIZE to the reference manual. (From yocto-docs rev: 1dcc8cf7c49da449b324a7bd6bb22effe1d53d70) Signed-off-by: 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>
* release-notes-5.2: Add new variable OEQA_REPRODUCIBLE_TEST_LEAF_TARGETSYoann Congal2025-02-261-0/+4
| | | | | | | | | | | | Add mention of OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS to release-notes-5.2 to users can use it after upgrading. (From yocto-docs rev: eec44e4daf414be414e9fd0471b0381b980d6fab) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* reproducible-builds: add a "How to" section with OEQA* variablesYoann Congal2025-02-261-0/+20
| | | | | | | | | | | | | Shows an example of the new variable OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS and still mention OEQA_REPRODUCIBLE_TEST_TARGET/SSTATE_TARGETS that were shown earlier. (From yocto-docs rev: 78cf8b1ff1cdfbc863033f267da8fb60419b50fc) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* reproducible-builds: change/add titles in the "How" sectionYoann Congal2025-02-261-3/+9
| | | | | | | | | | | This is preparation work for the following commit. (From yocto-docs rev: 0ff459c273704a281419a44ae5670068ac47f1b9) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETSYoann Congal2025-02-261-0/+7
| | | | | | | | | | | | This documents the variable used in the "automate testing a single recipe's reproducibility" feature [YOCTO #15701] (From yocto-docs rev: 417b423ea3d2ba9903d21d930c1982ff2ac6f596) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr> 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.7Lee Chee Yang2025-02-182-0/+333
| | | | | | | | (From yocto-docs rev: 9f1f9f1a3a2a541ed70df72d4fe391b5b7fd3733) 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>
* Add favicon for the documentation htmlAntonin Godard2025-02-182-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: e3ee43e6d70685a2404aae2d60557a42879b0bb1) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide/submit-changes: add policy on AI generated codeAntonin Godard2025-02-181-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: a72dd13e6841b621c9e8f904dfaa440c186d2959) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* tools: add script for building documentation inside containersQuentin Schulz2025-02-188-0/+262
| | | | | | | | | | | | | | | | | | | | | | | | This adds a script for building a container and building the documentation within that new container image. The openSUSE instructions now require a --non-interactive flag otherwise they fail to run. Sadly there doesn't seem to be a way to have this in an environment variable à-la DEBIAN_FRONTEND=noninteractive, so we simply do a sed on the scripts to add --non-interactive to the zypper commands to avoid having those in the instructions provided to our users. Somehow tzdata package in Ubuntu doesn't respect DEBIAN_FRONTEND=noninteractive hence why the timezone needs to be set by hand. (From yocto-docs rev: cefced592f1302fcb65afa9e0b1f9f5ff1570e93) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Tested-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: use literalinclude for system requirementsQuentin Schulz2025-02-1815-269/+65
| | | | | | | | | | | | | | | | | | | | | | | The YAML variables for the host dependencies are updated by hand and actually only used inside code blocks. Let's migrate all instructions into separate shell scripts that are then literalinclude'd into the Sphinx documentation. This allows a few things: - ability to run shellcheck on the scripts if we ever want to - manually calling the appropriate script from a supported distro to build stuff (distro or bitbake/yocto stuff) - use this script to create containers to do CI of documentation on different distros, to make sure our instructions are all up to date, (From yocto-docs rev: 8d993022c2aefc0fde9baa949d39d7a3613f9f46) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Tested-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-5.2: add virtual provider changeAntonin Godard2025-02-071-0/+35
| | | | | | | | | | | | | | The commit 4ccc3bc8266c ("classes/recipes: Switch virtual/XXX-gcc to virtual/cross-cc (and c++/binutils)") in OE-Core changes the virtual/XXX-gcc to virtual/cross-cc (and c++/binutils) syntax. Add it to the migration manual. (From yocto-docs rev: 6eda443c7fcfeecebd6b44b96a1587c4bb093a34) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> 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-5.2: document BB_CURRENT_MC default value changeAntonin Godard2025-02-071-0/+11
| | | | | | | | | | | | | After commit 0fa0d8d764bb ("cooker/cache: Drop mc 'default' string value") in Bitbake, the default value of BB_CURRENT_MC was changed from "default" to an empty string. Document it. (From yocto-docs rev: efbd8fa30a5cc42d5243aa87e00e2d92cb265adb) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> 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.1.2Lee Chee Yang2025-02-072-0/+313
| | | | | | | | (From yocto-docs rev: ba80f0cdeea9e2e3bbfecfeae8c3be9a2cb36297) 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 4.0.24Lee Chee Yang2025-02-072-1/+384
| | | | | | | | (From yocto-docs rev: 57f92aebc14c45bd73bb0b730bdbf6526e7e5546) 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: Describe grub-efi-cfg overrides and GRUB_TITLESimon A. Eugster2025-02-072-0/+21
| | | | | | | | | | | | | This patch describes how to use overrides for grub-efi-cfg because that is otherwise only clear after reading the .bbclass file. It also adds a description for GRUB_TITLE. (From yocto-docs rev: b9ec7d124c9cbaf6c05415277fa028a39ce9e02f) Signed-off-by: "Simon A. Eugster" <simon.eu@gmail.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/faq: add q&a on systemd as defaultAntonin Godard2025-02-071-0/+22
| | | | | | | | | | | | Originally written by Richard Purdie, but formatted in rst syntax and slight rephrasing. Cc: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 568922014e5c00ecf0c3d19b8c7fefa0e3801183) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/devtool: remove reference to the extensible SDKAntonin Godard2025-02-071-10/+5
| | | | | | | | | | | | | | | There were leftover references to the extensible SDK after moving the devtool documentation from the Extensible SDK document to its own devtool document. This patch follows the bulk move to make it clear what was modified in the document. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 032d2f3297ff4b5ee4e000b3dd0748a58b5f32e0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Move devtool doc from extensible to dev manualAntonin Godard2025-02-0713-1327/+1338
| | | | | | | | | | | | | | | | | | | | [YOCTO #13417] devtool is not directly tied to the Extensible SDK anymore, and instructions in there can be split and added to the development manual. This patch is a simple bulk move, except for the following: - Intro added to the devtool.rst document (mostly copy-pasted from the devtool quick reference in the ref-manual). - Figures renamed to remove "sdk-" from filenames. - References to sdk-manual/extensible replaced by dev-manual/devtool. Reported-By: Paul Eggleton <bluelightning@bluelightning.org> (From yocto-docs rev: 044d3185b858fce1febcfe3a6834b883f9a598fa) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/packages: add information about signing changesZoltán Böszörményi2025-02-071-3/+13
| | | | | | | | | (From yocto-docs rev: 6c1a77e5db7ae9910d24deb023619b9391c8b4ad) Signed-off-by: Zoltán Böszörményi <zboszor@gmail.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-5.2: add information about rpm and sequoiaZoltán Böszörményi2025-02-071-0/+4
| | | | | | | | | (From yocto-docs rev: 074592afcba03e932778471c44019623943814fc) Signed-off-by: Zoltán Böszörményi <zboszor@gmail.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fix typo in standards.mdSimon A. Eugster2025-02-071-1/+1
| | | | | | | | (From yocto-docs rev: 9007d7eb63b296aae832028924d89f83dc159992) Signed-off-by: "Simon A. Eugster" <simon.eu@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/building: document the initramfs-framework recipeAntonin Godard2025-01-291-1/+83
| | | | | | | | | | | | | | | | | [ YOCTO #14747 ] Adding a initramfs is a common task, and the way oe-core offers to do so is by using the initramfs-framework recipe and companion modules. There was already documentation on adding an initramfs but the documentation was lacking details on this framework. Add it before the multiconfig section because it is a bit more important IMO. Reported-by: Alejandro <alejandro@enedino.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: caedbca4eced4cf5bc74aaae64e4ad2887c2fc65) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual/ptest: link to common framework ptest classesAntonin Godard2025-01-291-0/+14
| | | | | | | | | | | | | We document how to add ptest support for a recipe by inheriting the ptest class. We may as well tell the user to inherit a ptest class for a common framework which does most of the job for you. Suggested-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 411b18e489a97ea4cde05613cdd4c86deb0cb8cb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: fix spurious parenthesisQuentin Schulz2025-01-291-1/+1
| | | | | | | | | | | | There's no opening parenthesis, so let's remove the spurious closing parenthesis. Fixes: ea638e85316d ("ref-manual/variables: document the KERNEL_CONSOLE variable") (From yocto-docs rev: 6f0e150179db2a2a8e9ad879167e0d84137190dc) 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: add documentation for the barebox classEnrico Jörns2025-01-292-0/+66
| | | | | | | | | | | | | This adds the initial documentation for the newly added barebox.bbclass to the Reference Manual's class list. It also adds the two most notable variables to the variable list. (From yocto-docs rev: cc8179122441cdc26ff62511dcd97f7bf9bf7e3d) Signed-off-by: Enrico Jörns <ejo@pengutronix.de> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> 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-09-09 10:47:51 +0000