summaryrefslogtreecommitdiffstats
path: root/documentation/contributor-guide
Commit message (Collapse)AuthorAgeFilesLines
* contributor-guide/submit-changes: encourage patch version changelogsTrevor Woerner2025-05-281-0/+32
| | | | | | | | | | | | | | Add a section after the 'git format-patch' information encouraging developers to add patch version changelogs to their patch updates. (From yocto-docs rev: a9f9d53fa4a29e3cf846868567190425ffed8bf0) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 2e3a37c4607b296956993e557d1786c4876e5722) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide/submit-changes: add policy on AI generated codeAntonin Godard2025-02-241-0/+49
| | | | | | | | | | | | | | Based on message by Richard Purdie on the yocto-docs list: https://lists.yoctoproject.org/g/docs/message/6300 Re-formatted for the Yocto Project documentation syntax. (From yocto-docs rev: 50eae3ab433ada5c3863d880f11e2b2bcbd46b94) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a72dd13e6841b621c9e8f904dfaa440c186d2959) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide/submit-changes.rst: suggest to remove the git signatureAntonin Godard2025-01-091-0/+7
| | | | | | | | | | | | | | By default when sending patches Git adds the git version at the bottom of the patch, which is not necessary in most cases. Suggest to remove it when configuring Git when sending patches. Suggested-By: Jaekyu Lee <jaekyu.lee@lge.com> (From yocto-docs rev: b3223f919e0445c0059cddf0ce02cb27f83582c3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit d3465691231f10466703198a831a681803ffdfad) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: Remove duplicated wordsTalel BELHAJSALEM2024-11-151-1/+1
| | | | | | | | | | | | | Remove "and then" as it is duplicated. (From yocto-docs rev: 09ca306a8d5fc5306388f2093541ba4110f603ea) Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 52ed947120e400620277a58f895294b558a9324e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* conf.py: rename :cve: role to :cve_nist:Antonin Godard2024-11-111-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Newer versions of Sphinx already define a :cve: role that points to cve.org, instead of the role we defined in conf.py that points to nvd.nist.gov. Rename our role to :cve_nist: to avoid warnings (treated as errors). This is also backwards compatible, meaning we can build the doc with an older Sphinx if needed. The file were automatically replaced with following command: find . -name '*.rst' -exec sed -i 's/:cve:/:cve_nist:/g' {} \+ Cherry pick: * Changes on following files removed from cherry pick (not part of kirkstone): documentation/migration-guides/release-notes-4.1.1.rst documentation/migration-guides/release-notes-4.1.2.rst documentation/migration-guides/release-notes-4.1.3.rst documentation/migration-guides/release-notes-4.1.4.rst documentation/migration-guides/release-notes-4.1.rst documentation/migration-guides/release-notes-4.2.1.rst documentation/migration-guides/release-notes-4.2.2.rst documentation/migration-guides/release-notes-4.2.3.rst documentation/migration-guides/release-notes-4.2.4.rst documentation/migration-guides/release-notes-4.2.rst documentation/migration-guides/release-notes-4.3.1.rst documentation/migration-guides/release-notes-4.3.2.rst documentation/migration-guides/release-notes-4.3.3.rst documentation/migration-guides/release-notes-4.3.4.rst documentation/migration-guides/release-notes-4.3.rst documentation/migration-guides/release-notes-5.0.2.rst documentation/migration-guides/release-notes-5.0.3.rst documentation/migration-guides/release-notes-5.0.rst documentation/migration-guides/release-notes-5.1.rst * Fix minor conflicts in following files: documentation/migration-guides/release-notes-3.4.2.rst: missing :term: before CVE_PRODUCT documentation/migration-guides/release-notes-4.0.2.rst: missing :term: before PACKAGECONFIG documentation/migration-guides/release-notes-4.0.7.rst: missing cve 2022-32912 on webkitgtk Suggested-By: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: f432e78fef82c5e5bfdfff08bb18757dc3479465) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 15fa3b7e85dde50d7236c1738ad607531cc654b8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: refer to new yocto-patches mailing list wherever appropriateQuentin Schulz2024-04-191-1/+1
| | | | | | | | | | | | | | There's a new yocto-patches mailing list available for all layers that do not have their own mailing list. c.f. https://lists.yoctoproject.org/g/yocto/topic/105197684 Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: d7fc3e978440d9f5724cbce85de000317a3e0783) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: be more specific about meta-* treesMartin Jansa2024-04-051-1/+1
| | | | | | | | | | | | * this is often confused to apply for e.g. meta-oe as well where it doesn't apply as meta-oe has own ML mentioned in README. (From yocto-docs rev: 98102408fe5468529e040a138f09c8fbc5fe065a) Signed-off-by: Martin Jansa <martin.jansa@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: add notes for testsSimone Weiß2024-03-251-0/+32
| | | | | | | | | | | | This adds some hints that and how changes should be tested when contributing. Fixes [YOCTO #15412] (From yocto-docs rev: 649843f4d20d1d840e1c6c4ce15e89b3a8508e0f) Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: fix lore URLBaruch Siach2024-02-091-1/+1
| | | | | | | | | Cc: Michael Opdenacker <michael.opdenacker@bootlin.com> (From yocto-docs rev: af340c7d9a327af0de14d7a6f19215866a0ea835) Signed-off-by: Baruch Siach <baruch@tkos.co.il> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: use "apt" instead of "aptitude"Michael Opdenacker2024-01-241-1/+1
| | | | | | | | | As used in the rest of the manual. (From yocto-docs rev: c68954d905f01f6cc4f7c8ceb90e77cf9068e639) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: fix command optionMichael Opdenacker2023-12-211-1/+1
| | | | | | | | | "--subject-prefix" applies to "git format-patch", not "git send-email" (From yocto-docs rev: cf3697cebc0494a624fa2766d07c3532ec6b4341) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: add License-Update tagJustin Bronder2023-12-211-0/+12
| | | | | | | | | | | Porting from the old wiki https://www.openembedded.org/index.php?title=Commit_Patch_Message_Guidelines&oldid=10935#Describing_license_changes (From yocto-docs rev: 0ff60e3b3da409acff9599b1d511520051db0d37) Signed-off-by: Justin Bronder <jsbronder@cold-front.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: style-guide: discourage using Pending patch statusRoland Hieber2023-10-071-1/+8
| | | | | | | | | | Suggested-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> (From yocto-docs rev: 49d9c8da92cdec6fe4cdc3a4432794b9d286a24f) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: deprecate "Accepted" patch statusRoland Hieber2023-10-071-8/+5
| | | | | | | | | | | | | | | | | | | | 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> (From yocto-docs rev: 9abc0d3100a07d93249f2fb376c42aab1bd9eb3a) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: discourage marking patches as InappropriateRoland Hieber2023-10-071-16/+14
| | | | | | | | | | | | | | 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> (From yocto-docs rev: e0aabb7f3e7cd28a22224740eeb794a86ab34886) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: recipe-style-guide: add section about CVE patchesRoland Hieber2023-10-071-0/+25
| | | | | | | | | | | | | | | | | | | 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). (From yocto-docs rev: 090049e08d7b6fc497a9ac5bc9fabbfa35327414) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: recipe-style-guide: add more patch tagging examplesRoland Hieber2023-10-071-1/+20
| | | | | | | | (From yocto-docs rev: 038697bb1f7eae4214eeecd01f665da083df43fe) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide/style-guide: Add a note about task idempotenceRichard Purdie2023-10-071-0/+14
| | | | | | | | (From yocto-docs rev: 681e6a0a4305057f7b96f5bef804391d8aff812b) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> CC: Yoann Congal <yoann.congal@smile.fr> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide/style-guide: Refer to recipes, not packagesRichard Purdie2023-10-071-7/+8
| | | | | | | | | | | Whilst often referred to as packages by people we should use the more accurate term in documentation, 'recipe' instead of 'packages'. (From yocto-docs rev: d97795e5cfc41b57bffd1255bceaaea8494fd181) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor-guide: recipe-style-guide: add Upstream-StatusMichael Opdenacker2023-09-231-0/+81
| | | | | | | (From yocto-docs rev: 0618611fa049db2b9717cbe609c583a5bb16954e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: update former references to dev-manual/common-tasksMichael Opdenacker2023-09-232-4/+4
| | | | | | | (From yocto-docs rev: f8bb4c392912f15bb78f6f25910f85897abb4e3d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: add new contributor guideMichael Opdenacker2023-09-085-0/+1135
(From yocto-docs rev: 028a1b89fbb6ee7f02a7ca8cd481931e096d764b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-07-24 04:26:11 +0000