Messages in this thread | | | Subject | Re: [PATCH] Docs: SubmittingPatches: Clarify convention for git commit references | From | Joe Perches <> | Date | Thu, 21 May 2015 09:19:22 -0700 |
| |
On Thu, 2015-05-21 at 10:59 -0500, Bjorn Helgaas wrote: > Clarify the convention for commit references in changelogs so it matches > what checkpatch suggests; see d311cd44545f ("checkpatch: add test for > commit id formatting style in commit log"). > > I chose a different example to make the ("") around the description more > obvious. [] > diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches [] > @@ -168,27 +168,18 @@ resources. In addition to giving a URL to a mailing list archive or [] > +When referring to a specific commit, please include both the first 12
maybe
When referring to a specific commit, please include both 12 or more or "at least 12" or " a minimum of 12".
> +characters of the SHA-1 ID and the one-line summary to make it easier for > +reviewers to know what it is about. For example: > + > + Commit 523c5b89640e ("i2c: Remove support for legacy PM") removed > + the PM ops from the bus type ... > + > +If your patch fixes a bug in a specific commit, e.g., you found an issue > +using git-bisect, please use the 'Fixes:' tag, again with the first 12
here too
> +characters of the SHA-1 ID and the one-line summary. For example: > + > + Fixes: 523c5b89640e ("i2c: Remove support for legacy PM") > > The following git-config settings can be used to add a pretty format for > outputting the above style in the git log or git show commands >
| |