Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756863AbbEUQo2 (ORCPT ); Thu, 21 May 2015 12:44:28 -0400 Received: from mail-qk0-f170.google.com ([209.85.220.170]:34884 "EHLO mail-qk0-f170.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755699AbbEUQoW (ORCPT ); Thu, 21 May 2015 12:44:22 -0400 MIME-Version: 1.0 In-Reply-To: <1432225162.20840.49.camel@perches.com> References: <20150521155954.9522.33952.stgit@bhelgaas-glaptop2.roam.corp.google.com> <1432225162.20840.49.camel@perches.com> From: Bjorn Helgaas Date: Thu, 21 May 2015 11:44:01 -0500 Message-ID: Subject: Re: [PATCH] Docs: SubmittingPatches: Clarify convention for git commit references To: Joe Perches Cc: Jonathan Corbet , "linux-kernel@vger.kernel.org" , "linux-doc@vger.kernel.org" Content-Type: text/plain; charset=UTF-8 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1510 Lines: 36 On Thu, May 21, 2015 at 11:19 AM, Joe Perches wrote: > 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". OK. There's value in brevity. I was trying to avoid the "if 12 is good, 40 must be better" idea, because 40-char SHA-1s make changelogs ugly and hard to read. My git-fu isn't awesome (git log --oneline --abbrev-commit --abbrev=10 | cut -f1 -d" " | grep ...........), but I *think* we have three git SHA-1s so far that aren't unique in 10 characters (8b82547e338/e 3ee50141858/b a7aa92d1b49/a), and everything is still unique in 11 or 12-char SHA1s. Bjorn -- 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/