summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual/structure: document the auto.conf fileAntonin Godard2025-10-031-0/+9
| | | | | | | | | | | | Add documentation for auto.conf, which is used by external tools for automatically setting variables. (From yocto-docs rev: 707b29352838792c635b39c8b5c20c519b10b832) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 134e54a75e0144c4629f702c6f43e92ed1f12dce) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: fix the description of KBUILD_DEFCONFIGAdam Blank2025-10-031-2/+1
| | | | | | | | | | | | Remove some leftover confusing mention of KMACHINE. (From yocto-docs rev: 972f61f12f2b33fc518cf8c3e3da5bf71e1b1cb9) Signed-off-by: Adam Blank <adam.blank.g@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 582ee9e0b4930aea03255542b3d3913df19af8b0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: expand IMAGE_OVERHEAD_FACTOR glossary entryJoao Marcos Costa2025-09-191-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | There's a (second) overhead factor applied in images generated with Wic, and this is already documented in the .wks reference. However, the IMAGE_OVERHEAD_FACTOR entry does not mention it, and by looking at the partition sizes (e.g. with parted) one may find it confusing that they don't match with the expected rootfs size (e.g. in a scenario where the extra space is "0" and IMAGE_OVERHEAD_FACTOR="1.0"). This second overhead is already documented, though: https://docs.yoctoproject.org/ref-manual/kickstart.html#command-part-or-partition Mention the '--overhead-factor' option in the glossary entry and add a reference to the wks documentation. (From yocto-docs rev: 71a3933c609ce73ff07e5be48d9e7b03f22ef8d7) Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit b9040e20b015e9b02683ec3014e4ade5eb59d41a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/classes.rst: document the testexport classAntonin Godard2025-08-181-0/+16
| | | | | | | | | | | | | This class has been in OE-Core for a while but never documented in the reference manual. Add some description for it and link to the existing documentation on it. (From yocto-docs rev: 1576091585f8ffdcadd8b8eee525614ab16b6fa0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 362a331255525fc853dab3af4ec905c417fabb0b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document SPL_DTB_BINARYAntonin Godard2025-08-182-0/+8
| | | | | | | | | | | | This variable is part of uboot-sign but not documented. (From yocto-docs rev: 1a07897a273867b4cf26759e88e423c552a09c4a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 05eb461cb1da76ad9cbaf634da7f47447b3f6765) [fix minor conflicts in classes.rst] Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document the FIT_CONF_PREFIX variableAntonin Godard2025-08-181-0/+4
| | | | | | | | | | | | Added by commit 7892ee3dc37d ("kernel-fitimage: allow overriding FIT configuration prefix") in OE-Core, but never documented. (From yocto-docs rev: cb410326e2093fd3bbfe4417c9d73ba0d379df7d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 860891492b96eb127af5e7bab6348fca12167c68) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/system-requirements.rst: update supported distributionsAntonin Godard2025-08-181-19/+48
| | | | | | | | | | | | | | | | | Update the distributions to match the list of workers on the Autobuilder. This list was generated with the help of yocto-autobuilder-helper/scripts/yocto-supported-distros. Also: - Sort the lists alphabetically. - Fill the second list with EOL distros still running on the Autobuilder. (From yocto-docs rev: 207477ddfead183f9df06215b1acb453138708cb) 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-091-0/+21
| | | | | | | | | | | | | | This variable controls the kernel module spliting. [YOCTO #15771] (From yocto-docs rev: 9de9f17abfc6ee11ffa599e45eff8bafd6de801c) 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: 84ab43b9766e0415e090c6af404ce1c61316f384) 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: c2e814ba75524225390ecad0d3615e48f866374a) 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: 5a35f8bd19cca200c6b271f049fb94543de79f06) 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: 5c9336284c0664e0d56cf602751a9ffef6303002) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Steve Sakoman <steve@sakoman.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document INHIBIT_UPDATERCD_BBCLASSAlper Ak2025-05-281-0/+19
| | | | | | | | | | | | Fix [YOCTO #15753] (From yocto-docs rev: 76a4dd5ce041b38f4cab714017a38b035d9530a3) Signed-off-by: Alper Ak <alperyasinak1@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 5f5a406d4acdfcbf655ac014d0d2807056f95291) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document SSTATE_SKIP_CREATIONEtienne Cordonnier2025-05-281-0/+20
| | | | | | | | | | (From yocto-docs rev: 3ff58cc9f3dd200054d241284e183d531502eca4) Signed-off-by: Etienne Cordonnier <ecordonnier@snap.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 3982720668aafa18c9ed27304d09f896740b1653) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document INHIBIT_DEFAULT_RUST_DEPSAlper Ak2025-05-281-0/+17
| | | | | | | | | | | | Fix [YOCTO #15755] (From yocto-docs rev: 064472cef81212d9731b10161b8118de314191e1) 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-05-281-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: 215796836549ae31ef8a9f4f2421316d20d4e3c3) Signed-off-by: Christos Gavros <gavrosc@yahoo.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 07bcdddaf71c76cdec186cf0ddd97a47eec54972) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document the IMAGE_ROOTFS_MAXSIZE variableChristos Gavros2025-05-281-0/+30
| | | | | | | | | | | | | | | | | 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: ca56f1002f8d198c0626e87412f33906e13a2761) Signed-off-by: Christos Gavros <gavrosc@yahoo.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit f3ddc92081363aa7ef7d4fc2c3b918f32f7bda05) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* sphinx-lint: unbalanced inline literal markupTrevor Woerner2025-05-285-8/+8
| | | | | | | | | | | | | | Fix as many instances of unbalanced-inline-literals-delimiters as reported by 'make sphinx-lint' as possible. Sphinx and/or its linter seem to get tripped up randomly when references contain links to heading which contain literals enclosed in double-back-tics, and not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 2c1e5b080ad5e62d8283d332cbc473fd2d59c6e6) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* sphinx-lint: role missing opening tag colonTrevor Woerner2025-05-281-1/+1
| | | | | | | | | | Fix all instances missing-space-before-role as reported by 'make sphinx-lint'. (From yocto-docs rev: 255bfc8c195bbc84a78a4985cf2775c87e525794) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document WIC_CREATE_EXTRA_ARGSTrevor Woerner2025-05-281-0/+14
| | | | | | | | | | | | | Fixes [YOCTO #15509] Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 8e893cc8cabba4b4f21556561d1ca9656ca1ff9f) 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>
* ref-manual: kernel-fitimage.bbclass does not use SPL_SIGN_KEYNAMEAdrian Freihofer2025-05-281-1/+1
| | | | | | | | | | | | | | The kernel-fitimage.bbclass uses the UBOOT_* variables. The SPL_* variables are handled by uboot-sign.bbclass. (From yocto-docs rev: 1383a1fac59b9aa02bde2a0c63a6f480807492e1) 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-281-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: b60476dd7b056d7b5dd48ac7fce943b4e3542277) 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>
* Fix dead links that use the DISTRO macroAntonin Godard2025-05-022-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: 0d51e553d5f83eea6634e03ddc9c7740bf72fcea) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 29be069ebbf2c55d72fc51d99ed5a558af37c05e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/variables.rst: document autotools class related variablesAntonin Godard2025-05-021-0/+17
| | | | | | | | | Document the AUTOTOOLS_SCRIPT_PATH and the CONFIGURE_SCRIPT variables. (From yocto-docs rev: f7721ff5312b1ebf87dd374db22b254913879ff0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: don't refer to poky-lsbRoss Burton2025-03-081-1/+1
| | | | | | | | | | | | | This was removed in 2019, so swap it for poky-altcfg. (From yocto-docs rev: 9b4c36f7b02dd4bedfec90206744a1e90e37733c) 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-081-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: 6001f1baa513566639abee86376dc72748f3cd34) 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>
* vulnerabilities/classes: remove references to cve-check text formatMarta Rybczynska2025-02-281-1/+1
| | | | | | | | | | | | | 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: 9798689e4f4b74163c2e8594f3d1ce082d295aa1) 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>
* Update autobuilder URLs to valkyrieAntonin Godard2025-01-241-1/+1
| | | | | | | | | | | | | | | | | | 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: 66db484f51bc60e87d41bd5ad9d852e3ac44a1b2) 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>
* ref-manual: move runtime-testing section to the test-manualAntonin Godard2025-01-095-20/+20
| | | | | | | | | | | | | | | 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: 3128bf149f40928e6c2a3e264590a0c6c9778c6a) 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-095-6/+5
| | | | | | | | | | | | | | | | [ 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: 8b6ada020d595d86c7bbe78a27b7a6301715b039) 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: e0f88c9595a084244691c6c6aee8d95ce29602fc) 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: daf514d81d08e01657ff2dc171a0afb56753dfc6) 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>
* system-requirements: update list of supported distrosAntonin Godard2024-12-161-14/+6
| | | | | | | | | To match the list in meta-poky/conf/distro/poky.conf. (From yocto-docs rev: 802677ea3ef7b6c1ed43c71f7f33489288c0735a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* Gather dependencies in poky.yaml.inAntonin Godard2024-12-161-9/+13
| | | | | | | | | | | | | | | | | | | We used to have packages here and there in system-requirements.rst for each distro. Instead, gather all the dependencies in poky.yaml.in so we have an overview of what we provide for each distro. Use yaml ">" to list the dependencies in alphabetical order, one entry per line, which makes them easier to read and compare among distros. Rename UBUNTU_… variables to UBUNTU_DEBIAN_…, since these are used for both distros. (From yocto-docs rev: 580b410c535f3b24f901cdbf011bf817038ba4c3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1ed6118b7cf1b5dcbfca753c83fa30fb97bf44ad) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: use standardized method accross both ubuntu and debian for ↵Guénaël Muller2024-12-161-0/+17
| | | | | | | | | | | | | | | | | | locale install Modify locale installation method to be standard accross all debian-based distributions. Pre-existing method is available only on Ubuntu, locale-gen tool has no parameter in Debian. (From yocto-docs rev: 057f2fbce22fc020bef7d432275e28227895e022) Signed-off-by: Guénaël Muller <guenael.muller@smile.fr> Reviewed-by: Yoann Congal <yoann.congal@smile.fr> 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> (cherry picked from commit 30002019198a168e48537407bb928facb26af82a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: classes: fix bin_package descriptionAntonin Godard2024-12-091-17/+28
| | | | | | | | | | | | | | | | | | The previous bin_package description was confusing: it would instruct to use the git fetcher to extract the content of an RPM package using the `subpath` option - but that's not possible as the git fetcher can be used to clone a repository but not to do the extraction. Update the description by telling what it really does and what it doesn't do, and by giving an HTTPS+RPM example. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: e201ee883c152555ef4c9bd3fa31c3eb96f6dc2f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 305f024bf99ba02b153eed0cebe3d36594868497) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: variables: add SIGGEN_LOCKEDSIGS* variablesJulien Stephan2024-11-111-0/+44
| | | | | | | | | | | | | | | | Variables SIGGEN_LOCKEDSIGS, SIGGEN_LOCKEDSIGS_TASKSIG_CHECK and SIGGEN_LOCKEDSIGS_TYPES are used to lock specific tasks to specific signatures. They are used by bitbake -S <lockedsigs> and bblock, so add documentation for them. (From yocto-docs rev: 1f61cd4a3e9c5bf75910559ddf2372f921c2a4ef) Signed-off-by: Julien Stephan <jstephan@baylibre.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 32e3995bed2836f549866ec3b8ad254bdda37dbf) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add description for the "sysroot" termMichael Opdenacker2024-11-111-0/+25
| | | | | | | | | | This term is used throughout the manual but is not properly introduced anywhere. (From yocto-docs rev: ced1bbb88a8046b1307376cd88ea85110677c9fc) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: devtool-reference: document missing commandsAntonin Godard2024-11-111-1/+31
| | | | | | | | | | | | | | | Give a brief description for important commands that made it into devtool or that were missing from this quick reference document. Cherry pick: Remove devtool ide-sdk from commit, this command was not backported to kirkstone. (From yocto-docs rev: 8a5111c406be9c4bf1cc78a34dd2174a227ca79c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6238adae1b072c9e09c558038d397dfac6ec109f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: devtool-reference: refresh example outputsAntonin Godard2024-11-061-11/+7
| | | | | | | | | | | | Previous outputs were missing some commands and options, some others were obsolete. (From yocto-docs rev: e3245843543361f8eeda0fcc583fb3f7a36eaeb5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1c83037707b4c981a70c968ba04ded502f9bffbf) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: release-process: add a reference to the doc's releaseAntonin Godard2024-11-061-0/+2
| | | | | | | | | | | | | | When reading the stable releases section, we want to know for which release the documentation was built. Use &DISTRO_NAME; to refer to the current release. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 0f21321d8b30478ed07f0387f4b88cd0a5c03fd1) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 05ee6844d710beb844bbdac892888879847f6d22) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: release-process: update releases.svg with month after "Current"Antonin Godard2024-11-061-9/+9
| | | | | | | | | | | | | | | | This way we put a timestamp on the image, so that someone looking at the image on an old release tarball has a representation of the release "as of <date>". Here set "Oct. 24" as it was the last time the file was updated. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 108b53abd96fa7fd82107de07a46ae77a6f9269f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 7b62bbec900bc84a31e4686839e774ba7bd5ae9f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: release-process: refresh the current LTS releasesAntonin Godard2024-11-021-6/+9
| | | | | | | | | | | | | | Mention that Scarthgap the latest LTS in a bullet list next to Kirkstone. Reword the parapraph a bit to make it clearer after this change. Reviewed-by: Michael Opdenacker <michael.opdenacker@rootcommit.com> (From yocto-docs rev: 23c4ca4fdfffb7793cf4ffaea365e042e1a25325) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit afeded9939777d88bf4cb9ebf7a61aadd476642d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: release-process: update releases.svgAntonin Godard2024-11-021-561/+346
| | | | | | | | | | | | | * Add Walnascar release. * Remove dunfell, gatesgarth, hardknott, honister: these release are not supported anymore. Start from kirkstone, which is still supported. (From yocto-docs rev: 1955aa1052d16a05cc7d493d5e7c0fe113141812) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit aa9a580c8c57af4baa4fb24a43487fb7afc258e5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: structure.rst: document missing tmp/ dirsAntonin Godard2024-10-241-2/+33
| | | | | | | | | | | | | | | | Document `hosttools/`, `pkgdata/` and add some more information on `work-shared/`. Adresses [YOCTO #14543]. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 259fce03ffab9fb588676c1e150d999d54cf6d85) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 372b5b4ca55819c294970b20aa8b8d8167144329) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add missing OPKGBUILDCMD variableAntonin Godard2024-10-241-0/+7
| | | | | | | | | (From yocto-docs rev: 709d952ba834778015b3047f8bafca94b1c814f8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a6a2c8e48995200c9c3be7096f34d912427de145) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add missing EXTERNAL_KERNEL_DEVICETREE variableAntonin Godard2024-10-241-0/+12
| | | | | | | | | | | | | This variable can be used to specify one or more compiled device tree or device tree overlays to use in addition to the one compiled by the kernel. (From yocto-docs rev: 708514ea676246ddf251ad47c95442e8ec5c0e1f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6566ffceab3780dc5ecbfe26f786ebe6ff17e693) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add missing CVE_CHECK manifest variablesAntonin Godard2024-10-241-4/+11
| | | | | | | | | | | | Variables that can be used for toggling creation of manifest and specifying the path to the output in the deploy directory. (From yocto-docs rev: fb462c47bb15522cc02642fe51f39c8e15044957) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 14131a42a7ea8bbae2165c1b8dbcabd5f28b2b22) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: introduce CVE_CHECK_REPORT_PATCHED variableAleksandar Nikolic2024-10-241-0/+6
| | | | | | | | | | | (From yocto-docs rev: a7929332ade42e8511c2f47d200b3b01cb8a8987) Signed-off-by: Aleksandar Nikolic <an010@live.com> Reviewed-by: Michael Opdenacker <michael@opdenacker.org> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> (cherry picked from commit f585a68a8f35f31814e408dd973ea7345adbbacf) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* doc/features: remove duplicate word in distribution feature ext2Jörg Sommer2024-09-271-1/+1
| | | | | | | | (From yocto-docs rev: fa846606014a85154b63794a17ff1d9aacc1a7bc) Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2026-04-22 17:46:15 +0000