Git development
 help / color / mirror / Atom feed
From: Tuomas Ahola <taahol@utu.fi>
To: Patrick Steinhardt <ps@pks.im>
Cc: <git@vger.kernel.org>, Junio C Hamano <gitster@pobox.com>,
	Weijie Yuan <wy@wyuan.org>,
	Ramsay Jones <ramsay@ramsayjones.plus.com>
Subject: Re: [PATCH v2 1/3] Documentation/MyFirstContribution: recommend shallow threading
Date: Wed, 3 Jun 2026 13:01:45 +0300	[thread overview]
Message-ID: <20260603100145.7iym5%taahol@utu.fi> (raw)
In-Reply-To: <20260603-pks-b4-v2-1-a8aea0aa2c23@pks.im>

Patrick Steinhardt <ps@pks.im> wrote:

> The "MyFirstContribution" document recommends the use of deep threading:
> every cover letter of subsequent iterations shall be linked to the cover
> letter of the preceding version. The result of this is that eventually,
> threads with many versions are getting nested so deep that it becomes
> hard to follow.
> 
> Adapt the recommendation to instead propose shallow threading: instead
> of linking the cover letter to the previous cover letter, the user is
> supposed to always link it to the first cover letter. This still makes
> it easy to follow the iterations, but has the benefit of nesting to a
> much shallower level.
> 
> Signed-off-by: Patrick Steinhardt <ps@pks.im>
> ---
>  Documentation/MyFirstContribution.adoc | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
> index b9fdefce02..069020196c 100644
> --- a/Documentation/MyFirstContribution.adoc
> +++ b/Documentation/MyFirstContribution.adoc
> @@ -1227,8 +1227,8 @@ Message-ID: <foo.12345.author@example.com>
>  
>  Your Message-ID is `<foo.12345.author@example.com>`. This example will be used
>  below as well; make sure to replace it with the correct Message-ID for your
> -**previous cover letter** - that is, if you're sending v2, use the Message-ID
> -from v1; if you're sending v3, use the Message-ID from v2.
> +**first cover letter** - that is, for any subsequent version that you send,
> +always use the Message-ID from v1.
>  
>  While you're looking at the email, you should also note who is CC'd, as it's
>  common practice in the mailing list to keep all CCs on a thread. You can add
> 
> -- 
> 2.54.0.1064.gd145956f57.dirty

If we adapt this change to the guidance, let's fix also other places of the
document that talk about replying to the previous cover letter.

-----8<-----

diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index 069020196c..bf64a211bd 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -790,7 +790,7 @@ We can note a few things:
   v3", etc. in place of "PATCH". For example, "[PATCH v2 1/3]" would be the first of
   three patches in the second iteration. Each iteration is sent with a new cover
   letter (like "[PATCH v2 0/3]" above), itself a reply to the cover letter of the
-  previous iteration (more on that below).
+  first iteration (more on that below).
 
 NOTE: A single-patch topic is sent with "[PATCH]", "[PATCH v2]", etc. without
 _i_/_n_ numbering (in the above thread overview, no single-patch topic appears,
@@ -1214,7 +1214,7 @@ between your last version and now, if it's something significant. You do not
 need the exact same body in your second cover letter; focus on explaining to
 reviewers the changes you've made that may not be as visible.
 
-You will also need to go and find the Message-ID of your previous cover letter.
+You will also need to go and find the Message-ID of your original cover letter.
 You can either note it when you send the first series, from the output of `git
 send-email`, or you can look it up on the
 https://lore.kernel.org/git[mailing list]. Find your cover letter in the

  reply	other threads:[~2026-06-03 10:01 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-02 11:59 [PATCH 0/2] Documentation: recommend the use of b4 Patrick Steinhardt
2026-06-02 11:59 ` [PATCH 1/2] b4: introduce configuration for the Git project Patrick Steinhardt
2026-06-02 13:32   ` Junio C Hamano
2026-06-02 14:56     ` Patrick Steinhardt
2026-06-02 16:23     ` Ramsay Jones
2026-06-03  2:59       ` Junio C Hamano
2026-06-03  6:52         ` Patrick Steinhardt
2026-06-02 17:09   ` Tuomas Ahola
2026-06-03  2:12     ` Weijie Yuan
2026-06-03  6:55       ` Patrick Steinhardt
2026-06-03  7:50         ` Weijie Yuan
2026-06-03  9:51           ` Weijie Yuan
2026-06-03 11:07         ` SZEDER Gábor
2026-06-03 12:23           ` Weijie Yuan
2026-06-03 13:30           ` Tuomas Ahola
2026-06-02 11:59 ` [PATCH 2/2] Documentation/MyFirstContribution: recommend the use of b4 Patrick Steinhardt
2026-06-02 16:09   ` Weijie Yuan
2026-06-03  6:54     ` Patrick Steinhardt
2026-06-03  7:53       ` Weijie Yuan
2026-06-03  8:00         ` Weijie Yuan
2026-06-03  6:58 ` [PATCH v2 0/3] Documentation: " Patrick Steinhardt
2026-06-03  6:58   ` [PATCH v2 1/3] Documentation/MyFirstContribution: recommend shallow threading Patrick Steinhardt
2026-06-03 10:01     ` Tuomas Ahola [this message]
2026-06-03 10:29     ` Weijie Yuan
2026-06-03  6:59   ` [PATCH v2 2/3] Documentation/MyFirstContribution: recommend the use of b4 Patrick Steinhardt
2026-06-03  6:59   ` [PATCH v2 3/3] b4: introduce configuration for the Git project Patrick Steinhardt
2026-06-03 13:58     ` Toon Claes

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=20260603100145.7iym5%taahol@utu.fi \
    --to=taahol@utu.fi \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=ps@pks.im \
    --cc=ramsay@ramsayjones.plus.com \
    --cc=wy@wyuan.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox