summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* Fix dead links that use the DISTRO macrostyheadAntonin Godard2025-05-259-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: f264569312ffa8a4ad1f9e2022b4eaa14aeb3099) 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: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: introduce DISTRO_LATEST_TAGAntonin Godard2025-05-252-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: 6554f50b3fb424a746ba4136fad7510e950f4b3b) 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: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: remove repeated wordAndrew Kreimer2025-05-251-1/+1
| | | | | | | | | | The word "modern" appears twice, remove the extra one. (From yocto-docs rev: c3671cbddaa3c0df195a5cd01d50e26cb6dbcbe4) Signed-off-by: Andrew Kreimer <algonell@gmail.com> 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-05-251-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: ba0a321e5c623a9c716be7a451fdd60fae5b26b4) 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-05-251-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: 50cf8b92b6f37ecc7f696f6687980e68cb8286e5) 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-05-251-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: cfc7bce0b7368a6ecfaef7c7df6222f1a6076e9b) 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-05-251-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: 028bdce97d62e200e032da6d0c54c0c4109e5a97) 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-05-251-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: f16a641086a7c3546b599a5996c4f7a6db04967e) 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-05-251-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: f021874bff4e7d30419371564fef41fcfd6d6976) 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-05-254-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: f5c964f41ed0f9a9740769e40aabf543df274c03) 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/variables.rst: document autotools class related variablesAntonin Godard2025-05-251-0/+17
| | | | | | | | | Document the AUTOTOOLS_SCRIPT_PATH and the CONFIGURE_SCRIPT variables. (From yocto-docs rev: 1065f57bc029e58570de6bb28062c17130e8a102) 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-05-251-2/+2
| | | | | | | | | | | | This variable affects the watchdog-config recipe, not the watchdog recipe. (From yocto-docs rev: 619ab9da0c3a121776bbbedc55c64a4e9631e497) 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: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 5.0.8Lee Chee Yang2025-05-252-1/+227
| | | | | | | | | | (From yocto-docs rev: dee872d147abc18bba550a172bd04b0d3b587c39) 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: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 5.1.4Lee Chee Yang2025-05-252-0/+138
| | | | | | | | | | (From yocto-docs rev: 4fa9953b69a4f6b19dff8d762ba30ebc50449798) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit f7c8fdfdfef0cac529594af5bdb72e53b29262fe) 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-05-251-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: 85e738e4c0e62f69699fff4bb0482ee3e3121496) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 39ca56c3a3a5218ca73c7ced212b2ee89428a2d1) 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-05-251-3/+0
| | | | | | | | | | | | PR was removed by cc83e4548465 ("bitbake.conf: Drop PE and PR from WORKDIR and STAMP") on OE-Core. (From yocto-docs rev: 05a7235cfa9a3d899395c80a1a8caae8b3b3eba9) 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: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: convert analysis-for-package-splitting.png to svgAntonin Godard2025-05-253-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: 2836f36e6e9fd42801b129232fc9e7db35ea7136) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 18832dd1e90ad85916b1f757271493ddfd3eb432) 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-05-253-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: 272056be6e32d1b6cd2b7064ab764a55474721b5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 91b53f4d1de5b9669cbb8d7fc741ba9c08c31f94) 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-05-253-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: 508d65d5eb1759caa926aa8a4634679647e2b121) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 3aa3af6d5214b47555c4c2b16e9c720122e16fa4) 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-05-253-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: 404a0fb167402e13d3a4ce5aba23aa22a78a0c06) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 27725e4e7bf4d5fe7ad222de077cc693b9205b17) 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-131-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: f0324b8f14881227336f84325cdebd0518e17796) 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-131-1/+1
| | | | | | | | | | | | | This was removed in 2019, so swap it for poky-altcfg. (From yocto-docs rev: 69aedbe855297f3292481926d6f8e530ea647517) 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-133-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: 9cc8bddc4d3ac0fd2c5dd4ecce582789bb5bd19c) 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 5.1.3Lee Chee Yang2025-03-132-0/+161
| | | | | | | | | | (From yocto-docs rev: 26f635637105238d2600f488b2f975f7caa858a5) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit e608902ffae3af5ab0c5308b0550e49a790482f0) 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-132-0/+168
| | | | | | | | | | (From yocto-docs rev: 0a7854a3185bc643ec914d2f2dc0a9a0bb9e4711) 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-03-062-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: 08f4670ef7c7a2071f3634cbf0d9c3d0cd2dde3e) 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-03-061-0/+6
| | | | | | | | | | | | | | This patch adds the missing documentation of variable IMAGE_ROOTFS_MAXSIZE to the reference manual. (From yocto-docs rev: 9a1802e70d37c29da750b1156eea7cce1e123f56) 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: fd9c744d6e73a5719e61a3c0063b1602ca386e91) 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: 2631fc95a6528a5c6f0048087c102e0649afc551) 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: 843078e4bd97a5bedf121e0e0105fd20162a25d8) 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: 0e25bd749ad546b20083a71df0936a248e2bfaec) 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 5.1.2Lee Chee Yang2025-02-122-0/+313
| | | | | | | | | | (From yocto-docs rev: a61a3a32fad3b28dd69dda36ef8f4bcf5c3d0b0b) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 41cc5d8de37b28df0a881e7684c237876aa0b69b) 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: 9cdb6172951781f28ef95fefe27230999b71ebde) 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>
* ref-manual/faq: add q&a on systemd as defaultAntonin Godard2025-02-121-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: 57bbeec169f4d5ed2780cb008b6ff8a6a4b881e9) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 110690bee14f7263a5a34145e91e4450ec3bf4e6) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* documentation: Fix typo in standards.mdSimon A. Eugster2025-02-121-1/+1
| | | | | | | | | | (From yocto-docs rev: 3c2a8865df7dd357d7aff604041d2c336c637df5) Signed-off-by: "Simon A. Eugster" <simon.eu@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit e6745669cc26de8f61d5d1ccdd5a95b552eece97) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* 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: 2df1f56e4863354f05a352d4f61cc797d85100db) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit caedbca4eced4cf5bc74aaae64e4ad2887c2fc65) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* 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: eb44bae3071b751820a6564f31a50ec1bfde5e42) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 411b18e489a97ea4cde05613cdd4c86deb0cb8cb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* sdk-manual: extensible.rst: devtool ide-sdk improveAdrian Freihofer2025-01-291-59/+151
| | | | | | | | | | | | | | | | | | | | | | | | The devtool ide-sdk section is reformulated to be independent of the eSDK installer. In fact, ide-sdk does not even support the execution of an installer-based setup. This reformulation is also a preparation for moving the devtool documentation to a dedicated devtool section which is independent from the eSDK documentation. It should be clarified that devtool ide-sdk starts the SDK directly from the bitbake environment. It is therefore an alternative to bitbake -c populate_sdk_ext and installing an SDK installer. A warning is added that explains some workarounds for some nasty behavior of VSCode when running it in a bitbake environment. (From yocto-docs rev: 82e396d539febc3c730af48e0f8836540fadd1e4) 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> (cherry picked from commit 287817f33688d61f7a71c056bfa5c645edb4fc4e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* test-manual/reproducible-builds: fix reproducible linksAntonin Godard2025-01-291-6/+2
| | | | | | | | | | | | | | We don't run reproducible-builds on specific distros anymore, but on a distro at random depending on what is available on the Autobuilder. Fix the link to this builder and remove distro specific ones. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 7513b4485c08cf5e9b0c0299599e944ce1139313) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 8bd2bc3c00ca80f4c000a2a8d618a9f8ea3aa54b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* Update autobuilder URLs to valkyrieAntonin Godard2025-01-295-8/+7
| | | | | | | | | | | | | | | | | | We have moved to Valkyrie which is hosted on https://autobuilder.yoctoproject.org/valkyrie. Update the URL in the documentation. Also, the YOCTO_AB_URL macro was used in a single location in the documentation so replace it by the :yocto_ab: custom extlink and remove the macro. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 5fef9b01360faa07d0c8a6a2281caf1ba943e0a0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 0b0ed55d909dd11cdc9b29b105473271627c025e) 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.6Lee Chee Yang2025-01-292-0/+224
| | | | | | | | | | (From yocto-docs rev: a17287f76bb05aeebbe0b684d4b4a36137c500f9) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6a22014cd1a7b147d352640088d3b8b724547ac6) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: move runtime-testing section to the test-manualAntonin Godard2025-01-0910-26/+29
| | | | | | | | | | | | | | | In the same fashion as the previous commit ("ref-manual/packages: move ptest section to the test-manual"), move the runtime testing section of the development tasks manual to the test environment manual. Add a link to it from the test-manual/intro document. (From yocto-docs rev: 8ac3e2eb1dd4149b24af03666813dc6d94df466d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6b44257874858db3aa426d3e84a79c41cb4937a3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/packages: move ptest section to the test-manualAntonin Godard2025-01-0910-117/+126
| | | | | | | | | | | | | | | | [ YOCTO #15106 ] It makes more sense to document ptests in the test-manual. Since ptests are still related to packages, keep a link to ptests from packages.rst to the test-manual. Reported-by: Yoann Congal <yoann.congal@smile.fr> (From yocto-docs rev: b79d1c8d501418d20c024c92b0ace755dd6b1c88) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit b389c06b709e4791e1cce5e8a5b58f6b0cd03a14) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* SSTATE_MIRRORS/SOURCE_MIRROR_URL: add instructions for mirror authenticationAntonin Godard2025-01-091-0/+53
| | | | | | | | | | | | | | | | | | | | | [ YOCTO #15218 ] There are different ways of configuring the build host when authentication to a mirror (SSTATE_MIRRORS or SOURCE_MIRROR_URL) is required. Document these methods, and begin with the preferred approach which is to edit ~/.netrc appropriately. When that is not possible, specifying the credentials from the URL is also possible, so document it as well. Reported-by: peter.zsifkovits@at.bosch.com Tested-by: Antonin Godard <antonin.godard@bootlin.com> # Debian 12 container (From yocto-docs rev: fbe43aaa28bd0e0ec3884595e07d5d4c59116fb5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 4c303cce0627e0f2ce52e72597541e220585aaed) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/devtool-reference: add warning note on deploy-target and shared ↵Antonin Godard2025-01-091-0/+20
| | | | | | | | | | | | | | | | | | | | | | | | objects The command `devtool deploy-target` does not handle any dependency of the application, even when properly listed in DEPENDS or RDEPENDS. While the current documentation was clear on that, it felt needed to add a note on the fact that build-time dependencies may also result in runtime dependencies, especially for people new to the project. Add a warning block below the existing deploy-target documentation. Also, link to the Overview and Concepts page, which explains it thoroughly. [ YOCTO #14377 ] Reported-By: Robert Berger <pokylinux@reliableembeddedsystems.com> (From yocto-docs rev: 018df90485f4ae9312a61885f52cade6d863e3b4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 56c84004daad5f8a5db53e36852331435d57c8af) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide/submit-changes.rst: suggest to remove the git signatureAntonin Godard2025-01-091-0/+7
| | | | | | | | | | | | | | By default when sending patches Git adds the git version at the bottom of the patch, which is not necessary in most cases. Suggest to remove it when configuring Git when sending patches. Suggested-By: Jaekyu Lee <jaekyu.lee@lge.com> (From yocto-docs rev: 8ce5875766008827de7bc9bcf8ee5417d557abcb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit d3465691231f10466703198a831a681803ffdfad) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/qa-checks: remove patch-status-core/patch-status-noncoreAntonin Godard2025-01-091-6/+2
| | | | | | | | | | | | | | | | These QA checks were merged as "patch-status" after commit 61a881fdbe8b5a21c6276b8a5d06cc30486b1eb3 ("insane: Improve patch-status layer filtering") in OE-Core. [ YOCTO #15345 ] Reported-By: Diego Sueiro <diego.sueiro@arm.com> (From yocto-docs rev: 39f5d3d1bfb087ea3a736e9a34829ec45bc7bd13) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 3f3a9f53fea6c7d533b9e999dc959dcc3bed7745) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* reproducible-builds.rst: show how to build a single packageTrevor Gamblin2025-01-091-7/+15
| | | | | | | | | | | | | | | | | | Add a bit to the "Can we prove the project is reproducible?" section to show how OEQA_REPRODUCIBLE_TEST_TARGET can be used to test a single package (rather than the world build), as this may be useful for maintainers. [YOCTO #15619] (From yocto-docs rev: 0c1ca2bd6de4cf98a91fbbec9524e08682739487) Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit c4bc09f61621938086be377653121d6b4e62b570) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual/bmaptool.rst: simplify and fix instructionsMichael Opdenacker2024-12-261-5/+4
| | | | | | | | | | | | | | | | | | | | | - Remove duplicate instructions - Detail how to run bmaptool directly if you installed it on your host instead of building it through the ``bmaptool-native`` recipe, as running "oe-run-native bmaptool-native bmaptool ..." won't work in this case. - Use "chmod a+w" instead of "chmod 666", better advice, and only run "chmod" in the option that runs "oe-run-native" (From yocto-docs rev: 8e6b07ffcc3aacee2244e064e09c27418017e414) Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 4afa71ef6e5bf1db126c80e6d987f588d0b5a086) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual/bmaptool.rst: correct command for bmaptool-nativeMichael Opdenacker2024-12-261-1/+1
| | | | | | | | | | | | | | | | | | | Using only "bitbake bmaptool-native", running "oe-run-native bmaptool-native bmaptool ..." fails as follows: Error: Have you run 'bitbake bmaptool-native -caddto_recipe_sysroot'? Running the "bitbake bmaptool-native -caddto_recipe_sysroot" target is actually sufficient. (From yocto-docs rev: 8c08d627127866194aea1ca19b1e4055fe5e7b9f) Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 72fe904a3bbb5e2c7279ab1f119c2beca200dcf2) 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-07-08 00:07:12 +0000