summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual: Add info on build env initializationJasper Orschulko2024-06-161-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Going through the docs we a new trainee, we noticed that the build initialization is only mentioned in the quick build (https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html) but not in the in-depth getting started documentation. While this is repeatedly mentioned later on, e.g. in the "building" section, you might easily end up somewhere where this has not been mentioned yet. E.g. in our case this was: https://docs.yoctoproject.org/dev-manual/layers.html# (which comes right after the "setup" chapter) -> https://docs.yoctoproject.org/dev-manual/layers.html#creating-a-general-layer-using-the-bitbake-layers-script (which is linked right at the top) To avoid any confusion I think it best to mention this required step directly in the "start" document. (From yocto-docs rev: d7a36b7b8e770ae45b991698d588f9522ba59b4e) Signed-off-by: Jasper Orschulko <jasper@fancydomain.eu> Reviewed-by: Michael Opdenacker <michael@opdenacker.org> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document NVDCVE_API_KEY variableNoe Galea2024-05-291-0/+4
| | | | | | | | | | | | | Add brief documentation of NVDCVE_API_KEY variable, that was added in 4.2.3, and emphasize that its use results in lower NVD API request times. (From yocto-docs rev: 9c7b452441bad2d7c929383d4665dfddb8f7ea72) Signed-off-by: Noe Galea <ngalea@thegoodpenguin.co.uk> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Andrew Murray <amurray@thegoodpenguin.co.uk> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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>
* dev-manual: new-recipe.rst fix inconsistency with contributor guideMichael Opdenacker2023-09-191-6/+7
| | | | | | | | | | | This document was suggesting a way to version pre-releases which doesn't match the latest recommendations from the contributor guide. (From yocto-docs rev: b51c21e59bd624153f6f9b8bf3cf33329bd25e56) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document LICENSE_FLAGS_DETAILSRoss Burton2023-09-191-0/+7
| | | | | | | | | (From yocto-docs rev: 299c9b295a8476abdb32fba01ac2f45efacea6f1) Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: remove unsupported :term: markup inside markupYoann Congal2023-09-091-2/+2
| | | | | | | | | | | | | ":term:`Initramfs`" in bold text appears verbatim (no link is created). The term link is present elsewhere in the text so remove the extra markup. (From yocto-docs rev: b9e19a00a3aac05a2cdd35b61dfae6d5a1a9c648) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: disk-space: mention faster "find" command to trim sstate cacheMichael Opdenacker2023-08-301-9/+25
| | | | | | | | | | | | [YOCTO #15182] (From yocto-docs rev: 6fd067639e7d6ae87bda9ea8795ebf54b8827056) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Yoann CONGAL <yoann.congal@smile.fr> Reported-by: Randy MacLeod <randy.macleod@windriver.com> Reported-by: Josef Holzmayr <jester@theyoctojester.info> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor guide: update instructions for making and sharing changesMichael Opdenacker2023-08-303-4/+4
| | | | | | | | | | | | - Shifting the focus to multiple changes instead of just one - Advising to create a branch for changes - Removing unnecessary or too verbose explanations - Adding useful resources and examples (From yocto-docs rev: e7e47121fd979e034f8f40a043912640a6a25a5e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor guide: call section "Reporting a defect"Michael Opdenacker2023-08-301-1/+1
| | | | | | | | | | | | | Instead of "Submitting a defect". We all write bugs, and nobody needs documentation support for doing so! (From yocto-docs rev: ce94f6ed029afc8c69e84354c03bd0a9ab14f867) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: wic.rst: Update native tools build commandDaniel Semkowicz2023-08-301-1/+1
| | | | | | | | | | | | | | | | Requirements list seems to be outdated. It is not possible to follow instructions for Raw Mode as not all of the native tools are available. All wic dependencies are gathered under wic-tools package. Some commands in the instruction already use wic-tools native sysroot, but this dependency is not specified in the requirements. Update the command for building native tools to use wic-tools instead of the seperate packages. (From yocto-docs rev: 06facd8962e5b31f088ea3c152a7a48e8f346c31) Signed-off-by: Daniel Semkowicz <dse@thaumatec.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: add recipe style guideMichael Opdenacker2023-08-301-50/+4
| | | | | | | (From yocto-docs rev: a61a7677adb9bf22dc0d28e72a8fedf2df27e80a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: create a dedicated "Contributor Guide" documentMichael Opdenacker2023-08-305-539/+7
| | | | | | | | | | Starting from the original contents of dev-manual/changes.rst and from text contributed by Richard Purdie. (From yocto-docs rev: 55587d9dd009cbc92273376e0f7665b2d574d280) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document CVE_STATUS and CVE_CHECK_STATUSMAPAndrej Valek2023-08-032-6/+10
| | | | | | | | | | | Deprecate CVE_CHECK_IGNORE with CVE_STATUS (From yocto-docs rev: 8b8054977f31e2d6090521a0102f066b6d563733) Signed-off-by: Andrej Valek <andrej.valek@siemens.com> Signed-off-by: Peter Marko <peter.marko@siemens.com> Reviewed-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-01-11 20:44:55 +0000