diff options
author | Jim Meyering <meyering@redhat.com> | 2009-06-03 18:28:34 +0200 |
---|---|---|
committer | Jim Meyering <meyering@redhat.com> | 2009-06-03 18:30:40 +0200 |
commit | d8243c25cdfa90c86b3629f3b723c2d2962e2a22 (patch) | |
tree | e1a141c1494ce4e9445f4c493fda32fdf1d0eb87 /HACKING | |
parent | 59400b28844306d2fc3f291c4243fbdef80416b9 (diff) | |
download | coreutils-d8243c25cdfa90c86b3629f3b723c2d2962e2a22.tar.xz |
doc: HACKING: minor adjustments, additions
* HACKING (Amending...): Remove spurious "-e" used with commit --amend.
(log message policy): Mention the 72-column limit.
"build:" and "maint:" are common prefixes, these days.
Diffstat (limited to 'HACKING')
-rw-r--r-- | HACKING | 8 |
1 files changed, 6 insertions, 2 deletions
@@ -189,7 +189,7 @@ branch, and then realize that something about it is not right. It's easy to adjust: edit your files # this can include running "git add NEW" or "git rm BAD" - git commit --amend -e -a + git commit --amend -a git format-patch --stdout -1 > your-branch.diff That replaces the most recent change-set with the revised one. @@ -214,7 +214,9 @@ Commit log requirements Your commit log should always start with a one-line summary, the second line should be blank, and the remaining lines are usually ChangeLog-style entries for all affected files. Omit the leading TABs that you're used -to seeing in a "real" ChangeLog file. +to seeing in a "real" ChangeLog file, but keep the maximum line length +at 72 or smaller, so that the generated ChangeLog lines, each with its +leading TAB, will not exceed 80 columns. Try to make the summary line fit one of the following forms: @@ -222,6 +224,8 @@ Try to make the summary line fit one of the following forms: prog1, prog2: change-description doc: change-description tests: change-description + build: change-description + maint: change-description Use SPACE-only indentation in new files. |