doc: correct the 50 characters soft limit (+)

Commit Message

谢致邦 (XIE Zhibang) Oct. 8, 2023, 2:10 p.m. UTC

From: =?UTF-8?q?=E8=B0=A2=E8=87=B4=E9=82=A6=20=28XIE=20Zhibang=29?=
 <[e-mail]>

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".

This is an addition to commit c2c349a15c0430a2ef9f858d69d095a00693379c
("doc: correct the 50 characters soft limit").

Signed-off-by: 谢致邦 (XIE Zhibang) <[e-mail]>
---
    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".
    
    This is an addition to commit c2c349a15c0430a2ef9f858d69d095a00693379c
    ("doc: correct the 50 characters soft limit").

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

 Documentation/gittutorial.txt | 8 ++++----
 Documentation/user-manual.txt | 2 +-
 po/README.md                  | 2 +-
 3 files changed, 6 insertions(+), 6 deletions(-)


base-commit: 3a06386e314565108ad56a9bdb8f7b80ac52fb69

Comments

Kristoffer Haugsbakk Oct. 8, 2023, 2:37 p.m. UTC | #1

Hi 謝致邦

On Sun, Oct 8, 2023, at 16:10, 謝致邦 (XIE Zhibang) via GitGitGadget wrote:
> This is an addition to commit c2c349a15c0430a2ef9f858d69d095a00693379c
> ("doc: correct the 50 characters soft limit").

I think the “reference” format is nice:

    c2c349a15c (doc: correct the 50 characters soft limit, 2023-09-28)

See `Documentation/SubmittingPatches` at `commit-reference`.

Patch

diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt
index c7cadd8aaf1..47594087880 100644
--- a/Documentation/gittutorial.txt
+++ b/Documentation/gittutorial.txt
@@ -137,10 +137,10 @@  which will automatically notice any modified (but not new) files, add
 them to the index, and commit, all in one step.
 
 A note on commit messages: Though not required, it's a good idea to
-begin the commit message with a single short (less than 50 character)
-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
+begin the commit message 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.  For example, linkgit:git-format-patch[1] turns a
 commit into email, and it uses the title on the Subject line and the
 rest of the commit in the body.
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 4281396093d..d8dbe6b56d4 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -1122,7 +1122,7 @@  choosing "Stage Hunk For Commit").
 === Creating good commit messages
 
 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
diff --git a/po/README.md b/po/README.md
index 3e4f897d935..ec08aa24add 100644
--- a/po/README.md
+++ b/po/README.md
@@ -412,7 +412,7 @@  There are some conventions that l10n contributors must follow:
 - Do not use non-ASCII characters in the subject of a commit.
 
 - The length of commit subject (first line of the commit log) should
-  be less than 50 characters, and the length of other lines of the
+  be no more than 50 characters, and the length of other lines of the
   commit log should be no more than 72 characters.
 
 - Add "Signed-off-by" trailer to your commit log, like other commits