summaryrefslogtreecommitdiffstats
path: root/documentation/contributor-guide/recipe-style-guide.rst
Commit message (Collapse)AuthorAgeFilesLines
* contributor-guide: add License-Update tagJustin Bronder2023-12-011-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: 51e55b44a4532ae16595bd5a712c34deeff5d47b) Signed-off-by: Justin Bronder <jsbronder@cold-front.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: style-guide: discourage using Pending patch statusRoland Hieber2023-09-251-1/+8
| | | | | | | | | | Suggested-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> (From yocto-docs rev: 4924c900582aaa803b003e10e48fc4a4373f6a77) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: deprecate "Accepted" patch statusRoland Hieber2023-09-251-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: 61813da94595a6e57c5fb5015229d601a558f299) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: discourage marking patches as InappropriateRoland Hieber2023-09-251-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: 7e630fdb98e1a28abb09c8f24c90ada0a4a1b9f3) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: recipe-style-guide: add section about CVE patchesRoland Hieber2023-09-251-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: 3022caa35efc28d16dea81bc81ecb48998c8f3b8) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: recipe-style-guide: add more patch tagging examplesRoland Hieber2023-09-251-1/+20
| | | | | | | | (From yocto-docs rev: a2904fd3ccdcb1d7232adce51966749cb1e3cb92) Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide/style-guide: Add a note about task idempotenceRichard Purdie2023-09-251-0/+14
| | | | | | | | (From yocto-docs rev: 7d715d62c32ab81d26bf1ff82f79ad2c4a2e3f85) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> CC: Yoann Congal <yoann.congal@smile.fr> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide/style-guide: Refer to recipes, not packagesRichard Purdie2023-09-251-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: 058de5ad48ab76c4d54391f1701c3082842e8794) 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>
* contributor-guide: recipe-style-guide: add Upstream-StatusMichael Opdenacker2023-09-191-0/+81
| | | | | | | (From yocto-docs rev: 95c9a1e1e78bbfb82adef588f68d5d891fb64358) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: remove obsolete pkg-config guidelinesMichael Opdenacker2023-08-301-5/+0
| | | | | | | | | | | | 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. (From yocto-docs rev: 6b3bbf9507ac7014e95926d69383b585c5e19371) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove AUTHOR variableMichael Opdenacker2023-08-301-1/+0
| | | | | | | | | Following https://git.openembedded.org/openembedded-core/commit/?id=9d5edd124b7dddb995ceddd79f8a7fc8cf44badf (From yocto-docs rev: e7da4d122313f369be1c680dadd76ea53ba8dd04) Signed-off-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-0/+263
(From yocto-docs rev: a61a7677adb9bf22dc0d28e72a8fedf2df27e80a) Signed-off-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-08-05 08:54:25 +0000