summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/common-tasks.rst
AgeCommit message (Collapse)Author
2022-12-01manuals: split dev-manual/common-tasks.rstMichael Opdenacker
A 500 KB source file is always harder to manage, and can have section title conflicts. So, the "Common Tasks" document is gone and all its constituents are moved up one level. You now have 40 chapters in the Development Tasks Manual. (From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01manuals: fix paragraphs with the "inherit" wordMichael Opdenacker
Nothing wrong with this word, but instances of "inherit" were looked for while looking for class names without references. Fixing alignment and sometimes syntax. (From yocto-docs rev: c418c645a360e74ebb91765a3041336f03097e0d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-01manuals: add missing references to classesMichael Opdenacker
Sometimes fixing line length in modified paragraphs too. [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 885b60f5540849bf19240a01a77efce1d1b5d9f0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07manuals: add shortcut for Wikipedia linksMichael Opdenacker
(From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07dev-manual: common-tasks.rst: add section about SPDX / SBOM generationMichael Opdenacker
Also stop refering to the meta-spdxscanner class, no longer relevant. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07dev-manual: common-tasks.rst: fix typosUlrich Ölmann
(From yocto-docs rev: 680f48a94cec063779797c55a9bfe461289a98e3) Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28manuals: use references to the "Build Directory" termMichael Opdenacker
Replace instances of "Build Directory" and "build directory" (when applicable) by :term:`Build Directory` as already done in most places. Doing this, fix the indentation of the paragraphs with this term. (From yocto-docs rev: dce50679242d39f133e0cde5c8483b5e69f3eb54) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28manuals: stop referring to the meta-openembedded repo from GitHubMichael Opdenacker
(From yocto-docs rev: de6e7c05fbcff99a6f1fe2a2bf889b559b9b576b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28manuals: replace "_" by "__" in external linksMichael Opdenacker
(From yocto-docs rev: 25142cd8121fdd6a8e0524fc8417fc666c498981) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28dev-manual: common-tasks.rst: refactor and improve "Checking for ↵Mikko Rapeli
Vulnerabilities" section Add sub section to how Poky and OE-Core handle CVE security issues. This is a generic intro chapter. Also add note that this is a process which needs quite a bit of review and iteration to keep products and SW stack secure, a process not a product. Then change "Vulnerabilites in images" chapter to "Vulnerability check at build time" since the process applies to anything compiled with bitbake, not just images. Explain details of how to work with cve-check.bbclass, especially the states Patched, Unpatched and Ignored in the generated reports. Rename recipe chapter to "Fixing CVE product name and version mappings" since CVE check has some default which works for all recipes but generated reports may be completely broken. Fixes are then done with CVE_PRODUCT and CVE_VERSION. Give some hints how to analyze "Unpatched" CVEs by checking what happens in other Linux distros etc. (From yocto-docs rev: 77a9c1a9fe651bf11f1d5a723b0741dd1764b2c8) Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-28dev-manual: common-tasks.rst: add regular updates and CVE scans to security ↵Mikko Rapeli
best practices Regular security scans and updates to fix issues and updates from upstream maintainers are best practices. (From yocto-docs rev: 24d3337b6cbb38297877f6ce6ec78896ce93e8b2) Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19manuals: fix misc typosMichael Opdenacker
(From yocto-docs rev: 988efd0d1663e4369043c5b53d7e1dcd9e54d3cd) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19Update documentation for classes splitPaul Eggleton
* Make reference to meta/classes* instead of just meta/classes * Update each reference to the path where the class has moved * Add a brief explanation to the classes reference explaining the split * Add a note to INHERIT, INHERIT_DISTRO, IMAGE_CLASSES and USER_CLASSES variable glossary entries mentioning where the specified classes must be located. I contemplated adding the same note to PACKAGE_CLASSES but decided against it, as it has a very specific usage and such a note might distract from the narrative of that entry. * Also trim the IMAGE_CLASSES entry which was quite outdated. * INHERIT += no longer works with testimage so drop the note about that (From yocto-docs rev: e76bed00b452d3049f6c22afbfb980b557a141bd) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-19ref-manual: remove reference to testimage-auto classPaul Eggleton
testimage-auto was removed in the thud release. (From yocto-docs rev: 618351169c09470280aeee53a63aba88788efc4b) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add references to the "do_rootfs" taskMichael Opdenacker
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 926c836e5184243fb1aee113962e11c01f0297ee) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add references to the "do_bundle_initramfs" taskMichael Opdenacker
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 84c024455a36f4b40cd8401715f30b0af74af8a7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07dev-manual: common-tasks.rst: add reference to "do_listtasks" taskMichael Opdenacker
(From yocto-docs rev: 4352e14f82a45444acb2d8df11552b2265471ab1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add references to the "do_devshell" taskMichael Opdenacker
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 53141101fc1a8dc8b4007adcded3c7c6b9738f48) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add references to the "do_cleanall" taskMichael Opdenacker
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 4c815875b7c716f421bbcd11ce26703867f11741) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07dev-manual: common-tasks.rst: add reference to "do_clean" taskMichael Opdenacker
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 68261dc8b8c26df7aad19b37c2300ec5174525c9) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add references to the "do_unpack" taskMichael Opdenacker
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 1ca57f8ec322d5777bf31829e659d62e82986be1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add references to "do_populate_sysroot" taskMichael Opdenacker
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: a010e2eafa6754c46faac6f6dfd02dc6152d274f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add references to "do_package_write_*" tasksMichael Opdenacker
Using a reference to "do_package_write_deb", the first entry in the list. [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 237cebcfa6215d75bbe28df677f18ebf7e1bb4f6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add references to the "do_patch" taskMichael Opdenacker
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 1e38ceafb25aac13bb9dd45626fd39ad1b68852d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add references to the "do_package" taskMichael Opdenacker
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 179139e6710f6dde0de25200c372705ed8ef13bc) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add references to the "do_image" taskMichael Opdenacker
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 2f53d0a52a48f828f00d3bc3f887fd537692a256) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add reference to the "do_compile" taskMichael Opdenacker
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: e88f11002032e30bbe2dd0049e307a431a70aaef) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add reference to "do_configure" taskMichael Opdenacker
[YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 5ddc1a40c9004d814472bdd385f456afa7a9c4e3) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add references to the "do_build" taskMichael Opdenacker
[YOCTO #14508] (From yocto-docs rev: c8efd2eeb329344c48935f8998e9a689d66348ca) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add reference to the "do_install" taskMichael Opdenacker
[YOCTO #14508] (From yocto-docs rev: 933ad27b81dfc4a28e7c48ca7bb2d1363e8c037f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: add references to the "do_fetch" taskMichael Opdenacker
[YOCTO #14508] (From yocto-docs rev: 17f2041647010d885f18f889c740588586c60d3a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-07manuals: improve initramfs detailsMichael Opdenacker
- Create a new entry in the glossary - Add implementation details - Replace the mention of "init ramdisk" by "initramfs¨ whenever possible - Remove obsolete and duplicate information - Fix spacing issues in the Sphinx code (From yocto-docs rev: 952c7e6dee49532705b2c162f4728e635c38df3f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24dev-manual: common-tasks.rst: refer to Python functions in BitBake manualMichael Opdenacker
(From yocto-docs rev: a3ef2ac954d89432715a204bf293586c733690c6) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24dev-manual: common-tasks.rst: rewrite the section about configuration templatesAlexander Kanavin
This now includes a description about how to create a template with the newly added tooling, and drops the description of .templateconf as a way to point to a custom template (which is not correct: .templateconf is used only to point to a default template in poky or core when TEMPLATECONF is not specified). (From yocto-docs rev: d8e43d4ff4d6a0a4557d5dcedf11c1e45a223e72) 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>
2022-09-24dev-manual: common-tasks.rst: describe the newly added layer setup and ↵Alexander Kanavin
template config commands (From yocto-docs rev: 3a5af296eb1492492ba60beabe888527d0dda49a) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-24common-tasks.rst: describe the layer setup toolingAlexander Kanavin
(From yocto-docs rev: 2b56daf38ea9049e6d98be338b95a191360c3b32) 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>
2022-09-24dev-manual: common-tasks.rst: drop the output of 'bitbake-layers --help'Alexander Kanavin
This is really not needed as the sub-commands are described in greater detail just below, and is prone to become outdated. (From yocto-docs rev: 70735edb17c3c855a77318d3ae44d24d8aa8eb75) 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>
2022-09-24common-tasks.rst: remove SRC_URI:append from examplesMikko Rapeli
Using SRC_URI:append without recipe, machine or architecture specific limitations makes the :append'ed text more difficult to override than if the "+=" operator was used. This makes it hard for example to override SRC_URI completely in a bbappend to update the full recipe to a newer version. Thus common, reusable layers which users are meant to re-use and customize should not use SRC_URI:append but SRC_URI += instead. (From yocto-docs rev: 34533ac2ee5d85a41330dd865062dce1e46b83fc) Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-09-12manuals: fix paths to default templates & clean up whitespacesUlrich Ölmann
The templates have recently been moved by meta-yocto's commit [1]. Clean up some whitespace issues along the way. [1] 29608bd03e1b ("meta-poky/conf: move default templates to conf/templates/default/") (From yocto-docs rev: 661c554224dd79e79afd22b84608e248d3336aac) Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-08-12dev-manual: use proper note directiveMichael Opdenacker
For correct rendering of the note (From yocto-docs rev: cc765028a7cd3dda6942450b3d59d283bf73a8f7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-30dev-manual: update section about creating NPM packagesMichael Opdenacker
From running the instructions using Poky master In particular, update command output and the contents of generated files. The "cute-files" example application can now directly be run, without having to run it through "node". (From yocto-docs rev: a100fb1e25e3f2e144d771d31e952deae2fe3302) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-27manuals: replace hyphens with em dashesMichael Opdenacker
Fix some hyphens being improperly used as em dashes. See https://www.grammarly.com/blog/hyphens-and-dashes/ Using em dashes may also allow Sphinx to hyphenate and break lines in the best way. Note that the first character after an em dash not supposed to be capitalized, unless a specific rule applies, typically when what follows is a proper noun. Fix a few misuses of parentheses in following text. (From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-27dev-manual: NPM packages: minor grammar fixMichael Opdenacker
(From yocto-docs rev: ab3758fbb422895c31417e2c4c41937995ec8d7e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21dev-manual: fix references to BitBake user manualMichael Opdenacker
Fix a wrong reference no longer tolerated by Sphinx 5.0.1 (missing "bitbake:" prefix) Add missing double quotes in a reference to a chapter title (From yocto-docs rev: 9a797dedf6708da3e7ce789c5c8735e5d891cde4) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21ref/dev-manual: Update multiconfig documentationRichard Purdie
Multiconfigs now work from layers. Update the documentation to match this change. Also fix a incorrect reference to different distros working within the same TMPDIR, that is incorrect. [YOCTO #13566] (From yocto-docs rev: cb35f75bfc98c9098f9af64b9dd040b25779da36) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21dev-manual: mention the new CVE patch metrics pageMichael Opdenacker
(From yocto-docs rev: 42bfcb2d3a13e71264e5f29b07615c2da9866273) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-24manuals: add documentation for WKS_FILESMichael Opdenacker
Fixes [YOCTO #14590] (From yocto-docs rev: e736ff92b5b09f2028f3e8a5152973941d25dae4) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-24dev-manual: fix documentation for bmaptool usageThomas Epperson
(From yocto-docs rev: 4d4e2b023e569bff466a8e7b07f1b7e8e2334df0) Signed-off-by: Thomas Epperson <tepperson@briskheat.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-24manuals: add missing space in appendsMichael Opdenacker
(From yocto-docs rev: aa122d28298596a3b91a8f6650163785a3cfa831) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-05-10manuals: improve documentation for TEMPLATECONFMichael Opdenacker
Add it to the variable index Misc improvements to the documentation for this variable (From yocto-docs rev: fb460a7c7aba1ad5754806f9cfad9ef591420317) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-04-27 17:25:31 +0000