Git development
 help / color / mirror / Atom feed
From: Okhuomon Ajayi <okhuomonajayi54@gmail.com>
To: git@vger.kernel.org
Subject: [PATCH v4] doc: wrap emailed text to a maximum of 72 columns
Date: Fri, 20 Nov 2026 23:42:27 +0100	[thread overview]
Message-ID: <20261120224227.932-1-okhuomonajayi54@gmail.com> (raw)
In-Reply-To: <20261120110215.42209-1-okhuomonajayi54@gmail.com>

CodingGuidelines, SubmittingPatches, and ReviewingGuidelines do
not say how long an emailed line should be, or that there should
be paragraph breaks for readability.

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. Lines in
a paragraph stay within that length, and a blank line signals a
new paragraph. Tell readers to leave a blank line between
paragraphs. A block of quoted text counts as a paragraph, so
tell them to leave a blank line before and after it, too.

Signed-off-by: Okhuomon Ajayi <okhuomonajayi54@gmail.com>
---
Changes since v3:
- Say why a blank line marks a new paragraph, and tell readers
  to leave one.
- Say "human-to-human" text instead of "patch message", so this
  is not read as wrapping diff lines.
- Say "before and after it, too" for a block of quoted text.

 Documentation/CodingGuidelines         | 8 ++++++++
 Documentation/ReviewingGuidelines.adoc | 6 ++++++
 Documentation/SubmittingPatches        | 6 ++++++
 3 files changed, 20 insertions(+)

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 23a4d2186a..ff4829e8da 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -33,6 +33,14 @@ 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 intended for human-to-human communication, like
+   log messages, explanations in cover letters, review comments
+   and their responses, 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, too.
+
  - 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..dd164e0010 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, too.
+
 - 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..747e6adc79 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, too.
+
 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


  parent reply	other threads:[~2026-11-20 22:42 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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
2026-11-20 22:35       ` Okhuomon Ajayi
2026-11-20 22:42     ` Okhuomon Ajayi [this message]
2026-11-20 22:56       ` [PATCH v4] " Junio C Hamano

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=20261120224227.932-1-okhuomonajayi54@gmail.com \
    --to=okhuomonajayi54@gmail.com \
    --cc=git@vger.kernel.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