Message-ID: <1432225162.20840.49.camel@perches.com>
Subject: Re: [PATCH] Docs: SubmittingPatches: Clarify convention for git
 commit references
From: Joe Perches <joe@perches.com>
To: Bjorn Helgaas <bhelgaas@google.com>
Cc: Jonathan Corbet <corbet@lwn.net>, linux-kernel@vger.kernel.org,
        linux-doc@vger.kernel.org
Date: Thu, 21 May 2015 09:19:22 -0700
In-Reply-To: <20150521155954.9522.33952.stgit@bhelgaas-glaptop2.roam.corp.google.com>
References: <20150521155954.9522.33952.stgit@bhelgaas-glaptop2.roam.corp.google.com>
Content-Type: text/plain; charset="ISO-8859-1"
Mime-Version: 1.0
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 1650
Lines: 45

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
> 


--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/