All of lore.kernel.org
 help / color / mirror / Atom feed
From: E Shattow <e@freeshell.de>
To: Ralph Siemsen <ralph.siemsen@linaro.org>,
	u-boot@lists.u-boot-project.org
Cc: Tom Rini <trini@konsulko.com>,
	Quentin Schulz <quentin.schulz@cherry.de>,
	 Neil Armstrong <neil.armstrong@linaro.org>
Subject: Re: [PATCH v4 1/2] doc: develop/sending_patches: add tips for series
Date: Thu, 12 Nov 2026 15:19:18 -0800	[thread overview]
Message-ID: <33c70db1-226a-4108-b690-ad07cecf7752@freeshell.de> (raw)
In-Reply-To: <20261112-doc-sending-patches-v4-1-d6f4b7e3eeba@linaro.org>



On 11/12/26 13:55, Ralph Siemsen wrote:
> Related patches can be grouped into a "patch series". Add some tips on
> how to decide how much belongs into a "patch series".
> 
> Signed-off-by: Ralph Siemsen <ralph.siemsen@linaro.org>
> Reviewed-by: E Shattow <e@freeshell.de>
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
> --
> Changes for v4:
> - spelling fixes
> - add R-b
> - Line to v3: https://patch.msgid.link/20261106-doc-sending-patches-v3-1-86fa7d158cc2@linaro.org
> 
> Changes for v3:
> - explicitly mention keeping bug fixes separate from other changes
> - focus on "keep it small" rather than the exceptions to that rule
> - Link to v2: https://patch.msgid.link/20261104-doc-sending-patches-v2-1-c0a90ff6c049@linaro.org
> 
> Changes for v2:
> - small wording changes to help non-native English speakers
> - add R-b
> 
> Link to v1:
> https://patch.msgid.link/20261028-doc-sending-patches-v1-1-66b0f1b276de@linaro.org
> ---
>  doc/develop/sending_patches.rst | 25 +++++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
> 
> diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst
> index 99581dc0ba0..dd06d4a8968 100644
> --- a/doc/develop/sending_patches.rst
> +++ b/doc/develop/sending_patches.rst
> @@ -184,6 +184,31 @@ General Patch Submission Rules
>    cases, you did something wrong if your patch exceeds this limit. Think again
>    if you should not split it into separate logical parts.
>  
> +Tips for creating patch series
> +------------------------------
> +
> +A series of related patches can be sent as a "patch series", as described
> +above. Individual patches should be small and self-contained. Likewise,
> +this also applies to each "patch series". Keep the following in mind:
> +
> +* large series are harder to review. Maintainers are busy and may postpone

This reads a bit awkwardly. Maybe "A large series is harder to review"
or "large series patches are harder to review", depending on what the
meaning is you are wanting to convey.

Either seems to me like injecting your opinion about what is easy or
difficult to review which does not align with my view of this that the
difficulty in reviewing a patch series is proportional to the discipline
in focus the author has for presenting their idea and developing it to a
meaningful change with the assistance of code review;  if it will
require a great deal of involvement then don't expect to just dump your
code off on the list and have it be merged because you gave this "gift"
of 100+ small patches in a series, or even a single patch large-or-small
that is several disjointed ideas or bug fixes.

> +  large reviews, whereas smaller reviews are more easily accommodated.
> +
> +* bug fixes should not be part of a larger series, so that the fixes can
> +  get reviewed and merged quickly.

Nothing happens "quickly". The point of bug fixes being independent is
so they can be reviewed and verified independently from unrelated
changes. Quickness is not the driver of getting merged or not merged, or
it should not be.

> +
> +* tools like ``b4`` and ``patman`` send the entire patch series to all

Do correct me if I am mistaken: for consistency I think we are
recommending people use b4 and patman, and not tools similar to these.

> +  reviewers, even though individual reviews may only care about some parts.
> +  Filtering out the relevant parts takes time away from actual reviews.
> +

What is an "actual review" ? That sounds so strange.

> +Therefore large series should be broken into smaller sub-series, for example by
> +subsystem (clock, pinctrl, reset, etc.). This allows better targeting of only
> +the relevant reviewers for each sub-series. Finding the right granularity can
> +be difficult, but when in doubt, aim for smaller changes.
> +
> +Overall, the goal is to make changes easily understood by reviewers, as well
> +as the next person who works on the code.
> +
>  Attributing Code, Copyrights, Signing
>  -------------------------------------
>  
> 

Drop my R-by tag, thanks. -E

  reply	other threads:[~2026-11-12 23:19 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-12 21:55 [PATCH v4 0/2] doc: tips for submitting patch series Ralph Siemsen
2026-11-12 21:55 ` [PATCH v4 1/2] doc: develop/sending_patches: add tips for series Ralph Siemsen
2026-11-12 23:19   ` E Shattow [this message]
2026-11-13 13:42     ` Quentin Schulz
2026-11-17 19:31     ` Ralph Siemsen
2026-11-12 21:55 ` [PATCH v4 2/2] doc: CONTRIBUTE: minor spelling and link Ralph Siemsen
2026-11-13 13:42   ` Quentin Schulz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=33c70db1-226a-4108-b690-ad07cecf7752@freeshell.de \
    --to=e@freeshell.de \
    --cc=neil.armstrong@linaro.org \
    --cc=quentin.schulz@cherry.de \
    --cc=ralph.siemsen@linaro.org \
    --cc=trini@konsulko.com \
    --cc=u-boot@lists.u-boot-project.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.