summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
...
* variables.rst: add a reference to BB_CURRENT_MC from bbdocsAntonin Godard2025-02-261-0/+3
| | | | | | | | | | | BB_CURRENT_MC is documented in the Bitbake user manual. Add a reference to it here. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: a9aaef86bf76027f602546b5d4a3dffc6168d9b4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: move multiconfig documentation to its own documentAntonin Godard2025-02-263-154/+163
| | | | | | | | | | | In preparation of more section and examples to multiconfig, move the section about it in building.rst into its own document. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 6f60fb09976540dd320816684684c14f6b7ab460) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* vulnerabilities/classes: remove references to cve-check text formatMarta Rybczynska2025-02-262-29/+69
| | | | | | | | | | | The text format has been removed, so also remove references and examples using this format. Replace with examples with the JSON format. (From yocto-docs rev: a52cd7bcadccc53e982f90d6e170d00798322597) Signed-off-by: Marta Rybczynska <marta.rybczynska@ygreky.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add missing variable IMAGE_ROOTFS_MAXSIZEWeisser, Pascal2025-02-261-0/+6
| | | | | | | | | | | | This patch adds the missing documentation of variable IMAGE_ROOTFS_MAXSIZE to the reference manual. (From yocto-docs rev: 1dcc8cf7c49da449b324a7bd6bb22effe1d53d70) Signed-off-by: Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-5.2: Add new variable OEQA_REPRODUCIBLE_TEST_LEAF_TARGETSYoann Congal2025-02-261-0/+4
| | | | | | | | | | | | Add mention of OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS to release-notes-5.2 to users can use it after upgrading. (From yocto-docs rev: eec44e4daf414be414e9fd0471b0381b980d6fab) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* reproducible-builds: add a "How to" section with OEQA* variablesYoann Congal2025-02-261-0/+20
| | | | | | | | | | | | | Shows an example of the new variable OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS and still mention OEQA_REPRODUCIBLE_TEST_TARGET/SSTATE_TARGETS that were shown earlier. (From yocto-docs rev: 78cf8b1ff1cdfbc863033f267da8fb60419b50fc) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* reproducible-builds: change/add titles in the "How" sectionYoann Congal2025-02-261-3/+9
| | | | | | | | | | | This is preparation work for the following commit. (From yocto-docs rev: 0ff459c273704a281419a44ae5670068ac47f1b9) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: document OEQA_REPRODUCIBLE_TEST_LEAF_TARGETSYoann Congal2025-02-261-0/+7
| | | | | | | | | | | | This documents the variable used in the "automate testing a single recipe's reproducibility" feature [YOCTO #15701] (From yocto-docs rev: 417b423ea3d2ba9903d21d930c1982ff2ac6f596) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 5.0.7Lee Chee Yang2025-02-182-0/+333
| | | | | | | | (From yocto-docs rev: 9f1f9f1a3a2a541ed70df72d4fe391b5b7fd3733) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add favicon for the documentation htmlAntonin Godard2025-02-182-0/+1
| | | | | | | | | | | Import the favicon from https://www.yoctoproject.org/, convert it to 16x16 (as per the Sphinx documentation) to make a 1291B image of the Yocto logo. (From yocto-docs rev: e3ee43e6d70685a2404aae2d60557a42879b0bb1) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide/submit-changes: add policy on AI generated codeAntonin Godard2025-02-181-0/+49
| | | | | | | | | | | | Based on message by Richard Purdie on the yocto-docs list: https://lists.yoctoproject.org/g/docs/message/6300 Re-formatted for the Yocto Project documentation syntax. (From yocto-docs rev: a72dd13e6841b621c9e8f904dfaa440c186d2959) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* tools: add script for building documentation inside containersQuentin Schulz2025-02-188-0/+262
| | | | | | | | | | | | | | | | | | | | | | | | This adds a script for building a container and building the documentation within that new container image. The openSUSE instructions now require a --non-interactive flag otherwise they fail to run. Sadly there doesn't seem to be a way to have this in an environment variable à-la DEBIAN_FRONTEND=noninteractive, so we simply do a sed on the scripts to add --non-interactive to the zypper commands to avoid having those in the instructions provided to our users. Somehow tzdata package in Ubuntu doesn't respect DEBIAN_FRONTEND=noninteractive hence why the timezone needs to be set by hand. (From yocto-docs rev: cefced592f1302fcb65afa9e0b1f9f5ff1570e93) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Tested-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: use literalinclude for system requirementsQuentin Schulz2025-02-1815-269/+65
| | | | | | | | | | | | | | | | | | | | | | | The YAML variables for the host dependencies are updated by hand and actually only used inside code blocks. Let's migrate all instructions into separate shell scripts that are then literalinclude'd into the Sphinx documentation. This allows a few things: - ability to run shellcheck on the scripts if we ever want to - manually calling the appropriate script from a supported distro to build stuff (distro or bitbake/yocto stuff) - use this script to create containers to do CI of documentation on different distros, to make sure our instructions are all up to date, (From yocto-docs rev: 8d993022c2aefc0fde9baa949d39d7a3613f9f46) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Tested-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-5.2: add virtual provider changeAntonin Godard2025-02-071-0/+35
| | | | | | | | | | | | | | The commit 4ccc3bc8266c ("classes/recipes: Switch virtual/XXX-gcc to virtual/cross-cc (and c++/binutils)") in OE-Core changes the virtual/XXX-gcc to virtual/cross-cc (and c++/binutils) syntax. Add it to the migration manual. (From yocto-docs rev: 6eda443c7fcfeecebd6b44b96a1587c4bb093a34) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-5.2: document BB_CURRENT_MC default value changeAntonin Godard2025-02-071-0/+11
| | | | | | | | | | | | | After commit 0fa0d8d764bb ("cooker/cache: Drop mc 'default' string value") in Bitbake, the default value of BB_CURRENT_MC was changed from "default" to an empty string. Document it. (From yocto-docs rev: efbd8fa30a5cc42d5243aa87e00e2d92cb265adb) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 5.1.2Lee Chee Yang2025-02-072-0/+313
| | | | | | | | (From yocto-docs rev: ba80f0cdeea9e2e3bbfecfeae8c3be9a2cb36297) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 4.0.24Lee Chee Yang2025-02-072-1/+384
| | | | | | | | (From yocto-docs rev: 57f92aebc14c45bd73bb0b730bdbf6526e7e5546) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Describe grub-efi-cfg overrides and GRUB_TITLESimon A. Eugster2025-02-072-0/+21
| | | | | | | | | | | | | This patch describes how to use overrides for grub-efi-cfg because that is otherwise only clear after reading the .bbclass file. It also adds a description for GRUB_TITLE. (From yocto-docs rev: b9ec7d124c9cbaf6c05415277fa028a39ce9e02f) Signed-off-by: "Simon A. Eugster" <simon.eu@gmail.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/faq: add q&a on systemd as defaultAntonin Godard2025-02-071-0/+22
| | | | | | | | | | | | Originally written by Richard Purdie, but formatted in rst syntax and slight rephrasing. Cc: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 568922014e5c00ecf0c3d19b8c7fefa0e3801183) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/devtool: remove reference to the extensible SDKAntonin Godard2025-02-071-10/+5
| | | | | | | | | | | | | | | There were leftover references to the extensible SDK after moving the devtool documentation from the Extensible SDK document to its own devtool document. This patch follows the bulk move to make it clear what was modified in the document. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 032d2f3297ff4b5ee4e000b3dd0748a58b5f32e0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Move devtool doc from extensible to dev manualAntonin Godard2025-02-0713-1327/+1338
| | | | | | | | | | | | | | | | | | | | [YOCTO #13417] devtool is not directly tied to the Extensible SDK anymore, and instructions in there can be split and added to the development manual. This patch is a simple bulk move, except for the following: - Intro added to the devtool.rst document (mostly copy-pasted from the devtool quick reference in the ref-manual). - Figures renamed to remove "sdk-" from filenames. - References to sdk-manual/extensible replaced by dev-manual/devtool. Reported-By: Paul Eggleton <bluelightning@bluelightning.org> (From yocto-docs rev: 044d3185b858fce1febcfe3a6834b883f9a598fa) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/packages: add information about signing changesZoltán Böszörményi2025-02-071-3/+13
| | | | | | | | | (From yocto-docs rev: 6c1a77e5db7ae9910d24deb023619b9391c8b4ad) Signed-off-by: Zoltán Böszörményi <zboszor@gmail.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-5.2: add information about rpm and sequoiaZoltán Böszörményi2025-02-071-0/+4
| | | | | | | | | (From yocto-docs rev: 074592afcba03e932778471c44019623943814fc) Signed-off-by: Zoltán Böszörményi <zboszor@gmail.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fix typo in standards.mdSimon A. Eugster2025-02-071-1/+1
| | | | | | | | (From yocto-docs rev: 9007d7eb63b296aae832028924d89f83dc159992) Signed-off-by: "Simon A. Eugster" <simon.eu@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/building: document the initramfs-framework recipeAntonin Godard2025-01-291-1/+83
| | | | | | | | | | | | | | | | | [ YOCTO #14747 ] Adding a initramfs is a common task, and the way oe-core offers to do so is by using the initramfs-framework recipe and companion modules. There was already documentation on adding an initramfs but the documentation was lacking details on this framework. Add it before the multiconfig section because it is a bit more important IMO. Reported-by: Alejandro <alejandro@enedino.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: caedbca4eced4cf5bc74aaae64e4ad2887c2fc65) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual/ptest: link to common framework ptest classesAntonin Godard2025-01-291-0/+14
| | | | | | | | | | | | | We document how to add ptest support for a recipe by inheriting the ptest class. We may as well tell the user to inherit a ptest class for a common framework which does most of the job for you. Suggested-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 411b18e489a97ea4cde05613cdd4c86deb0cb8cb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: fix spurious parenthesisQuentin Schulz2025-01-291-1/+1
| | | | | | | | | | | | There's no opening parenthesis, so let's remove the spurious closing parenthesis. Fixes: ea638e85316d ("ref-manual/variables: document the KERNEL_CONSOLE variable") (From yocto-docs rev: 6f0e150179db2a2a8e9ad879167e0d84137190dc) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add documentation for the barebox classEnrico Jörns2025-01-292-0/+66
| | | | | | | | | | | | | This adds the initial documentation for the newly added barebox.bbclass to the Reference Manual's class list. It also adds the two most notable variables to the variable list. (From yocto-docs rev: cc8179122441cdc26ff62511dcd97f7bf9bf7e3d) Signed-off-by: Enrico Jörns <ejo@pengutronix.de> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: 287817f33688d61f7a71c056bfa5c645edb4fc4e) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* test-manual/reproducible-builds: fix reproducible linksAntonin Godard2025-01-201-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: 8bd2bc3c00ca80f4c000a2a8d618a9f8ea3aa54b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Update autobuilder URLs to valkyrieAntonin Godard2025-01-205-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: 0b0ed55d909dd11cdc9b29b105473271627c025e) 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.6Lee Chee Yang2025-01-202-0/+224
| | | | | | | | (From yocto-docs rev: a4e242463fee5b4e0194e32ba2ca3c1747af2b60) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-5.2: cover devtool modify --debug-buildAdrian Freihofer2025-01-201-0/+6
| | | | | | | | | (From yocto-docs rev: ef5f35e6da2dcdfad6290ab4d5bfa3010a600caf) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: extensible.rst: remove confusing post-install-loggingAdrian Freihofer2025-01-201-1/+0
| | | | | | | | | | | | | | This is a fix for 22dc5b3be3b1fbdb9447999b71f79db055271826, which has completely replaced debug-tweaks. But in the context of devtool ide-sdk and the comment in the example, the post-install-logging-image feature doesn't really make much sense. Therefore, remove it. (From yocto-docs rev: 148191460627241cbd0c42583140f114c78cc94c) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: extensible.rst: update devtool ide-sdkAdrian Freihofer2025-01-201-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: e2b6a4c6c633e79d0e4975ba2e1a27a8c1b8c1c5) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: systemd.bbclass do not add Also services for 5.2Adrian Freihofer2025-01-201-0/+20
| | | | | | | | | | | | Covers the changes introduced by commit https://git.yoctoproject.org/poky/commit/?id=efa5f65c2214239ed7aaf7bd8998683e755c5660 (From yocto-docs rev: 71acf03e02d1e21a4dbe081e75d1e4383ac2f3ac) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: 6b44257874858db3aa426d3e84a79c41cb4937a3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: b389c06b709e4791e1cce5e8a5b58f6b0cd03a14) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: 4c303cce0627e0f2ce52e72597541e220585aaed) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: 56c84004daad5f8a5db53e36852331435d57c8af) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: d3465691231f10466703198a831a681803ffdfad) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: 3f3a9f53fea6c7d533b9e999dc959dcc3bed7745) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: update the release notes for 5.2Antonin Godard2024-12-282-2/+399
| | | | | | | | | | | | | | Update the release note and migration guide for the 5.2 release. This release is not due until April 2025, but this catches up what has already been applied since 5.1. Precisely, this tracks the important changes between commits 8149e74258 and 87d7341465 in poky. (From yocto-docs rev: a51a94f0b228d570d915dff36a49132e90e93cf1) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: document the PREFERRED_RPROVIDER variableAntonin Godard2024-12-281-0/+22
| | | | | | | | | | This variable is similar to the PREFERRED_PROVIDER variable but it denotes a runtime provider specifically. (From yocto-docs rev: 0b0b58070fceff6851a6e137f7f774e706205b32) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: document the CARGO_INSTALL_LIBRARIES variableAntonin Godard2024-12-281-0/+9
| | | | | | | | | | This variable controls whether libraries compiled by recipes inheriting cargo are installed or not. (From yocto-docs rev: c42f80a12e9e71fa7dab9672fb3174ed006b214b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes: document the yocto-check-layer classAntonin Godard2024-12-281-0/+20
| | | | | | | | | | | This class is used by the yocto-check-layer script to check if a layer complies to the Yocto Project Compatible status. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: b3fd3c268ac3f15e4050a983289fc63e62f4c823) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: document the CHECKLAYER_REQUIRED_TESTS variableAntonin Godard2024-12-281-0/+11
| | | | | | | | | | | This was introduced in oecore by commit ce2e42ace2d15fb6745437cf0a7f07d28398ca12 ("insane: Split ERROR_QA into CHECKLAYER_REQUIRED_TESTS"). (From yocto-docs rev: 5b205e113015430f6d04e455af7c0d5643863fbc) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Drop support for BB_DANGLINGAPPENDS_WARNONLYAntonin Godard2024-12-282-23/+17
| | | | | | | | | | | | | | | Support for this variable was dropped in BitBake, see commit fca9c9e3cb6f8e9f99bf51dc5e8a8d83f4c84c69 ("cooker: Drop support for BB_DANGLINGAPPENDS_WARNONLY"). Drop this variable here as well and rewrite the "Appending Other Layers Metadata With Your Layer" section to advise to rename the recipe and check if the bbappend is still relevant - otherwise to use BBWARN. (From yocto-docs rev: 10b59d09ebfb6c119995643ed68cb26092b6f2a4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Remove debug-tweaks referencesAntonin Godard2024-12-288-30/+29
| | | | | | | | | | | | | | | | | | | | | We no longer provide this feature, so remove documentation for it. In most cases, we can replace occurrences of "debug-tweaks" by "allow-empty-password empty-root-password allow-root-login post-install-logging" to achieve what this feature previously enabled. Subtle, but the default local.conf does not include post-install-logging, so in parts where there is mention of the default local.conf file, adjust the documentation to only mention the first three above. In the intro manual, instead of providing instructions that replace EXTRA_IMAGE_FEATURES entirely, provide ones that append EXTRA_IMAGE_FEATURES. (From yocto-docs rev: f0efd4c7df91863304b92514664bdd1fa62b1fbb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes: document the cython classAntonin Godard2024-12-281-0/+9
| | | | | | | | | | | Small class added in oecore by commit 64b6e8580842949be58f97f4dff91d1f097c4020 ("classes-recipe: add cython class"). (From yocto-docs rev: 0979e02b71b6c91fa27cdeacd70036564fbe1a2d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-07-08 04:22:25 +0000