From: Junio C Hamano Date: Thu, 30 Mar 2017 21:07:16 +0000 (-0700) Subject: Merge branch 'ab/doc-submitting' X-Git-Tag: v2.13.0-rc0~41 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/e7cbfd98e3a960450025b58f6678e17c9c01b007?hp=de8a8ed155b8e87a9eb63a09fc2e085d5dd272a8 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..." --- diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 3faf7eb884..bc8ad00473 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -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 identifier for the general area of the code being modified, e.g. - . archive: ustar header checksum is computed unsigned - . git-cherry-pick.txt: clarify the use of revision range notation + . doc: clarify distinction between sign-off and pgp-signing + . githooks.txt: improve the intro section If in doubt which identifier to use, run "git log --no-merges" on the 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: . 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 ... 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)' (3) Generate your patch using Git tools out of your commits.