diff options
| author | Junio C Hamano <gitster@pobox.com> | 2023-10-18 13:25:41 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2023-10-18 13:25:41 -0700 |
| commit | 0bc6bff9d5a44120782d3edc24b3fde62e37f6cc (patch) | |
| tree | 3148656178c73973dde71375e312592e7c77fa82 | |
| parent | 79861babe2d58387cd50010c9c63e4ef95afeb12 (diff) | |
| parent | 1627e6b4e4b41d25443cc9abf5b09f58153d6f09 (diff) | |
| download | git-0bc6bff9d5a44120782d3edc24b3fde62e37f6cc.tar.gz | |
Merge branch 'xz/commit-title-soft-limit-doc'
Doc update.
* xz/commit-title-soft-limit-doc:
doc: correct the 50 characters soft limit (+)
| -rw-r--r-- | Documentation/gittutorial.txt | 8 | ||||
| -rw-r--r-- | Documentation/user-manual.txt | 2 | ||||
| -rw-r--r-- | po/README.md | 2 |
3 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt index c7cadd8aaf..4759408788 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 4281396093..d8dbe6b56d 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 3e4f897d93..ec08aa24ad 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 |