lkml.org 
[lkml]   [2014]   [Aug]   [10]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    SubjectRe: [PATCH] checkpatch: Add test for commit id formatting style in commit log
    From
    Date
    On Sun, 2014-08-10 at 14:35 -0700, Andrew Morton wrote:
    > On Sun, 10 Aug 2014 14:28:01 -0700 Joe Perches <joe@perches.com> wrote:
    > > > On Thu, Jul 3, 2014 at 12:00 AM, Joe Perches <joe@perches.com> wrote:
    > > > > Commit logs have various forms of commit id references.
    > > > >
    > > > > Try to standardize on a 12 character long lower case
    > > > > commit id along with a description of parentheses and
    > > > > the quoted subject line
    > > > >
    > > > > ie: commit 0123456789ab ("commit description")
    > > >
    > > > Now this is in mainline, checkpatch starts complaining about my "too long"
    > > > (40 chars) commit IDs in commit messages :-(
    > > >
    > > > 40 chars may be too long (but it's quick to copy-and-paste, as "git show"
    > > > shows that by default), but 12 sounds a bit short, as that's only 48 bits.
    > >
    > > Right now, this test allows 12 to 16 byte length commit ids
    > > without emitting a warning.
    > >
    > > Andrew wanted this test, I don't care how long the commit id
    > > is in the commit log.
    >
    > Well, I mainly wanted to stop having to add "commit description" when
    > people forget it. The length check was perhaps a bit anal. How about
    > we make it "12 or more"?

    Fine by me, just change the 16 to 40
    ---
    scripts/checkpatch.pl | 4 ++--
    1 file changed, 2 insertions(+), 2 deletions(-)

    diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
    index 31a731e..b385bcb 100755
    --- a/scripts/checkpatch.pl
    +++ b/scripts/checkpatch.pl
    @@ -2133,7 +2133,7 @@ sub process {
    # Check for improperly formed commit descriptions
    if ($in_commit_log &&
    $line =~ /\bcommit\s+[0-9a-f]{5,}/i &&
    - $line !~ /\b[Cc]ommit [0-9a-f]{12,16} \("/) {
    + $line !~ /\b[Cc]ommit [0-9a-f]{12,40} \("/) {
    $line =~ /\b(c)ommit\s+([0-9a-f]{5,})/i;
    my $init_char = $1;
    my $orig_commit = lc($2);
    @@ -2141,7 +2141,7 @@ sub process {
    my $desc = 'commit description';
    ($id, $desc) = git_commit_info($orig_commit, $id, $desc);
    ERROR("GIT_COMMIT_ID",
    - "Please use 12 to 16 chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
    + "Please use 12 or more chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
    }

    # Check for added, moved or deleted files



    \
     
     \ /
      Last update: 2014-08-11 00:01    [W:4.649 / U:0.764 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site