Skip to content

Commit e7cbfd9

Browse files
committed
Merge branch 'ab/doc-submitting'
Doc update. * ab/doc-submitting: doc/SubmittingPatches: show how to get a CLI commit summary doc/SubmittingPatches: clarify the casing convention for "area: change..."
2 parents de8a8ed + 48a9697 commit e7cbfd9

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

Documentation/SubmittingPatches

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,17 @@ should skip the full stop. It is also conventional in most cases to
9898
prefix the first line with "area: " where the area is a filename or
9999
identifier for the general area of the code being modified, e.g.
100100

101-
. archive: ustar header checksum is computed unsigned
102-
. git-cherry-pick.txt: clarify the use of revision range notation
101+
. doc: clarify distinction between sign-off and pgp-signing
102+
. githooks.txt: improve the intro section
103103

104104
If in doubt which identifier to use, run "git log --no-merges" on the
105105
files you are modifying to see the current conventions.
106106

107+
It's customary to start the remainder of the first line after "area: "
108+
with a lower-case letter. E.g. "doc: clarify...", not "doc:
109+
Clarify...", or "githooks.txt: improve...", not "githooks.txt:
110+
Improve...".
111+
107112
The body should provide a meaningful commit message, which:
108113

109114
. explains the problem the change tries to solve, iow, what is wrong
@@ -129,8 +134,9 @@ with the subject enclosed in a pair of double-quotes, like this:
129134
noticed that ...
130135

131136
The "Copy commit summary" command of gitk can be used to obtain this
132-
format.
137+
format, or this invocation of "git show":
133138

139+
git show -s --date=short --pretty='format:%h ("%s", %ad)' <commit>
134140

135141
(3) Generate your patch using Git tools out of your commits.
136142

0 commit comments

Comments
 (0)