* [PATCH] doc: wrap emailed text near 70 columns
@ 2026-11-19 10:53 Okhuomon Ajayi
2026-11-19 22:20 ` Junio C Hamano
2026-11-20 5:59 ` [PATCH v2] " Okhuomon Ajayi
0 siblings, 2 replies; 8+ messages in thread
From: Okhuomon Ajayi @ 2026-11-19 10:53 UTC (permalink / raw)
To: git
CodingGuidelines, SubmittingPatches, and ReviewingGuidelines do
not say how long an emailed line should be. State the limit in
each: keep the text near 70 columns so it still fits on an
80-column terminal after a few levels of quoting.
Signed-off-by: Okhuomon Ajayi <okhuomonajayi54@gmail.com>
---
Documentation/CodingGuidelines | 4 ++++
Documentation/ReviewingGuidelines.adoc | 3 +++
Documentation/SubmittingPatches | 4 ++++
3 files changed, 11 insertions(+)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 23a4d2186a..a0cc5a050d 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -33,6 +33,10 @@ Git in general, a few rough rules are:
achieve and why the changes were necessary (more on this in the
accompanying SubmittingPatches document).
+ - E-mailed text, including a patch message and a review reply, is
+ kept near 70 columns, so it still fits on an 80-column terminal
+ after being quoted a few times.
+
- A label "NEEDSWORK:" followed by a description of the things to
be done is a way to leave in-code comments to document design
decisions yet to be made. 80% of the work to resolve a NEEDSWORK
diff --git a/Documentation/ReviewingGuidelines.adoc b/Documentation/ReviewingGuidelines.adoc
index 6534643cff..8770f0597c 100644
--- a/Documentation/ReviewingGuidelines.adoc
+++ b/Documentation/ReviewingGuidelines.adoc
@@ -116,6 +116,9 @@ guidance, and concrete tips for interacting with patches on the mailing list.
unrelated to your review from the email reply. Make sure to leave enough
context for readers to understand your comments!
+- Wrap a review reply so it still fits on an 80-column terminal after
+ being quoted a few times. Around 70 columns is a comfortable limit.
+
- If you cannot complete a full review of a series all at once, consider letting
the author know (on- or off-list) if/when you plan to review the rest of the
series.
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index c60855f706..2525cc7e20 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -700,6 +700,10 @@ WARNING: Be wary of your MUAs word-wrap
corrupting your patch. Do not cut-n-paste your patch; you can
lose tabs that way if you are not careful.
+Wrap the prose you send so it still fits on an 80-column terminal
+after being quoted a few times. Around 70 columns is a comfortable
+limit.
+
It is a common convention to prefix your subject line with
[PATCH]. This lets people easily distinguish patches from other
e-mail discussions. Use of markers in addition to PATCH within
base-commit: 7fb6055e678f800320d8ab8cd8f201d9493d1ba0
--
2.56.0
^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [PATCH] doc: wrap emailed text near 70 columns
2026-11-19 10:53 [PATCH] doc: wrap emailed text near 70 columns Okhuomon Ajayi
@ 2026-11-19 22:20 ` Junio C Hamano
2026-11-19 22:26 ` Okhuomon Ajayi
2026-11-20 5:59 ` [PATCH v2] " Okhuomon Ajayi
1 sibling, 1 reply; 8+ messages in thread
From: Junio C Hamano @ 2026-11-19 22:20 UTC (permalink / raw)
To: Okhuomon Ajayi; +Cc: git
Okhuomon Ajayi <okhuomonajayi54@gmail.com> writes:
> CodingGuidelines, SubmittingPatches, and ReviewingGuidelines do
> not say how long an emailed line should be. State the limit in
> each: keep the text near 70 columns so it still fits on an
> 80-column terminal after a few levels of quoting.
Thanks, but then why not also suggest to use these inter-paragraph
blank lines?
>
> Signed-off-by: Okhuomon Ajayi <okhuomonajayi54@gmail.com>
> ---
> Documentation/CodingGuidelines | 4 ++++
> Documentation/ReviewingGuidelines.adoc | 3 +++
> Documentation/SubmittingPatches | 4 ++++
> 3 files changed, 11 insertions(+)
>
> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> index 23a4d2186a..a0cc5a050d 100644
> --- a/Documentation/CodingGuidelines
> +++ b/Documentation/CodingGuidelines
> @@ -33,6 +33,10 @@ Git in general, a few rough rules are:
> achieve and why the changes were necessary (more on this in the
> accompanying SubmittingPatches document).
>
> + - E-mailed text, including a patch message and a review reply, is
> + kept near 70 columns, so it still fits on an 80-column terminal
> + after being quoted a few times.
> +
> - A label "NEEDSWORK:" followed by a description of the things to
> be done is a way to leave in-code comments to document design
> decisions yet to be made. 80% of the work to resolve a NEEDSWORK
> diff --git a/Documentation/ReviewingGuidelines.adoc b/Documentation/ReviewingGuidelines.adoc
> index 6534643cff..8770f0597c 100644
> --- a/Documentation/ReviewingGuidelines.adoc
> +++ b/Documentation/ReviewingGuidelines.adoc
> @@ -116,6 +116,9 @@ guidance, and concrete tips for interacting with patches on the mailing list.
> unrelated to your review from the email reply. Make sure to leave enough
> context for readers to understand your comments!
>
> +- Wrap a review reply so it still fits on an 80-column terminal after
> + being quoted a few times. Around 70 columns is a comfortable limit.
> +
> - If you cannot complete a full review of a series all at once, consider letting
> the author know (on- or off-list) if/when you plan to review the rest of the
> series.
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> index c60855f706..2525cc7e20 100644
> --- a/Documentation/SubmittingPatches
> +++ b/Documentation/SubmittingPatches
> @@ -700,6 +700,10 @@ WARNING: Be wary of your MUAs word-wrap
> corrupting your patch. Do not cut-n-paste your patch; you can
> lose tabs that way if you are not careful.
>
> +Wrap the prose you send so it still fits on an 80-column terminal
> +after being quoted a few times. Around 70 columns is a comfortable
> +limit.
> +
> It is a common convention to prefix your subject line with
> [PATCH]. This lets people easily distinguish patches from other
> e-mail discussions. Use of markers in addition to PATCH within
>
> base-commit: 7fb6055e678f800320d8ab8cd8f201d9493d1ba0
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] doc: wrap emailed text near 70 columns
2026-11-19 22:20 ` Junio C Hamano
@ 2026-11-19 22:26 ` Okhuomon Ajayi
0 siblings, 0 replies; 8+ messages in thread
From: Okhuomon Ajayi @ 2026-11-19 22:26 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git
On Thu, Nov 19, 2026 at 11:20 PM Junio C Hamano <gitster@pobox.com> wrote:
> Thanks, but then why not also suggest to use these inter-paragraph
> blank lines?
The blank-line rule is already in the MyFirstContribution patch
you queued, so I left it out of this one to avoid repeating it.
I'll add it next to the line-length limit in these three
documents and resend.
Thanks,
Okhuomon
^ permalink raw reply [flat|nested] 8+ messages in thread
* [PATCH v2] doc: wrap emailed text near 70 columns
2026-11-19 10:53 [PATCH] doc: wrap emailed text near 70 columns Okhuomon Ajayi
2026-11-19 22:20 ` Junio C Hamano
@ 2026-11-20 5:59 ` Okhuomon Ajayi
2026-11-20 10:07 ` Andy Koppe
2026-11-20 11:02 ` [PATCH v3] doc: wrap emailed text to a maximum of 72 columns Okhuomon Ajayi
1 sibling, 2 replies; 8+ messages in thread
From: Okhuomon Ajayi @ 2026-11-20 5:59 UTC (permalink / raw)
To: git
CodingGuidelines, SubmittingPatches, and ReviewingGuidelines do
not say how long an emailed line should be. State the limit in
each: keep the text near 70 columns so it still fits on an
80-column terminal after a few levels of quoting. Leave a blank
line between paragraphs. A block of quoted text counts as a
paragraph.
Signed-off-by: Okhuomon Ajayi <okhuomonajayi54@gmail.com>
---
Changes since v1:
- Also say to leave a blank line between paragraphs. A block of
quoted text counts as a paragraph.
Documentation/CodingGuidelines | 6 ++++++
Documentation/ReviewingGuidelines.adoc | 5 +++++
Documentation/SubmittingPatches | 6 ++++++
3 files changed, 17 insertions(+)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 23a4d2186a..414ecc444d 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -33,6 +33,12 @@ Git in general, a few rough rules are:
achieve and why the changes were necessary (more on this in the
accompanying SubmittingPatches document).
+ - E-mailed text, including a patch message and a review reply, is
+ kept near 70 columns, so it still fits on an 80-column terminal
+ after being quoted a few times. Leave a blank line between
+ paragraphs. A block of quoted text counts as a paragraph, so
+ leave a blank line before and after it.
+
- A label "NEEDSWORK:" followed by a description of the things to
be done is a way to leave in-code comments to document design
decisions yet to be made. 80% of the work to resolve a NEEDSWORK
diff --git a/Documentation/ReviewingGuidelines.adoc b/Documentation/ReviewingGuidelines.adoc
index 6534643cff..51da873840 100644
--- a/Documentation/ReviewingGuidelines.adoc
+++ b/Documentation/ReviewingGuidelines.adoc
@@ -116,6 +116,11 @@ guidance, and concrete tips for interacting with patches on the mailing list.
unrelated to your review from the email reply. Make sure to leave enough
context for readers to understand your comments!
+- Wrap a review reply so it still fits on an 80-column terminal after
+ being quoted a few times. Around 70 columns is a comfortable limit.
+ Leave a blank line between paragraphs. A block of quoted text counts
+ as a paragraph, so leave a blank line before and after it.
+
- If you cannot complete a full review of a series all at once, consider letting
the author know (on- or off-list) if/when you plan to review the rest of the
series.
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index c60855f706..9313349bdd 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -700,6 +700,12 @@ WARNING: Be wary of your MUAs word-wrap
corrupting your patch. Do not cut-n-paste your patch; you can
lose tabs that way if you are not careful.
+Wrap the prose you send so it still fits on an 80-column terminal
+after being quoted a few times. Around 70 columns is a comfortable
+limit. Leave a blank line between paragraphs. A block of quoted
+text counts as a paragraph, so leave a blank line before and after
+it.
+
It is a common convention to prefix your subject line with
[PATCH]. This lets people easily distinguish patches from other
e-mail discussions. Use of markers in addition to PATCH within
base-commit: 7fb6055e678f800320d8ab8cd8f201d9493d1ba0
--
2.56.0
^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [PATCH v2] doc: wrap emailed text near 70 columns
2026-11-20 5:59 ` [PATCH v2] " Okhuomon Ajayi
@ 2026-11-20 10:07 ` Andy Koppe
2026-11-20 10:26 ` Okhuomon Ajayi
2026-11-20 11:02 ` [PATCH v3] doc: wrap emailed text to a maximum of 72 columns Okhuomon Ajayi
1 sibling, 1 reply; 8+ messages in thread
From: Andy Koppe @ 2026-11-20 10:07 UTC (permalink / raw)
To: Okhuomon Ajayi; +Cc: git
Okhuomon Ajayi wrote:
> CodingGuidelines, SubmittingPatches, and ReviewingGuidelines do
> not say how long an emailed line should be. State the limit in
> each: keep the text near 70 columns so it still fits on an
> 80-column terminal after a few levels of quoting.
I'd say "to a maximum of 72 columns", to take out the uncertainty and
match the convention for commit messages, which of course are quoted
in the same way in replies.
Andy
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH v2] doc: wrap emailed text near 70 columns
2026-11-20 10:07 ` Andy Koppe
@ 2026-11-20 10:26 ` Okhuomon Ajayi
0 siblings, 0 replies; 8+ messages in thread
From: Okhuomon Ajayi @ 2026-11-20 10:26 UTC (permalink / raw)
To: Andy Koppe; +Cc: git
On Fri, Nov 20, 2026 at 11:08 AM Andy Koppe <andy.koppe@gmail.com> wrote:
> I'd say "to a maximum of 72 columns", to take out the uncertainty and
> match the convention for commit messages, which of course are quoted
> in the same way in replies.
Agreed. "Near 70" leaves the width unclear. I'll resend with a
maximum of 72 columns, matching the commit message convention.
Thanks,
Okhuomon
^ permalink raw reply [flat|nested] 8+ messages in thread
* [PATCH v3] doc: wrap emailed text to a maximum of 72 columns
2026-11-20 5:59 ` [PATCH v2] " Okhuomon Ajayi
2026-11-20 10:07 ` Andy Koppe
@ 2026-11-20 11:02 ` Okhuomon Ajayi
2026-11-20 17:58 ` Junio C Hamano
1 sibling, 1 reply; 8+ messages in thread
From: Okhuomon Ajayi @ 2026-11-20 11:02 UTC (permalink / raw)
To: git
CodingGuidelines, SubmittingPatches, and ReviewingGuidelines do
not say how long an emailed line should be. State the limit in
each: wrap the text to a maximum of 72 columns, matching the
commit message convention, so it still fits on an 80-column
terminal after a few levels of quoting. Leave a blank line
between paragraphs. A block of quoted text counts as a paragraph.
Signed-off-by: Okhuomon Ajayi <okhuomonajayi54@gmail.com>
---
Changes since v2:
- Use a maximum of 72 columns, matching the commit message
convention, instead of "near 70".
Documentation/CodingGuidelines | 7 +++++++
Documentation/ReviewingGuidelines.adoc | 6 ++++++
Documentation/SubmittingPatches | 6 ++++++
3 files changed, 19 insertions(+)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 23a4d2186a..c5bb6ce120 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -33,6 +33,13 @@ Git in general, a few rough rules are:
achieve and why the changes were necessary (more on this in the
accompanying SubmittingPatches document).
+ - E-mailed text, including a patch message and a review reply, is
+ wrapped to a maximum of 72 columns, matching the commit message
+ convention, so it still fits on an 80-column terminal after being
+ quoted a few times. Leave a blank line between paragraphs. A
+ block of quoted text counts as a paragraph, so leave a blank line
+ before and after it.
+
- A label "NEEDSWORK:" followed by a description of the things to
be done is a way to leave in-code comments to document design
decisions yet to be made. 80% of the work to resolve a NEEDSWORK
diff --git a/Documentation/ReviewingGuidelines.adoc b/Documentation/ReviewingGuidelines.adoc
index 6534643cff..be15ea6fda 100644
--- a/Documentation/ReviewingGuidelines.adoc
+++ b/Documentation/ReviewingGuidelines.adoc
@@ -116,6 +116,12 @@ guidance, and concrete tips for interacting with patches on the mailing list.
unrelated to your review from the email reply. Make sure to leave enough
context for readers to understand your comments!
+- Wrap a review reply to a maximum of 72 columns, matching the commit
+ message convention, so it still fits on an 80-column terminal after
+ being quoted a few times. Leave a blank line between paragraphs. A
+ block of quoted text counts as a paragraph, so leave a blank line
+ before and after it.
+
- If you cannot complete a full review of a series all at once, consider letting
the author know (on- or off-list) if/when you plan to review the rest of the
series.
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index c60855f706..94a33b9421 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -700,6 +700,12 @@ WARNING: Be wary of your MUAs word-wrap
corrupting your patch. Do not cut-n-paste your patch; you can
lose tabs that way if you are not careful.
+Wrap the prose you send to a maximum of 72 columns, matching the
+commit message convention, so it still fits on an 80-column terminal
+after being quoted a few times. Leave a blank line between
+paragraphs. A block of quoted text counts as a paragraph, so leave
+a blank line before and after it.
+
It is a common convention to prefix your subject line with
[PATCH]. This lets people easily distinguish patches from other
e-mail discussions. Use of markers in addition to PATCH within
base-commit: 7fb6055e678f800320d8ab8cd8f201d9493d1ba0
--
2.56.0
^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [PATCH v3] doc: wrap emailed text to a maximum of 72 columns
2026-11-20 11:02 ` [PATCH v3] doc: wrap emailed text to a maximum of 72 columns Okhuomon Ajayi
@ 2026-11-20 17:58 ` Junio C Hamano
0 siblings, 0 replies; 8+ messages in thread
From: Junio C Hamano @ 2026-11-20 17:58 UTC (permalink / raw)
To: Okhuomon Ajayi; +Cc: git
Okhuomon Ajayi <okhuomonajayi54@gmail.com> writes:
> CodingGuidelines, SubmittingPatches, and ReviewingGuidelines do
> not say how long an emailed line should be.
This initial observation of the status quo is given clearly, which
makes an easy introduction for readers to the issue you are
addressing.
> State the limit in
> each: wrap the text to a maximum of 72 columns, matching the
> commit message convention, so it still fits on an 80-column
> terminal after a few levels of quoting.
The above says what we do and why we do so. In a proposed log
message, the latter is more important.
> Leave a blank line
> between paragraphs. A block of quoted text counts as a paragraph.
Contrasted with the above, this lacks the "why", and is written with
a funny verb. "State the limit..." was an instruction to the
imaginary person who is making the change to our sources, which is
the "imperative mood" convention our SubmittingPatches specifies.
But "Leave a blank line" is an instruction that the imaginary person
is adding. You need to tell that person to tell our readers to do
so. Something like
Tell readers to leave a blank line between paragraphs.
In order to properly give the "why", we'd need to go back to the
initial observation and say that these three documents do not say
that there should be paragraph breaks for readability.
Side note: if your convention is "each single long line is a
paragraph", then there is no need for a paragraph break. That
seems to be the common format LLMs produce.
But our convention is "lines in a paragraph are limited to a
comfortable length of 72 columns, and the beginning of a new
paragraph is signaled by a blank line". In other words, line
length limits and paragraph breaks go hand in hand.
> + - E-mailed text, including a patch message and a review reply, is
> + wrapped to a maximum of 72 columns, matching the commit message
The phrase "patch message" is not used elsewhere in Documentation/.
We use phrases like "log message", "commit message", and "cover
letter". We do not want to use the word "patch" here to avoid
giving a misleading hint to line-wrap diff lines in a patch ;-)
- E-mailed text intended for human-to-human communication, like
log messages, explanations in cover letters, review comments
and their responses, is wrapped to ...
> diff --git a/Documentation/ReviewingGuidelines.adoc b/Documentation/ReviewingGuidelines.adoc
>
> +- Wrap a review reply to a maximum of 72 columns, matching the commit
> + message convention, so it still fits on an 80-column terminal after
> + being quoted a few times. Leave a blank line between paragraphs. A
> + block of quoted text counts as a paragraph, so leave a blank line
> + before and after it.
"before and after it, too."? I personally do not see a need to
specifically say ">" quoted text and what you write in response
to that quoted part are different paragraph, but some people may
need to be told, I guess.
Thanks.
^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2026-11-20 17:58 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-19 10:53 [PATCH] doc: wrap emailed text near 70 columns Okhuomon Ajayi
2026-11-19 22:20 ` Junio C Hamano
2026-11-19 22:26 ` Okhuomon Ajayi
2026-11-20 5:59 ` [PATCH v2] " Okhuomon Ajayi
2026-11-20 10:07 ` Andy Koppe
2026-11-20 10:26 ` Okhuomon Ajayi
2026-11-20 11:02 ` [PATCH v3] doc: wrap emailed text to a maximum of 72 columns Okhuomon Ajayi
2026-11-20 17:58 ` Junio C Hamano
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.