undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'ab/doc-submitting'

Browse Source 
Doc update.

* ab/doc-submitting:
  doc/SubmittingPatches: show how to get a CLI commit summary
  doc/SubmittingPatches: clarify the casing convention for "area: change..."
This commit is contained in:
Junio C Hamano 2017-03-30 14:07:16 -07:00
commit e7cbfd98e3
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/SubmittingPatches
View File

@ -98,12 +98,17 @@ should skip the full stop. It is also conventional in most cases to
prefix the first line with "area: " where the area is a filename or prefix the first line with "area: " where the area is a filename or
identifier for the general area of the code being modified, e.g. identifier for the general area of the code being modified, e.g.
. archive: ustar header checksum is computed unsigned . doc: clarify distinction between sign-off and pgp-signing
. git-cherry-pick.txt: clarify the use of revision range notation . githooks.txt: improve the intro section
If in doubt which identifier to use, run "git log --no-merges" on the If in doubt which identifier to use, run "git log --no-merges" on the
files you are modifying to see the current conventions. files you are modifying to see the current conventions.
It's customary to start the remainder of the first line after "area: "
with a lower-case letter. E.g. "doc: clarify...", not "doc:
Clarify...", or "githooks.txt: improve...", not "githooks.txt:
Improve...".
The body should provide a meaningful commit message, which: The body should provide a meaningful commit message, which:
. explains the problem the change tries to solve, iow, what is wrong . 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:
noticed that ... noticed that ...
The "Copy commit summary" command of gitk can be used to obtain this The "Copy commit summary" command of gitk can be used to obtain this
format. format, or this invocation of "git show":
git show -s --date=short --pretty='format:%h ("%s", %ad)' <commit>
(3) Generate your patch using Git tools out of your commits. (3) Generate your patch using Git tools out of your commits.