summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
Commit message (Collapse)AuthorAgeFilesLines
* 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: 05029257d0c5f090d5c0a96c6244bfaf40615178) 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: 3757ace0581e6279aa7c065b21cee56edfe985dd) 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-031-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: e1aa69d00e20a5d3c948c430ed10eb01e7baa574) 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-595/+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: 79aa34db34def525a11c41d951365bcb891318c4) 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: 110e15c4407dfc03c7d931e4488eb43dbfad7570) 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/bmaptool.rst: simplify and fix instructionsMichael Opdenacker2024-12-231-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: a1e4f18af6b0b10cece83c53ebb14052a0b94314) 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-231-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: c43eea3875e265c8a62b9f7323365b8d740a39f8) 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-232-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: 55146fae45e8c2de1d0f7242f1c89f3e165d77c9) 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-233-17/+15
| | | | | | | | | | | | | | | | | | | | | | | | 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: ef4d259842d9b1dd2d08ee38e00f932852f70543) 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>
* dev-manual: bblock: use warning block instead of attentionAntonin Godard2024-11-181-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: cafa551d0927f56854f823e51f3de690f17423cd) 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-181-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: 36f2a230ca810b1dd221b7c8ce71e8086291131a) 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: add bblock documentationJulien Stephan2024-11-092-0/+130
| | | | | | | | | | | | | | bblock is a helper tool to lock/unlock tasks and recipes to specific signatures. Add a documentation page for it. (From yocto-docs rev: e882cb3e5816d081eb05cb83488f286cca70e0c6) Signed-off-by: Julien Stephan <jstephan@baylibre.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a082aa39840587d3af6c3f4a2c2747564ca37414) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: update custom distribution sectionPaul Eggleton2024-04-161-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: 3dc812e7255ba7c0ddd7b43b9b1319ea4ef3161e) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: update reference to sstate-cache-management scriptPaul Eggleton2024-04-161-1/+1
| | | | | | | | | | | | | * Script is now .py * In the example, we would most likely be within the build directory already, so the path would be just "sstate-cache" not "build/sstate-cache" (From yocto-docs rev: a655ef8f5fee98e55277cbd40a092fcae697cbae) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/debugging: mention new ``taskexp_ncurses`` optionMichael Opdenacker2024-04-121-4/+8
| | | | | | | | (From yocto-docs rev: 301c802a92a2c53c3d0c755c31a6e09130956fde) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested_by: Reyna, David <david.reyna@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: remove tab charactersMichael Opdenacker2024-04-122-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: 20e9c0c9fad3109567948af6bc40bb0fa2a5552b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix incorrect double backticksMichael Opdenacker2024-04-081-1/+1
| | | | | | | | | As reported by "make sphinx-lint" (From yocto-docs rev: 1601bf2d294c3a8e7c4c654539c8a4da3ed054d0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix trailing spacesMichael Opdenacker2024-04-083-4/+4
| | | | | | | | | Fixing errors reported by "make sphinx-lint" (From yocto-docs rev: ef6b650c31c4320314564bb85a45eebde3fd98c1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: improve descriptions of 'bitbake -S printdiff'Alexander Kanavin2024-03-192-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: cfaf2707b4a77888316d5eb24bf41ccc21e2c12b) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev/ref-manual: document conf-summary.txt together with conf-notes.txtAlexander Kanavin2024-03-191-3/+3
| | | | | | | | (From yocto-docs rev: b92f2eac3b7455ebfc87f668b9442122dbf1c66f) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: bmaptool: renameTrevor Woerner2024-03-062-11/+11
| | | | | | | | | | | | | | | What was previously known variously as Bmaptool, bmaptools, bmap-tool, and/or bmap-tools has been updated to the singular name: bmaptool. Update all references to suit. Since we are not in charge of debian's package naming policy, any references that relate to debian package(s) will stay as "bmap-tools". (From yocto-docs rev: 9c1505eabd69af548652381cf996d44f40a4fa8a) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document VIRTUAL-RUNTIME variablesMichael Opdenacker2024-03-061-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: 11e1ba97edac979868f199e43c1004db6678044c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Tim Orling <ticotimo@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: packages: fix capitalizationMichael Opdenacker2024-03-061-1/+1
| | | | | | | | | | | | Using "PR service" instead of "PR Service", like in the other two instances in this document. (From yocto-docs rev: f1061014dff7732fe97866dbd9208f09dcde56dc) 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: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: packages: need enough free spaceMichael Opdenacker2024-02-241-0/+7
| | | | | | | | | Enough free storage space is needed to apply package upgrades. (From yocto-docs rev: 6571eb02cbd5c2b96df0f279f25b63255ab7eac4) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: packages: clarify shared PR service constraintMichael Opdenacker2024-02-241-3/+8
| | | | | | | | | | Explicit the problems previous described as "obvious". (From yocto-docs rev: ca939f9ceebbf9b5e82bb76abf1c4d20f039d68e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: suppress excess use of "following" wordMichael Opdenacker2024-02-2415-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: 52ba6bb16c73cbc2c0e77496d5226c49bce786f5) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Daniel Ammann <daniel.ammann@bytesatwork.ch> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Rephrase spdx creationSimone Weiß2024-02-241-16/+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: a15e354f98607592a67d2df91dfa2bf0707d8f38) Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: start: remove idle lineMichael Opdenacker2024-02-051-1/+0
| | | | | | | | | This fixes an issue introduced by d8fdec653f96c4ddcb705ff0ef17ed641afcfe2d (From yocto-docs rev: bd970a2101df6e7437fce9cd74deb8bb86aedbd0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: gen-tapdevs need iptables installedSimone Weiß2024-02-051-0/+2
| | | | | | | | | | Add the hint to the test setup that runqemu-gen-tapdevs will need the iptables package installed. (From yocto-docs rev: 4a688fb991282bf606f080d748f5290d988e4354) Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document VSCode extensionEnguerrand de Ribaucourt2024-01-122-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: 645153504690aa8a69b028e95a5e9d2da9644cf1) Signed-off-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: update license manifest pathIlya A. Kriveshko2024-01-121-1/+1
| | | | | | | | | | | After changes in openembedded-core@1a4ab9f, image licenses moved one directory down into ${SSTATE_PKGARCH} subdir. (From yocto-docs rev: ea9675f079cef919a9d13ab12d095144b2eae6ab) Signed-off-by: Ilya A. Kriveshko <iillyyaa@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: start.rst: update use of Download pageSimone Weiß2024-01-121-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: d8fdec653f96c4ddcb705ff0ef17ed641afcfe2d) Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: runtime-testing: fix test module nameMichael Opdenacker2023-12-181-1/+1
| | | | | | | (From yocto-docs rev: e0f4f67d5e702b6d9c9c7b77896a397221d825d8) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document minidebuginfoEtienne Cordonnier2023-12-181-0/+15
| | | | | | | | (From yocto-docs rev: 1a6327f2d92b390248afb45119d79bb05cda3dcc) Signed-off-by: Etienne Cordonnier <ecordonnier@snap.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Discourage the use of SRC_URI[md5sum]Peter Kjellerstedt2023-12-182-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: 806c6cb0b457248ac7401487ba2cdd17a1eba320) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: layers: update link to YP Compatible formMichael Opdenacker2023-12-011-2/+2
| | | | | | | | (From yocto-docs rev: bf69c60b6fafad2497d7c8de51c7e1eb85bcb756) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Megan Knight <megankn@amazon.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Remove references to apm in MACHINE_FEATURESPaul Eggleton2023-11-061-1/+1
| | | | | | | | | | apm is no longer supported in nanbield. (From yocto-docs rev: fa07d34db3b5ba670ed2dc1228ffb3c0c09b3c08) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: extend the description of CVE patch preparationMarta Rybczynska2023-11-061-20/+91
| | | | | | | | | | | | Extend the description on how to prepare a patch for a CVE issue. Add a more illustrative and current example of how to modify the patch file. Add an example of how to use CVE_STATUS. (From yocto-docs rev: f982f6be6b52ba0915b2e6f712270dec5dde64fc) Signed-off-by: Marta Rybczynska <marta.rybczynska@syslinbit.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: improve description of CVE_STATUS and CVE_STATUS_GROUPSMichael Opdenacker2023-10-301-0/+3
| | | | | | | | | | | | | | - Mention CVE_STATUS_GROUPS in the development manual (otherwise only present in the reference manual, but with no reference to it) - In the reference manual description of CVE_STATUS, link back to the development manual, to provide context. (From yocto-docs rev: cfef5fe41b6c819e783c88829448ae38141650a5) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: add security team processesMarta Rybczynska2023-10-302-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: 2b86ac95c557f1e57176cceff428eb63e56c6328) Signed-off-by: Marta Rybczynska <marta.rybczynska@syslinbit.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: start.rst: remove obsolete referenceMichael Opdenacker2023-10-201-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: 3f979f5d2446d57d75f0c4ad2199510d533880e8) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: layers: Add notes about layer.confBELHADJ SALEM Talel2023-10-201-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: 15fc103d4ddd14698c8e75cc654ac157ca1ad740) Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: new-recipe.rst: add missing parenthesis to "Patching Code" sectionRobert P. J. Day2023-10-201-2/+2
| | | | | | | | | | Add missing parenthesis, and another example of a compressed patch filename. (From yocto-docs rev: d44ccb5ed4292b0371651f38b9a0e3083f60ae87) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: update list of supported machinesMichael Opdenacker2023-10-201-7/+1
| | | | | | | | | | The EdgeRouter machine is no longer supported. https://git.yoctoproject.org/poky/commit/?id=0c64d0e4317e3749f7f7ed9ecd5d08bbb0cedc9e (From yocto-docs rev: e600522f2d2514bdd888c91043b9c59563ee7a6d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: wic: update "wic list images" outputMichael Opdenacker2023-10-201-13/+15
| | | | | | | (From yocto-docs rev: b9791285e5df4fa124230d2da4dcabb67088e23b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: fix testimage usage instructionsTrevor Gamblin2023-10-092-3/+3
| | | | | | | | | | | | | | | | The proper way to inherit the testimage class is now IMAGE_CLASSES += "testimage" so change lines with 'INHERIT += "testimage"' to match. This makes the dev-manual consistent with the migration guide, which already specifies that the old way causes an error. (From yocto-docs rev: 2a3e2c6e48be6f7ec2b3ff0817144dd1036961ba) Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: new-recipe.rst: replace reference to wikiMichael Opdenacker2023-09-251-3/+3
| | | | | | | (From yocto-docs rev: 22c445e9803f5e1ac97d1efaf7ac2ea6fc2f7594) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: disk-space: improve wording for obsolete sstate cache filesMichael Opdenacker2023-09-191-4/+4
| | | | | | | | | | | | | | | Replace "duplicate" by "obsolete", more appropriate. "duplicate" probably comes from the "--remove-duplicated" option of the sstate-cache-management.sh script. Improve other sentences too. (From yocto-docs rev: 08451ef3808a34915c8e536090e34dab2bc6cf88) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org> CC: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: licenses: mention SPDX for license complianceMichael Opdenacker2023-09-191-8/+22
| | | | | | | | (From yocto-docs rev: a34626dd59617a32f6c20aa9ac11f15db2795a75) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: licenses: update license manifest locationMichael Opdenacker2023-09-191-2/+3
| | | | | | | | | | | - Fix broken markup (wasn't displaying properly) - Update the path to the directory containing license information - Fix typo later in the document (From yocto-docs rev: f090bb9d2d9cf3833ff0743cfa0cc52099688c64) Signed-off-by: Michael Opdenacker <michael.opdenacker@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-04 15:19:19 +0000