summaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)Author
2023-10-06migration-guides: add release notes for 4.0.13yocto-4.3nanbield-4.3Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-05overview: Add note about non-reproducibility side effectsJoshua Watt
Adds an additional note about some of the side effects that can occur if recipes are not reproducible and hash equivalence is enabled. Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-05dev-manual: fix testimage usage instructionsTrevor Gamblin
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. Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-03ref-manual: releases.svg: Scarthgap is now version 5.0Michael Opdenacker
According to https://wiki.yoctoproject.org/wiki/Releases Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-22contributor-guide: style-guide: discourage using Pending patch statusRoland Hieber
Suggested-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-22contributor-guide: deprecate "Accepted" patch statusRoland Hieber
This is in accordance with the gatesgarth Release Notes: > In the ``Upstream-Status`` header convention for patches, > ``Accepted`` has | been replaced with ``Backport`` as these almost > always mean the same thing i.e. the patch is already upstream and > may need to be removed in a future recipe upgrade. If you are adding > these headers to your own patches then use Backport to indicate that > the patch has been sent upstream. <https://docs.yoctoproject.org/migration-guides/migration-3.2.html#miscellaneous-changes> Suggested-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-22contributor-guide: discourage marking patches as InappropriateRoland Hieber
It was never really clear what all those reasons really meant, and every patch submitted upstream liftens the maintenance on the Yocto side. So remove the current list, and replace it with two reasons in which an upstream submission likely won't benefit the upstream project. Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-22contributor-guide: recipe-style-guide: add section about CVE patchesRoland Hieber
This was previously included in the OpenEmbedded wiki page [1], but was not ported along with the rest in commit 95c9a1e1e78bbfb82ade (2023-09-12, Michael Opdenacker: "contributor-guide: recipe-style-guide: add Upstream-Status"). [1]: https://www.openembedded.org/index.php?title=Commit_Patch_Message_Guidelines&oldid=10935 Group the examples in their own sections (but name it differently from any other section in this document so that sphinx doesn't generate a warning about duplicate labels). Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-22contributor-guide: recipe-style-guide: add more patch tagging examplesRoland Hieber
Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-22dev-manual: new-recipe.rst: replace reference to wikiMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-22bsp-guide: bsp.rst: replace reference to wikiMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-20contributor-guide/style-guide: Add a note about task idempotenceRichard Purdie
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> CC: Yoann Congal <yoann.congal@smile.fr> --- Changes in V2: - Use a bulleted list to clarify the order of steps (Suggested by Yoann Congal) - Recall that we are talking about idempotence in tasks. Useful for people overlooking the previous paragraph.
2023-09-20contributor-guide/style-guide: Refer to recipes, not packagesRichard Purdie
Whilst often referred to as packages by people we should use the more accurate term in documentation, 'recipe' instead of 'packages'. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-19sdk-manual: extensible.rst: fix multiple formatting issuesMichael Opdenacker
Take advantage of this edit to also fix alignment issues in the sources. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-19dev-manual: disk-space: improve wording for obsolete sstate cache filesMichael Opdenacker
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. 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>
2023-09-19ref-manual: point outdated link to the new locationRoland Hieber
Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-19template: fix typo in section headerRoland Hieber
Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-14dev-manual: licenses: mention SPDX for license complianceMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Joshua Watt <JPEWhacker@gmail.com>
2023-09-14dev-manual: licenses: update license manifest locationMichael Opdenacker
- Fix broken markup (wasn't displaying properly) - Update the path to the directory containing license information - Fix typo later in the document Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-14contributor-guide: recipe-style-guide: add Upstream-StatusMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-14dev-manual: new-recipe.rst fix inconsistency with contributor guideMichael Opdenacker
This document was suggesting a way to version pre-releases which doesn't match the latest recommendations from the contributor guide. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-11manuals: document LICENSE_FLAGS_DETAILSRoss Burton
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> --- Changes in V2: - Remove the "\n" character at the begining of the string No longer needed thanks to https://git.openembedded.org/openembedded-core/commit/?id=5e027da9265e58df016fc3ebe45e4400f0e5c7a7
2023-09-07README: Update to point to new contributor guideRichard Purdie
Now we have a contributor guide combining various wiki pages, point at that and tweak to match our other READMEs. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-06Add libacl to required packagesJoshua Watt
libacl is required for correctly calculating output hashes, so add it to the require host packages Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-05dev-manual: remove unsupported :term: markup inside markupYoann Congal
":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. Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-05migration-guides: add release notes for 4.0.12Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-05migration-guides: add release notes for 4.2.3Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30migration-guides: system-conf -> systemd-confEtienne Cordonnier
Fix this typo. There is no system-conf recipe. Signed-off-by: Etienne Cordonnier <ecordonnier@snap.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30contributor-guide: submit-changes: how to request push access to repositoriesMichael Opdenacker
Including content currently on http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor-guide: submit-changes: commit guidelines for recipesMichael Opdenacker
Adding text currently on http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor-guide: submit-changes: improvements to mailing lists sectionMichael Opdenacker
- Add missing reference to openembedded-devel list - Improve the text to clarify explanations, remove redundant information and include information currently on http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor-guide: submit-changes: reorganize and develop sectionsMichael Opdenacker
In particular, develop the sections about sending patches. Reorder sections for a more logical flow. Remove unnecessary or duplicate details too. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30manuals: README: update list of manualsMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor-guide: submit-changes: develop sending patches sectionMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor-guide: submit-changes: detail commit and patch creationMichael Opdenacker
Add missing steps and try to provide better guidance and more modern solutions, for example keeping track of the cover letter in the branch itself. Also add subsections to divide the instructions into easier to understand parts. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor-guide: identify component: provide link to repositoriesMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor-guide: submit-changes: simplify noteMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor-guide: move to 2nd place in top menuMichael Opdenacker
To give it more visibility Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30dev-manual: disk-space: mention faster "find" command to trim sstate cacheMichael Opdenacker
[YOCTO #15182] 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> --- - Changes in V3: - Mention the use of "-atime" if we don't have the cache on storage mounted with the "-noatime" option, as suggested by Richard Purdie. - Changes in V2: - Using a more universal "-mtime" option to find files to remove as suggested by Richard Purdie. V1 was using "-atime" which won't work with systems mounted with the "noatime" option used to increase disk performance. - Add more details about sstate-cache-management.sh provided by Richard Purdie, perhaps not recommended but useful to document as long as it is shipped in OE-core.
2023-08-30contributor guide: update instructions for making and sharing changesMichael Opdenacker
- 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 Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor-guide: clarification about patchtestMichael Opdenacker
- Highlight that patchtest still needs improving - Fix reference to this tool Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor guide: remove unnecessary information about mailing listsMichael Opdenacker
The mailing lists for sending code are sufficient! Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor-guide: remove obsolete pkg-config guidelinesMichael Opdenacker
They were coming from obsolete notes from the times when people directly created or modified .pc files from their recipes. Nobody should be doing that any more and keep this can be confusing. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor guide: call section "Reporting a defect"Michael Opdenacker
Instead of "Submitting a defect". We all write bugs, and nobody needs documentation support for doing so! Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Joshua Watt <JPEWhacker@gmail.com>
2023-08-30ref-manual: remove AUTHOR variableMichael Opdenacker
Following https://git.openembedded.org/openembedded-core/commit/?id=9d5edd124b7dddb995ceddd79f8a7fc8cf44badf Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30dev-manual: wic.rst: Update native tools build commandDaniel Semkowicz
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. Signed-off-by: Daniel Semkowicz <dse@thaumatec.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor-guide: add recipe style guideMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30contributor-guide: add section about why we use mailing listsMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30contributor-guide: add missing links to mailing listsMichael Opdenacker
And fix such a link too. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-30ref-manual: update supported distro versionsMichael Opdenacker
- Update according to changes in SANITY_TESTED_DISTROS (meta-poky/conf/distro/poky.conf) - No longer declare as "Supported" the distributions versions which are End of Life for their vendors, as some of them (Ubuntu for example) ship updates to subscribers only, which the Yocto Project has no access to. - List distribution versions which were previously tested for the branch of the Yocto Project being considered (should be an empty list on master, until the next release is made). Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> --- Changes in V2: - Update with recent update of SANITY_TESTED_DISTROS Thanks to this, more recent versions are declared as supported.
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-05-14 07:55:42 +0000