[PATCH v2] doc: wrap emailed text near 70 columns
- From
- Okhuomon Ajayi <okhuomonajayi54@gmail.com>
- Date
- Nov 20, 2026, 05:59 UTC
- Message-ID
- <20261120055908.83043-1-okhuomonajayi54@gmail.com>
- In-Reply-To
- <20261119105300.95746-1-okhuomonajayi54@gmail.com>
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