summaryrefslogtreecommitdiffstats
path: root/documentation/contributor-guide
diff options
context:
space:
mode:
authorRoland Hieber <rhi@pengutronix.de>2023-09-22 12:00:04 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-09-25 14:37:26 +0100
commit3dc1dbc22fe7d2468675628d414f689673c72edf (patch)
treeba957340c854601e5d108a410f7c487ea9744538 /documentation/contributor-guide
parent975e974eb1b67e93d5c36492af373c0aa46d206f (diff)
downloadpoky-3dc1dbc22fe7d2468675628d414f689673c72edf.tar.gz
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>
Diffstat (limited to 'documentation/contributor-guide')
-rw-r--r--documentation/contributor-guide/recipe-style-guide.rst30
1 files changed, 14 insertions, 16 deletions
diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst
index 5cbcb23b3a..7e336a0424 100644
--- a/documentation/contributor-guide/recipe-style-guide.rst
+++ b/documentation/contributor-guide/recipe-style-guide.rst
@@ -314,22 +314,20 @@ following status strings:
314 314
315``Inappropriate [reason]`` 315``Inappropriate [reason]``
316 The patch is not appropriate for upstream, include a brief reason on the 316 The patch is not appropriate for upstream, include a brief reason on the
317 same line enclosed with ``[]``. The reason can be: 317 same line enclosed with ``[]``. In the past, there were several different
318 318 reasons not to submit patches upstream, but we have to consider that every
319 - ``not author`` (you are not the author and do not intend to upstream this, 319 non-upstreamed patch means a maintainance burden for recipe maintainers.
320 the source must be listed in the comments) 320 Currently, the only reasons to mark patches as inappropriate for upstream
321 - ``native`` 321 submission are:
322 - ``licensing`` 322
323 - ``configuration`` 323 - ``oe specific``: the issue is specific to how OpenEmbedded performs builds
324 - ``enable feature`` 324 or sets things up at runtime, and can be resolved only with a patch that
325 - ``disable feature`` 325 is not however relevant or appropriate for general upstream submission.
326 - ``bugfix`` (add bug URL here) 326 - ``upstream ticket <link>``: the issue is not specific to Open-Embedded
327 - ``embedded specific`` 327 and should be fixed upstream, but the patch in its current form is not
328 - ``other`` (give details in comments) 328 suitable for merging upstream, and the author lacks sufficient expertise
329 329 to develop a proper patch. Instead the issue is handled via a bug report
330The various ``Inappropriate [reason]`` status items are meant to indicate that 330 (include link).
331the person responsible for adding this patch to the system does not intend to
332upstream the patch for a specific reason.
333 331
334Of course, if another person later takes care of submitting this patch upstream, 332Of course, if another person later takes care of submitting this patch upstream,
335the status should be changed to ``Submitted [where]``, and an additional 333the status should be changed to ``Submitted [where]``, and an additional