summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual/packages.rst: fix example recipe versionAntonin Godard2026-02-121-4/+4
| | | | | | | | | | | | The example recipe taken above is hello-world on version 1.0 (because PV equals "1.0+git". Fix this issue. (From yocto-docs rev: a48ab61034d50be1026b939112f4a5c58bed7b88) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 411122812ced4ec32127a823896a73aacf6eb97c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/packages.rst: rename r0.0 to r0 when PR server is not enabledAntonin Godard2026-02-121-2/+2
| | | | | | | | | | | | When we don't have a PR server enabled, we don't have leading ".0" to the PKGR variable, as this is added by the PR server. (From yocto-docs rev: 4c64db73fa68b6dbc11fe4b64452b0d6b7ee0280) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 7a0324b6a10e64ee250945747db10ca88040b1ce) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/packages.rst: pr server: fix and explain why r0.X increments on ↵Antonin Godard2026-02-121-1/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | SRCREV change The current example of the SRCREV change triggering a gitX bump is wrong, as both gitX and r0.X get incremented. Why this is happening is explained in bug 15729, which I copy here: > +gitX+ is indeed related to changes in the source code. > > r0.X is bumped each time the checksum of the do_package task of the > simple-hello-world-git recipe changes. This happens here: > https://git.openembedded.org/openembedded-core/tree/meta/classes-global/package.bbclass?id=235e6d49e5888ad04416219e10b6df91a738661a#n306 > > This line sets the value of PRAUTO and represents the number X found in > r0.X. It will in the end make it into EXTENDPRAUTO, which itself makes > to PKGR == r0.X. > > This line calls getPR(version, pkgarch, checksum). Between test case 5 > and 6, only the checksum changes. This checksum is the checksum of the > do_package task (gotten from get_do_package_hash() above). > > Now, let's dump what changed with regards to this task between two > consecutive runs, using the sigdata file in build/tmp/stamps/: > > ``` > [...] > Variable fetcher_hashes_dummyfunc value changed from '2650ad6714c3f3248abfe9d3daf1196f307ed494' to '4af682a50174f5deb0397847da97d7cdba4ad067' > ``` > > The last line shows that the value of fetcher_hashes_dummyfunc changed > from '2650ad6714c3f3248abfe9d3daf1196f307ed494' to > '4af682a50174f5deb0397847da97d7cdba4ad067'. Those are the commit hashes > in the git history of the simple-hello-world-git repository. > > Now you can see why this 0.X gets bumped, is because of the SRCREV change. Fix the example, and detail what gets changed and why. [YOCTO #15729] Cc: Robert Berger <pokylinux@reliableembeddedsystems.com> (From yocto-docs rev: 8d7b549d095c2ca04d4c7ff5a92f6de9fceb8496) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 09f0430bc69024b9854c31ba6783ddd807aa4f19) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add a new "Security" sectionAntonin Godard2026-01-262-195/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The current security-related documentation is a bit hard to find and hidden within the development manual. However these are processes that are not part of a development task but is rather a vulnerability reporting process. Create a new "Security" section in the documentation to gather this information. This will be directly visible in the sidebar when opening the documentation. Split the previous security-subjects.rst document into 2 documents: - security-team.rst: defines the roles of the security teams and its members. - reporting-vulnerabilities.rst: guide to report vulnerabilities to the security team. The plan is to backport these documents to active releases. As a consequence, this section should be free of instructions and information that only make sense for a specific release. It should _not_ contain documents on how to enable security features with Yocto on target devices, this is unrelated and can be left in the development manual (for example: dev-manual/vulnerabilities.rst to deal with CVEs). (From yocto-docs rev: 3fd0f37d708d88534dd6dbb51dc264911c349352) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 81e14ca2d5cff9e2104c556655144b069633790c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: link to the Releases page on yoctoproject.org instead of wikiRoss Burton2025-11-193-9/+8
| | | | | | | | | | | | | | | We have a machine-generated Releases page[1] which is preferable to the wiki. [1] https://www.yoctoproject.org/development/releases/ (From yocto-docs rev: 492619059cbbe2d1ebc347c3e86072f32d7d064a) Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 46a9172fd17aa518028e35b8c874e74889079094) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: debugging: use bitbake-getvar in Viewing Variable Values sectionQuentin Schulz2025-11-191-14/+20
| | | | | | | | | | | | | | | | | | We should recommend using bitbake-getvar command wherever possible as its output is much less confusing and overwhelming than bitbake -e. Unfortunately, bitbake-getvar currently doesn't list Python tasks or functions, unlike bitbake -e, so keep the latter for some corner cases. [AG: Moroever -> Moreover typo fix] (From yocto-docs rev: 382c8eee275eb4773d4e2183f5fe19837a6a3b0b) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 41e4e05369c4e028c679749b7b62434327927a09) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual/new-recipe.rst: typo, "whith" -> "which"Robert P. J. Day2025-11-191-1/+1
| | | | | | | | | | | | Fix typo "whith", should be "which". (From yocto-docs rev: 1a54d05d8bd5484e17cbc060fc57fd2f7afb683f) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit f98b25f7f7522cf223beb001cabef870d6dd8c10) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual/new-recipe.rst: replace 'bitbake -e' with 'bitbake-getvar'Robert P. J. Day2025-11-191-2/+2
| | | | | | | | | | | | | | Replace the legacy call to 'bitbake -e' to get the value of a recipe's variable with the newer call to 'bitbake-getvar'. (From yocto-docs rev: d7ef362307daf2e8d9b62ec895e080654abfef8b) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit ed7c0766ef5f13b90943a69e64f8e8713d05e864) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual/layers.rst: document "bitbake-layers show-machines"Robert P. J. Day2025-11-191-0/+2
| | | | | | | | | | | | | | The "show-machines" subcommand is not mentioned in the docs; add it. [AG: fix conflicts] (From yocto-docs rev: 09bbdc6bc5f9ae77f120185d1324f1166ac1f9d5) Signed-off-by: Robert P. J. Day <Crpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit b4320cdc4df08c59a24d5247b3895dd602554fa0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual/new-recipe.rst: update "recipetool -h" outputRobert P. J. Day2025-11-191-11/+12
| | | | | | | | | | | | | Update the output of "recipetool -h" to include the missing "edit" subcommand. (From yocto-docs rev: 2a85eab0c51a78ab00168e23274d479cf3aedb24) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 092d688349b0b6bb10ae6fbbab7d82801964daf5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual, test-manual: Update autobuilder output linksPaul Barker2025-10-311-1/+1
| | | | | | | | | | | | | The current autobuilder cluster is at valkyrie.yocto.io, published files on autobuilder.yocto.io will be missing or out-of-date. (From yocto-docs rev: 5cccf2e65b85c52cb9b9fd22d46ebde6d624fbe5) Signed-off-by: Paul Barker <paul@pbarker.dev> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 9ed06c070e309b52f1dbf8877867dcede79f4cb6) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* vulnerabilities: update nvdcve file namePeter Marko2025-10-141-1/+1
| | | | | | | | | | | | The filename is outdated as its version was already bumped and there are also different files for different feed choices. Use glob to match any available file. (From yocto-docs rev: fca48e1239950ccf10f6b1b805c5734104144ded) Signed-off-by: Peter Marko <peter.marko@siemens.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual/building.rst: add note about externalsrc variables absolute pathsTalel BELHAJ SALEM2025-10-031-0/+5
| | | | | | | | | | (From yocto-docs rev: a0ffc6296e7349367fa6e6e615b74e2017a1a67e) Signed-off-by: Talel BELHAJ SALEM <bhstalel@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 33166d70b6ad093bd95ffccafc0b07820682f656) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual/security-subjects.rst: update mailing listsAntonin Godard2025-09-191-9/+14
| | | | | | | | | | | | | | Update mailing lists following changes by Michael Halstead (https://lists.yoctoproject.org/g/yocto-security/message/1478). Also fix formatting/spacing. (From yocto-docs rev: 31f35193c61a1f0b4fd76f98887b709c48768121) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 8066aa92a1acae6c99fbee92d24ee1feea65d974) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual/start.rst: added missing command in Optimize your VHDX file using ↵Marco Cavallini2025-08-041-0/+1
| | | | | | | | | | | | | | | | | | | | | DiskPart After compact vsdisk you have to detach it before exiting otherwise the vdisk remains attached. DISKPART> select vdisk file="<path_to_VHDX_file>" DISKPART> attach vdisk readonly DISKPART> compact vdisk DISKPART> detach <------------ new missing command DISKPART> exit (From yocto-docs rev: bf855ecaf4bec4cef9bbfea2e50caa65a8339828) Signed-off-by: Marco Cavallini <m.cavallini@koansoftware.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1cc65ddf1a074f61fe5a63d222f3079b7fcb4c1e) 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-284-4/+4
| | | | | | | | | | | | | | 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>
* dev-manual/sbom.rst: fix wrong build outputsAntonin Godard2025-05-281-11/+4
| | | | | | | | | | | | | | | | | This document was written with SPDX 3.0 in mind (create-spdx-3.0 class) on OE-Core's master, but Kirkstone only supports SPDX 2.2 (named simply create-spdx). The create-spdx class only generate a tar.zst output, so remove the other outputs listed here. Also, ancillary outputs are not only deployed in tmp/deploy/spdx/MACHINE but tmp/deploy/spdx in general. (From yocto-docs rev: 25b5ec4c71c97228f8386f5b6c4fbe272c207ed6) 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>
* Remove all mention of core-image-lsbRoss Burton2025-03-082-15/+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: 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-28/+68
| | | | | | | | | | | | | 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>
* dev-manual/building: document the initramfs-framework recipeAntonin Godard2025-02-051-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: b1a7dd6d34a291e2250e7169f4f9d93e61700a63) 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>
* ref-manual: move runtime-testing section to the test-manualAntonin Godard2025-01-092-601/+0
| | | | | | | | | | | | | | | 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-091-109/+3
| | | | | | | | | | | | | | | | [ 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>
* dev-manual: document how to provide confs from layer.confAntonin Godard2024-11-151-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: e49111c280927c922ab40547c02c11772787b731) 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>
* dev-manual: update custom distribution sectionPaul Eggleton2024-05-151-4/+30
| | | | | | | | | | | | | | In keeping with the addition of the motd message pointing out that the poky DISTRO is a reference distribution, adjust the opening of the Creating Your Own Distribution section to match. Additionally, add a section on the end pointing out what users need to consider if they just take a copy of the poky distribution and modify it. (From yocto-docs rev: 30bdf5a101466acdf63027bbdfb69ee18ed707ab) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: remove tab charactersMichael Opdenacker2024-04-192-34/+34
| | | | | | | | | | | | | As reported by "make sphinx-lint" Tabs are even removed in Makefile examples, as Sphinx turns them to spaces anyway in the generated output. (From yocto-docs rev: fd1423141e7458ba557db465c171b0b4e9063987) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: fix trailing spacesMichael Opdenacker2024-04-193-7/+11
| | | | | | | | | Fixing errors reported by "make sphinx-lint" (From yocto-docs rev: 45b04c281a567e06fd2904166bcc26603e73e684) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: improve descriptions of 'bitbake -S printdiff'Alexander Kanavin2024-04-052-7/+13
| | | | | | | | | | | Try to particularly emphasize that it can be used to find out why something rebuilds when it shouldn't. (From yocto-docs rev: 1cd543e62e8f1b65e65108d919c2f481001e044c) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: document VIRTUAL-RUNTIME variablesMichael Opdenacker2024-03-251-4/+4
| | | | | | | | | | | | | | Document the convention to use variables prefixed by VIRTUAL_RUNTIME. Add references to the new term where possible. Another reason is that such variables are recommended in a warning issued by meta/classes-global/insane.bbclass (From yocto-docs rev: db88c2021062c95fe49b54351952753390d45a6a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Tim Orling <ticotimo@gmail.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: packages: fix capitalizationMichael Opdenacker2024-03-251-1/+1
| | | | | | | | | | | | Using "PR service" instead of "PR Service", like in the other two instances in this document. (From yocto-docs rev: ef8b7d30738fe8ae6702da111bbafdc0e00e86bf) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: updates for building on Windows (WSL 2)Michael Opdenacker2024-03-011-37/+35
| | | | | | | | | | | | | - Use the Wikipedia naming scheme: WSL 2 instead of WSLv2 - Take into account Windows Server 2019 and 2022 which are supported too. - Improve some explanations (From yocto-docs rev: e64c1154c358128d76b1b8e3a5809dbaa8dc6881) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: system-requirements: modify anchorMichael Opdenacker2024-03-012-2/+2
| | | | | | | | | To align with the "master" branch (From yocto-docs rev: aaeb061fa8ff73496175eba59f53a19fdcf08f64) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: update references to buildtoolsMichael Opdenacker2024-03-011-1/+3
| | | | | | | | | Also fix number of corresponding paragraphs (From yocto-docs rev: 28ee2d91fe4dd0549940dc5df1ff1d59363fcc0f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: packages: need enough free spaceMichael Opdenacker2024-03-011-0/+7
| | | | | | | | | Enough free storage space is needed to apply package upgrades. (From yocto-docs rev: d020b170917a47487ffda3beb0a2ca223c3d37ed) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: packages: clarify shared PR service constraintMichael Opdenacker2024-03-011-3/+8
| | | | | | | | | | Explicit the problems previous described as "obvious". (From yocto-docs rev: af3f35801a4360cc9c3ea93a39f88596d5f44fdb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: suppress excess use of "following" wordMichael Opdenacker2024-03-0115-32/+32
| | | | | | | | | | | | | | | | | | To simplify the style, replace "Following is" and "Following are" by "here is" and "here are", sounding more natural. In some cases, also go further by simplifying "Here are/is xxx" by "xxx are/is" when the "are" or "is" are not two far at the end of the sentence. In some cases too, completely remove the sentence, when it's redundant with the preceding title. (From yocto-docs rev: 2539f1b9cbf9bdd40eff93c6522dc76133debed7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Daniel Ammann <daniel.ammann@bytesatwork.ch> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: Rephrase spdx creationSimone Weiß2024-03-011-15/+24
| | | | | | | | | | | | | Make the options more clear by providing them in a list instead of plain prosa. Also add a ref for a presentation wrt spdx 3.0 in the Yocto project. Fixes [YOCTO 7476] (From yocto-docs rev: 9e5956736a9b6e6c99967d120303d5142550fdb1) Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: start: remove idle lineMichael Opdenacker2024-02-091-2/+1
| | | | | | | | | Align with text in the other branches. (From yocto-docs rev: 394ccddfa357d186006439600833fce917a1ffac) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: gen-tapdevs need iptables installedSimone Weiß2024-02-091-0/+2
| | | | | | | | | | Add the hint to the test setup that runqemu-gen-tapdevs will need the iptables package installed. (From yocto-docs rev: ca4c984006972d34aa51f05797ec8bd47dc675bb) Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: document VSCode extensionEnguerrand de Ribaucourt2024-01-242-3/+16
| | | | | | | | | | | | | | | | The VSCode extension is now officially maintained and published by the Yocto Project so it should be referenced in the manuals to help users discover it. I located the most relevant places to reference the extension by looking at how the old Eclipse plugin was documented in the 2.6 manuals as well as the current Toaster references. (From yocto-docs rev: 21ec0d3b52069dfc85ff47fb4f913a26a092c480) Signed-off-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: start.rst: update use of Download pageSimone Weiß2024-01-241-8/+10
| | | | | | | | | | | The yocto website has changed its structure. Update the section for Accessing the Downloads page to match the new structure. (From yocto-docs rev: c67d471145cf09162059368ffd99f0c80df92520) Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: runtime-testing: fix test module nameMichael Opdenacker2023-12-211-1/+1
| | | | | | | (From yocto-docs rev: 15a5a6de535db637abe15c24b6d6d9d1e0fb444e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: Discourage the use of SRC_URI[md5sum]Peter Kjellerstedt2023-12-212-12/+17
| | | | | | | | | | | | | | | SRC_URI[md5sum] has been deprecated for a long time. Discourage its use by removing it from examples and note that it should be replaced by SRC_URI[sha256sum] when updating recipes. Also mention that bitbake supports other checksums, though they are not commonly used. (From yocto-docs rev: fb5b87cf7322542896c269f404571a655ed6bf91) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: layers: update link to YP Compatible formMichael Opdenacker2023-12-211-2/+2
| | | | | | | | (From yocto-docs rev: 738ce45b65dd53643303784184c43a83faed344c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Megan Knight <megankn@amazon.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: update class referencesMichael Opdenacker2023-11-282-2/+2
| | | | | | | | | | Synchronizing with master whenever possible, to make the branch easier to maintain. (From yocto-docs rev: 825b1292ab08770b2d8cfdc1e11358a2790c1a1b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: add security team processesMarta Rybczynska2023-11-032-0/+190
| | | | | | | | | | | | Add the initial version of the section on vulnerability reports, operations of the Security Team with a transcription of https://wiki.yoctoproject.org/wiki/Security_private_reporting (From yocto-docs rev: 13927bd3e2f89f301331583b2c5752b963822976) Signed-off-by: Marta Rybczynska <marta.rybczynska@syslinbit.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: start.rst: remove obsolete referenceMichael Opdenacker2023-10-251-18/+6
| | | | | | | | | | | | | Remove a reference to a web resource which is clearly marked as obsolete. Replace the unnecessarily verbose note by just links to the mentioned tools. [YOCTO #15233] (From yocto-docs rev: b2db385b859faa775f7c92072ba9bbeebb90e713) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: layers: Add notes about layer.confBELHADJ SALEM Talel2023-10-251-0/+14
| | | | | | | | | | | | As discussed before with Richard Purdie, the code supports this but the documentation does not. Developers in general will not notice this or focus on it because they do not mess with the layer.conf template file, but in my opinion I think more details can help. (From yocto-docs rev: c4b94c24ff7e1b1609f9c7f0aebd24fd04d00ae9) Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: new-recipe.rst: add missing parenthesis to "Patching Code" sectionRobert P. J. Day2023-10-251-2/+2
| | | | | | | | | | Add missing parenthesis, and another example of a compressed patch filename. (From yocto-docs rev: febc0c6b7b5843c70ed01f9b2bda71c02091eae6) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: wic: update "wic list images" outputMichael Opdenacker2023-10-251-12/+15
| | | | | | | (From yocto-docs rev: 46fdf58f4a26de2989261eb451380905ae0f1a41) Signed-off-by: Michael Opdenacker <michael.opdenacker@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-01 07:13:34 +0000