aboutsummaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)Author
2024-03-06dev-manual: bmaptool: renameTrevor Woerner
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". Signed-off-by: Trevor Woerner <twoerner@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-06manuals: document VIRTUAL-RUNTIME variablesMichael Opdenacker
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 Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Tim Orling <ticotimo@gmail.com>
2024-03-06contributor-guide: add notes for testsSimone Weiß
This adds some hints that and how changes should be tested when contributing. Fixes [YOCTO #15412] Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-06dev-manual: packages: fix capitalizationMichael Opdenacker
Using "PR service" instead of "PR Service", like in the other two instances in this document. 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>
2024-03-06ref-manual: variables: adding multiple groups in GROUPADD_PARAMGeoff Parker
Add missing documentation on how to add multiple groups with a single GROUPADD_PARAM:${PN} Signed-off-by: Geoff Parker <geoffrey.parker@arthrex.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-06ref-manual: variables: correct sdk installation default pathJohan Bezem
The SDKPATH variable seems mistakenly identified as the default path where the SDK will be installed by the generated installation script, unless option '-d' or a manual input overrides this default. The intended variable is SDKPATHINSTALL. SDKPATH indicates where the SDK is being composed and built. The definitions have been added/updated. Signed-off-by: Johan Bezem <jbezem.extern@arri.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-03-06ref-manual: tasks: do_cleansstate: recommend using '-f' instead for a shared ↵Luca Ceresoli
sstate do_cleansstat can produce build errors when using a shared sstate cache. Add a note to clearly discourage, provide a safe alternative (bitbake -f), and the rationale. Suggested-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Link: https://lore.kernel.org/yocto-docs/20240219155513.76738-1-luca.ceresoli@bootlin.com/T/#m5529687ecb0f9ec2dacddcb6ff58e2df73af9cde Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
2024-03-06ref-manual: tasks: do_cleanall: recommend using '-f' insteadLuca Ceresoli
do_cleanall can produce failures when used in legitimate cases, such as with recipe variants (foo and foo-native) or a shared DL_DIR. This is why it is forbidden when writing tests that will run on the autobuilders (https://docs.yoctoproject.org/test-manual/intro.html?highlight=cleanall#considerations-when-writing-tests). Reword the documentation to clearly discourage, provide a safe alternative (bitbake -f -c fetch), and the rationale with an example. Reported-by: Sam Liddicott Link: https://bootlin.com/blog/yocto-sharing-the-sstate-cache-and-download-directories/#comment-2650335 Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
2024-03-06ref-manual: classes: add cve status check for oe.qaSimone Weiß
With a new check was added for oe.qa for CVE_STATUS via commit 3c5b7605acd9cd68b ("cve-check: Log if CVE_STATUS set but not reported for component") in poky. Add related documentation here. Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-24dev-manual: packages: need enough free spaceMichael Opdenacker
Enough free storage space is needed to apply package upgrades. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-24dev-manual: packages: clarify shared PR service constraintMichael Opdenacker
Explicit the problems previous described as "obvious". Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-02-24sdk-manual: extensible.rst: cover devtool ide-sdkAdrian Freihofer
Cover the new devtool ide plugin in the extensible sdk section. Many thanks to Enguerrand de Ribaucourt for his re-view and contributions. Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-24ref-manual: variables: remove PYTHON_PNKhem Raj
PYTHON_PN is on its way out, therefore it's good to remove it from documentation so its use is not promoted anymore. Signed-off-by: Khem Raj <raj.khem@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-20migration-guide: add release notes for 4.3.3Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-13manuals: suppress excess use of "following" wordMichael Opdenacker
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. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Daniel Ammann <daniel.ammann@bytesatwork.ch> --- Changes in V2: - Further simplication of some "Here are" and "Here is" statements as suggested by Daniel Ammann <daniel.ammann@bytesatwork.ch> - Remove some sentences which were just repeating the preceding title.
2024-02-13ref-manual: release-process: grammar fixMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-09ref-manual: system-requirements: update packages to build docsMichael Opdenacker
- "git" is now required to run "set_versions.py" - Fix Ubuntu / Debian packages. The previous instructions didn't run on Debian 12 Tested on Ubuntu 22.04 and Debian 12. Reported on https://lists.yoctoproject.org/g/docs/message/4789 Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: <mhagans@skyviewsat.com>
2024-02-06dev-manual: Rephrase spdx creationSimone Weiß
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] Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-05release-notes-4.3: fix spacingMichael Opdenacker
This fixes an ugly formatting issue in the HTML output Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-05docs: remove support for mickledore (4.2) releaseMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-05dev-manual: start: remove idle lineMichael Opdenacker
This fixes an issue introduced by d8fdec653f96c4ddcb705ff0ef17ed641afcfe2d Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-05contributor-guide: fix lore URLbaruch@tkos.co.il
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Baruch Siach <baruch@tkos.co.il> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-02-05dev-manual: gen-tapdevs need iptables installedSimone Weiß
Add the hint to the test setup that runqemu-gen-tapdevs will need the iptables package installed. Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
2024-01-30migration-guide: add release notes for 4.0.16Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-01-29bsp-guide: correct formfactor recipe nameSimone Weiß
This recipe was renamed some time ago. Update the name here as well for consistency. Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-01-11migration-guide: add release notes for 4.3.2Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-01-09documentation: Add UBOOT_BINARY, extend UBOOT_CONFIGJörg Sommer
UBOOT_CONFIG accepts a third parameter for the UBOOT_BINARY that isn't documented. To show its usage another example from the meta-freescale layer was picked. Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-01-08manuals: document VSCode extensionEnguerrand de Ribaucourt
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. Signed-off-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-01-08ref-manual: document cmake-qemu classAdrian Freihofer
Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-01-08dev-manual: update license manifest pathIlya A. Kriveshko
After changes in openembedded-core@1a4ab9f, image licenses moved one directory down into ${SSTATE_PKGARCH} subdir. Signed-off-by: Ilya A. Kriveshko <iillyyaa@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-01-08ref-manual: classes: remove insserv bbclassMaxin B. John
insserv.bbclass was removed from oe-core: commit e6bb5dbb62257a7de730ea9085dfd89520f3e47d Author: Richard Purdie <richard.purdie@linuxfoundation.org> Date: Sun May 10 12:30:49 2015 +0100 insserv: Remove Signed-off-by: Maxin John <maxin.john@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2024-01-08dev-manual: start.rst: update use of Download pageSimone Weiß
The yocto website has changed its structure. Update the section for Accessing the Downloads page to match the new structure. Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-12-22ref-manual: update tested and supported distrosMichael Opdenacker
According to currently active workers https://autobuilder.yoctoproject.org/typhoon/#/workers Also correct the text saying that SANITY_TESTED_DISTROS lists currently tested distros. Also replace AlmaLinux 8.8 and 9.2 by just AlmaLinux 8 and 9, as we update our workers anyway. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> --- Changes in V2: - Replace AlmaLinux 8.8 and 9.2 by just AlmaLinux 8 and 9
2023-12-18contributor-guide: use "apt" instead of "aptitude"Michael Opdenacker
As used in the rest of the manual. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-12-18migration-guides: add release notes for 4.0.15Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-12-12dev-manual: runtime-testing: fix test module nameMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-12-12manuals: brief-yoctoprojectqs: align variable order with default local.confSimone Weiß
Align the order from `BB_SIGNATURE_HANDLER` to `SSTATE_MIRRORS` in Quick Build with the order in the default local conf. While trivial it is easier to find, if the order matches. Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-12-12migration-guides: reword fix in release-notes-4.3.1Lee Chee Yang
Reword a fix to align with the final release notes. Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-12-12manuals: document minidebuginfoEtienne Cordonnier
Signed-off-by: Etienne Cordonnier <ecordonnier@snap.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-12-07test-manual: add or improve hyperlinksMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-12-07test-manual: explicit or fix file pathsMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-12-07test-manual: add links to python unittestMichael Opdenacker
Better than using "python unittest" without any special formatting. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-12-07test-manual: use working exampleMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-12-07test-manual: resource updatesMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-12-07test-manual: text and formatting fixesMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-12-07dev-manual: Discourage the use of SRC_URI[md5sum]Peter Kjellerstedt
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. Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-11-30migration-guides: release 3.5 is actually 4.0Michael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-11-29migration-guides: add release notes for 4.3.1Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-11-23contributor-guide: fix command optionMichael Opdenacker
"--subject-prefix" applies to "git format-patch", not "git send-email" Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-11-22contributor-guide: add License-Update tagJustin Bronder
Porting from the old wiki https://www.openembedded.org/index.php?title=Commit_Patch_Message_Guidelines&oldid=10935#Describing_license_changes Signed-off-by: Justin Bronder <jsbronder@cold-front.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-06-12 08:42:52 +0000