[PATCH] doc: correct the 50 characters soft limit

謝致邦 (XIE Zhibang) via GitGitGadget· Sep 28, 2023, 09:59 UTC · lore

From: =?UTF-8?q?=E8=B0=A2=E8=87=B4=E9=82=A6=20=28XIE=20Zhibang=29?=
 <Yeking@Red54.com>

The soft limit of the first line of the commit message should be "no more than 50 characters" or "50 characters or less", but not "less than 50 character".

Signed-off-by: 谢致邦 (XIE Zhibang) <Yeking@Red54.com>
---
    doc: correct the 50 characters soft limit
    
    The soft limit of the first line of the commit message should be "no
    more than 50 characters" or "50 characters or less", but not "less than
    50 character".

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1580%2FRed54%2Fdoc-patch-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1580/Red54/doc-patch-v1
Pull-Request: https://github.com/git/git/pull/1580

 Documentation/git-commit.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to Documentation/git-commit.txt +1 −1

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 225c6c9f2e5..a6cef5d8203 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -541,7 +541,7 @@ DISCUSSION
 ----------
 
 Though not required, it's a good idea to begin the commit message
-with a single short (less than 50 character) line summarizing the
+with a single short (no more than 50 characters) line summarizing the
 change, followed by a blank line and then a more thorough description.
 The text up to the first blank line in a commit message is treated
 as the commit title, and that title is used throughout Git.

base-commit: bcb6cae2966cc407ca1afc77413b3ef11103c175

-- 
gitgitgadget

Junio C Hamano· Sep 28, 2023, 14:10 UTC · re: 謝致邦 (XIE Zhibang) via GitGitGadget · lore

Re: [PATCH] doc: correct the 50 characters soft limit

"謝致邦 (XIE Zhibang) via GitGitGadget" <gitgitgadget@gmail.com> writes:

> The soft limit of the first line of the commit message should be
> "no more than 50 characters" or "50 characters or less", but not
> "less than 50 character".

The limit being "soft", I highly doubt that anybody would wonder if a title that is exactly 50 columns wide is or is not acceptable.

The updated one is more grammatically correct than the original, so the patch is not without merit, though ;-)

Thanks.

Show 9 quoted lines

> ...
>  Though not required, it's a good idea to begin the commit message
> -with a single short (less than 50 character) line summarizing the
> +with a single short (no more than 50 characters) line summarizing the
>  change, followed by a blank line and then a more thorough description.
>  The text up to the first blank line in a commit message is treated
>  as the commit title, and that title is used throughout Git.
>
> base-commit: bcb6cae2966cc407ca1afc77413b3ef11103c175

patchdoc: correct the 50 characters soft limit