diff mbox series

[1/1] MyFirstContribution: configure shallow threads for git format-patch

Message ID e197cbd28135df5523ff5ba1688566edb831f037.1701927372.git.stanhu@gmail.com (mailing list archive)
State New, archived
Headers show
Series MyFirstContribution: configure shallow threads for git format-patch | expand

Commit Message

Stan Hu Dec. 7, 2023, 5:46 a.m. UTC
Most users on the Git mailing list prefers to use of shallow threads,
but this preference was not documented. This commit adds a blurb about
how to configure this globally via `git config`.

Signed-off-by: Stan Hu <stanhu@gmail.com>
---
 Documentation/MyFirstContribution.txt | 11 +++++++++++
 1 file changed, 11 insertions(+)

Comments

Junio C Hamano Dec. 8, 2023, 6:06 p.m. UTC | #1
Stan Hu <stanhu@gmail.com> writes:

> +[[configure-shallow-threads]]
> +=== Configuring shallow threads for `git format-patch`
> +
> +It is common practice on the Git mailing list to use "shallow" threads,
> +where every mail is a reply to the first mail of the series. You can
> +configure the default threading style of `git format-patch` via:
> +
> +-----
> +$ git config format.thread shallow
> +----


Hmph, I do not think I have such an option defined, yet I send out
my series as "shallow" threads.  I think the new description is
somewhat misleading as-is.  Isn't it applicable ONLY to those who
let "format-patch" decide the message ID for patches?  If the user
lets "git send-email" assign the message IDs (and hence the thread
structure), the configuration variable would not apply, no?
diff mbox series

Patch

diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index 7cfed60c2e..3ac7455b1d 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -1004,6 +1004,17 @@  determine the right way to configure it to use your SMTP server; again, as this
 configuration can change significantly based on your system and email setup, it
 is out of scope for the context of this tutorial.
 
+[[configure-shallow-threads]]
+=== Configuring shallow threads for `git format-patch`
+
+It is common practice on the Git mailing list to use "shallow" threads,
+where every mail is a reply to the first mail of the series. You can
+configure the default threading style of `git format-patch` via:
+
+-----
+$ git config format.thread shallow
+----
+
 [[format-patch]]
 === Preparing Initial Patchset