Commit Graph

17 Commits

Author SHA1 Message Date
Quentin Schulz
c243b5649b manuals: refer to new yocto-patches mailing list wherever appropriate
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>
2024-04-19 04:50:39 -07:00
Martin Jansa
28cd826b57 contributor-guide: be more specific about meta-* trees
* 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>
2024-04-05 07:24:00 -07:00
Simone Weiß
ccb4e6abb4 contributor-guide: add notes for tests
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>
2024-03-25 04:11:26 -10:00
Baruch Siach
11266e7f8c contributor-guide: fix lore URL
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>
2024-02-09 03:46:50 -10:00
Michael Opdenacker
ae249a900f contributor-guide: use "apt" instead of "aptitude"
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>
2024-01-24 04:04:55 -10:00
Michael Opdenacker
3a5ddec4d1 contributor-guide: fix command option
"--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>
2023-12-21 06:14:00 -10:00
Justin Bronder
d00aada1d1 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: 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>
2023-12-21 06:14:00 -10:00
Roland Hieber
ef5214f584 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: 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>
2023-10-07 05:39:59 -10:00
Roland Hieber
bf72cdd748 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: 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>
2023-10-07 05:39:59 -10:00
Roland Hieber
fbbe0f86ba 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: 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>
2023-10-07 05:39:59 -10:00
Roland Hieber
f06b171bee 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: 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>
2023-10-07 05:39:59 -10:00
Roland Hieber
96d8a62454 contributor-guide: recipe-style-guide: add more patch tagging examples
(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>
2023-10-07 05:39:59 -10:00
Richard Purdie
7ffedb40a1 contributor-guide/style-guide: Add a note about task idempotence
(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>
2023-10-07 05:39:59 -10:00
Richard Purdie
1c8f2d8cad 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: 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>
2023-10-07 05:39:59 -10:00
Michael Opdenacker
593618f139 contributor-guide: recipe-style-guide: add Upstream-Status
(From yocto-docs rev: 0618611fa049db2b9717cbe609c583a5bb16954e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-09-23 05:26:16 -10:00
Michael Opdenacker
b099a1c252 manuals: update former references to dev-manual/common-tasks
(From yocto-docs rev: f8bb4c392912f15bb78f6f25910f85897abb4e3d)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-09-23 05:26:16 -10:00
Michael Opdenacker
5d822b3131 manuals: add new contributor guide
(From yocto-docs rev: 028a1b89fbb6ee7f02a7ca8cd481931e096d764b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2023-09-08 16:09:42 -10:00