Commit Graph

13 Commits

Author SHA1 Message Date
Alexandre Truong
0df9d22928 recipe style guide: add recommendation for patches without signature
>From discussion [0], the presence of git version signature at the end of
patches has been questionned. To avoid a bit more noise, the setting git
format.signature is added to the documentation and its use is
recommended.

[0]: https://lists.openembedded.org/g/openembedded-core/topic/106323318#msg199967

(From yocto-docs rev: 7da39b91a0f20cb7215d51e00c098f3dc13180fd)

Signed-off-by: Alexandre Truong <alexandre.truong@smile.fr>
Reviewed-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Michael Opdenacker <michael@opdenacker.org>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-06-16 22:48:18 +01:00
Justin Bronder
9773b0c64c contributor-guide: add License-Update tag
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>
2023-12-01 17:45:06 +00:00
Roland Hieber
8815eefb0d contributor-guide: style-guide: discourage using Pending patch status
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>
2023-09-25 14:37:26 +01:00
Roland Hieber
f60c81287e contributor-guide: deprecate "Accepted" patch status
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>
2023-09-25 14:37:26 +01:00
Roland Hieber
3dc1dbc22f contributor-guide: discourage marking patches as Inappropriate
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>
2023-09-25 14:37:26 +01:00
Roland Hieber
975e974eb1 contributor-guide: recipe-style-guide: add section about CVE patches
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>
2023-09-25 14:37:26 +01:00
Roland Hieber
653ac666c4 contributor-guide: recipe-style-guide: add more patch tagging examples
(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>
2023-09-25 14:37:26 +01:00
Richard Purdie
79007d04fc contributor-guide/style-guide: Add a note about task idempotence
(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>
2023-09-25 14:37:26 +01:00
Richard Purdie
3eb4532cad contributor-guide/style-guide: Refer to recipes, not packages
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>
2023-09-25 14:37:26 +01:00
Michael Opdenacker
8b3a81f42f contributor-guide: recipe-style-guide: add Upstream-Status
(From yocto-docs rev: 95c9a1e1e78bbfb82adef588f68d5d891fb64358)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-09-19 15:57:35 +01:00
Michael Opdenacker
f004fa65c6 contributor-guide: remove obsolete pkg-config guidelines
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>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
16dff2be01 ref-manual: remove AUTHOR variable
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>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
8a00ac35de contributor-guide: add recipe style guide
(From yocto-docs rev: a61a7677adb9bf22dc0d28e72a8fedf2df27e80a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00