summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* dev-manual: fix styling of references to bmaptoolMichael Opdenacker2024-12-262-11/+11
| | | | | | | | | | | | | | | | | To follow the styling conventions when we are refering to the name of a tool instead of the command itself (documentation/standards.md). This also improves the HTML rendering of the bmaptools subsection. (From yocto-docs rev: f8bf503b13a53fb0b34c1fdac92d78d66813abfb) 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 c569d840c4b6f43e10629b6f1ff45189211e27a9) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* Update the documentation for SRCPVAntonin Godard2024-12-266-63/+47
| | | | | | | | | | | | | | | | | | | | | | | | The variable SRCPV is deprecated since 4.3. Instead of including SRCPV in PV, including the sign "+" is enough for bitbake to add the source control information to PKGV during the packaging phase. Update the documentation for SRCPV and the places where it was used. When instructions previously referred to SRCPV, replace by mentioning to include "+" in the assignment. In most examples, "+git" is added to PV as it is the most popular SCM. Simply adding "+" is also possible, although it is better practice to include the SCM name, so give that example. Update the gcompat example with l3afpad as it didn't include "+git" in its PV definition anymore. (From yocto-docs rev: 3866c09cc0460d25fefc0c831affd89633cf8a7b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit ee16c96202e5027d1a8d7e89e11c25f127c78326) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* system-requirements.rst: add dependencies for pdf buildsAntonin Godard2024-12-172-3/+76
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | With the recent changes from commit bd6265ca323fac547a197bb516dc4a9ef3897508 ("doc: Makefile: add support for xelatex"), the list of dependencies needs to be updated. The initial list of dependencies was made for Ubuntu/Debian, and the packages were translated for the other distros using pkgs.org. Add them separately from the rest of the dependencies as they pull a _lot_ of additional dependencies (for LaTeX). Move the texlive-fncychap documentation dependency to the PDF specific dependency. Notes: - Fedora/OpenSUSE do not have the "lang-all" texlive collection, so install all available languages. - AlmaLinux does not seem to provide texlive-collection-fontsextra, texlive-collection-lang*, and texlive-collection-latexextra, so add a warning about that. (From yocto-docs rev: 01048d7de570a9d896c5aab294008396e2d78607) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 02c090718ac602f7d4760dd28dadbf0631668d49) 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-171-0/+8
| | | | | | | | | | | To match the list in meta-poky/conf/distro/poky.conf. (From yocto-docs rev: 02de22c04e51e0ca43394b6d5df2adca0068ca1a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit c9c3f6896e4bc967a9b394574532735babb70397) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* system-requirements: add fedora 39 to supported distrosAntonin Godard2024-12-171-0/+2
| | | | | | | | | (From yocto-docs rev: 5236193be5297366f23c930be1bf283956d6d257) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit dc7fd0e56fbfed77975f6b4ed2106331476ef7f3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* poky.yaml.in: replace inkscape dependency by librsvg2-binAntonin Godard2024-12-171-4/+4
| | | | | | | | | | | | | inkscape used to be a requirement to convert SVG images to PNGs/PDFs, but we replaced it recently by rsvg-convert. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: cf161a7e8210ecef884fcd51a5f683f2daf21aeb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 8c0bb4e41c203a0a7a31c2bdc26834d87a83413a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* poky.yaml.in: add missing locales dependencyAntonin Godard2024-12-171-0/+4
| | | | | | | | | | | | | | | | | This is a requirement for building the documentation, otherwise we get (on Ubuntu 24.04): File "/usr/lib/python3.12/locale.py", line 615, in setlocale return _setlocale(category, locale) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ locale.Error: unsupported locale setting (From yocto-docs rev: bfefcc4222cba5e812d3fe3ea4c39a846b3cb69b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 0943a7b67ef0012b5d9badc15e0c579dbb9014ae) 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-173-35/+202
| | | | | | | | | | | | | | | | | | | 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: e365a6d5c59f72f4e6a81a0267cbfcda61502d45) 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>
* docs: update current releasesAntonin Godard2024-12-172-9/+11
| | | | | | | | | | | | | | | | | | | | Remove dunfell and nanbield which are not supported anymore. Add styhead as an active release. Set walnascar as the dev branch. The switcher menu now contains: - Unstable (dev) - Styhead (5.1) - Scarthgap (5.0.4) - Kirkstone (4.0.22) Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 1b62abaadba198627d2a092ffd29046fe9fcf139) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 4c81e2856c268d7d0221ebb6b8156ad65b9e83ca) 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.1Lee Chee Yang2024-12-172-0/+290
| | | | | | | | | | | (From yocto-docs rev: 2b412cb13b3f199b4a67b4d7f4bb01502833cce4) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit db2ff7bbe64e1dca6b0868046f478d7622f79865) 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-172-2/+18
| | | | | | | | | | | | | | | | | | 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: f0a786c185ca4d8fa1e1f2f64e2af5465d9ac4aa) 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>
* migration-guides: add release notes for 4.0.23Lee Chee Yang2024-12-092-0/+210
| | | | | | | | | | (From yocto-docs rev: 59c219067c6e47968d07d1f34ff0530f2411fd11) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 5835cb574881d57785f099c768467177d077e867) 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: 1c60116c666a742838129f0b83007d81f3c0e05d) 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>
* migration-guides: add release notes for 5.0.5Lee Chee Yang2024-12-092-0/+228
| | | | | | | | | | (From yocto-docs rev: a6edb2e6e79ef414754a4deeeb3a940a41ca40c8) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 4175839e718db49bf6971e900c1cf176d03458d7) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: merge two separate descriptions of RECIPE_UPGRADE_EXTRA_TASKSAlexander Kanavin2024-12-091-6/+5
| | | | | | | | | | | | | The second description was added due to confusion over the variable rename in oe-core. (From yocto-docs rev: ff33f7c374c6079af4dc2609e9fb63d705598bc7) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit b64fb34643343b364705df9c3bd64af91ed9d687) 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.4Lee Chee Yang2024-12-092-0/+213
| | | | | | | | (From yocto-docs rev: b59347a137c82832297677d9e7a9247dbb694d56) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* standards.md: add a section on admonitionsAntonin Godard2024-12-091-0/+15
| | | | | | | | | | | | | | | We try to limit our usage of these admonitions to `note` and `warning`, as the Sphinx documentation warns that most themes only style these two admonitions. So add a section on that. Suggested-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 845983eed77f9914994375eff11ea5c9bb690593) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a37bb6cbb67f923206c5c168b5239527530fbce5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: bblock: use warning block instead of attentionAntonin Godard2024-11-261-1/+1
| | | | | | | | | | | | | | Sphinx recommends using warning and note here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives Suggested-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 8288c8cae7fe7303e89d8ed286de91fc26ce6cc3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit ed49067f172637d38d470a864feed2a02bd84c66) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: document how to provide confs from layer.confAntonin Godard2024-11-261-0/+90
| | | | | | | | | | | | | | | | | | | | | | | | Add a section on providing global level configuration from the layer.conf file. Since this file is parsed at an earlier stage in the parsing process, it's not possible to combine bb.utils.contains and {DISTRO,MACHINE}_FEATURES to conditionally set some configurations. This patch documents: - First that this file can be used for providing such configuration. - Then demonstrate how to conditionally provide them, using a technique that is currently used in meta-virtualization (https://git.yoctoproject.org/meta-virtualization/tree/conf/layer.conf#n50). Fixes [YOCTO #12688]. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: b73e99b161a11a46a1a96ff42135893e0c978e2a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 31e5bd3e82e11f77da2abd96eb8c17a7c8194b7c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* conf.py: add a bitbake_git extlinkAntonin Godard2024-11-261-0/+1
| | | | | | | | | | | | | To make references to the bitbake repo, add an extlink for it and use it in the docs with ":bitbake_git:`lib/bb/utils.py </tree/lib/bb/utils.py>`". Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 5efb5f678278276aebd6809ab785dcea8c732de3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 8bf3c656ec54a582c75ca7c135121a15f8e4f631) 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-04-22 20:52:47 +0000