From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Michal Nazarewicz Newsgroups: gmane.emacs.bugs Subject: bug#19337: [PATCH] Improve git hook checking commit message. Date: Wed, 10 Dec 2014 18:24:09 +0100 Message-ID: <1418232249-16845-1-git-send-email-mpn@google.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Trace: ger.gmane.org 1418233459 27731 80.91.229.3 (10 Dec 2014 17:44:19 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 10 Dec 2014 17:44:19 +0000 (UTC) To: 19337@debbugs.gnu.org, eggert@cs.ucla.edu Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Dec 10 18:44:12 2014 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1XylJ4-0003qg-IM for geb-bug-gnu-emacs@m.gmane.org; Wed, 10 Dec 2014 18:44:10 +0100 Original-Received: from localhost ([::1]:47083 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XylJ4-0007Ck-6D for geb-bug-gnu-emacs@m.gmane.org; Wed, 10 Dec 2014 12:44:10 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:53005) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XylIy-00079R-IH for bug-gnu-emacs@gnu.org; Wed, 10 Dec 2014 12:44:05 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XylIx-0001P4-C2 for bug-gnu-emacs@gnu.org; Wed, 10 Dec 2014 12:44:04 -0500 Original-Received: from debbugs.gnu.org ([140.186.70.43]:60752) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XylIx-0001Oy-8A for bug-gnu-emacs@gnu.org; Wed, 10 Dec 2014 12:44:03 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1XylIw-0002te-Rh for bug-gnu-emacs@gnu.org; Wed, 10 Dec 2014 12:44:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Michal Nazarewicz Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 10 Dec 2014 17:44:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 19337 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org, Paul Eggert Original-Received: via spool by submit@debbugs.gnu.org id=B.141823340811062 (code B ref -1); Wed, 10 Dec 2014 17:44:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 10 Dec 2014 17:43:28 +0000 Original-Received: from localhost ([127.0.0.1]:41883 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1XylIN-0002sL-SG for submit@debbugs.gnu.org; Wed, 10 Dec 2014 12:43:28 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:45363) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1Xyl09-0002MO-2e for submit@debbugs.gnu.org; Wed, 10 Dec 2014 12:24:37 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Xyl02-000391-Qu for submit@debbugs.gnu.org; Wed, 10 Dec 2014 12:24:31 -0500 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:60388) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Xyl02-00038x-NB for submit@debbugs.gnu.org; Wed, 10 Dec 2014 12:24:30 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:47078) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Xyl01-00036D-BR for bug-gnu-emacs@gnu.org; Wed, 10 Dec 2014 12:24:30 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Xyl00-00038V-9C for bug-gnu-emacs@gnu.org; Wed, 10 Dec 2014 12:24:29 -0500 Original-Received: from mail-wg0-x235.google.com ([2a00:1450:400c:c00::235]:34418) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Xyl00-00038E-12 for bug-gnu-emacs@gnu.org; Wed, 10 Dec 2014 12:24:28 -0500 Original-Received: by mail-wg0-f53.google.com with SMTP id l18so4264543wgh.12 for ; Wed, 10 Dec 2014 09:24:26 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=from:to:subject:date:message-id:mime-version:content-type :content-transfer-encoding; bh=rfrR4J3b9xoooxBjdMxkai0Zz/YfpyZGJylI7xskq+4=; b=OdPbbi+Wkl8x9Td+fj1s7YeFbnRSYxmBZqjv2LrzwCZTi7d69TFfG/1GL1J+8LwVkd U1EUigeBYosuuGe1+Kjt3oAz5OTIxPHUtlnzufDV8Lx+Agc4KRqKbYLwzgF36/PN4xbT IqT/OqQER4ugsUisUs3bTC5FVhsy9zYCv6wuO2N+3cpfUbY2nf5Gpzvbb6fhRqGjsMiW Qx6erc16hXjhg1ebv2UJCM8I0fIyHkvQ86yJ9ndmCvc1n9Tjz4ZDZnu1h9P84DxR0MiH fPaA8cUe9x+v9itnElmIQXzJO6wIosJCNN4mE1BgqB0kfZJ8Mv0uRsK/r3DBTrwZC9/Z xlCA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:subject:date:message-id:mime-version :content-type:content-transfer-encoding; bh=rfrR4J3b9xoooxBjdMxkai0Zz/YfpyZGJylI7xskq+4=; b=O86Vlr2w9sJN4TVT2kXEDTBwSRPShSZRV9z9UrecNZlmZDLUBsu6p3aCQQpOHYlqkI YwU68hHlPh4/FIqIzBBIsetDBHUkWDv01tlaS7psFVBQ4csix5bkKhbSZUXv1N2PS+yg 6uX1noBXECSLM7oXEyefxVRbiBQMlTF3re5iP9vJDRlstKWI/IBml07j3K0f2lA6qbzA tN4kZojwUsX1bfwsHkEXm+hM4jaJIkc1PBmLQ7Alw6n73iz7LHhC3DJuAUDIlBcwlAgJ e++1zLocga6+uEmjJnrfYQ1nxjk9Avkq6qveon/HmMwSPzydnBk4qpg3xbkx0mQ1G9HK UJlg== X-Gm-Message-State: ALoCoQkVgO9zT1g5TJEjW5ENrfWC5CXk8UMDoVcdpArK11zHCgExcdsBxTtpKRwMrYkFro8Y+KbD X-Received: by 10.194.109.6 with SMTP id ho6mr8542568wjb.93.1418232258922; Wed, 10 Dec 2014 09:24:18 -0800 (PST) Original-Received: from mpn-glaptop.corp.google.com ([2620:0:105f:310:381f:eb80:e0ce:71dc]) by mx.google.com with ESMTPSA id js5sm18734941wid.11.2014.12.10.09.24.17 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 10 Dec 2014 09:24:17 -0800 (PST) X-Mailer: git-send-email 2.2.0.rc0.207.ga3a616c X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Mailman-Approved-At: Wed, 10 Dec 2014 12:43:26 -0500 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:97150 Archived-At: From: Michal Nazarewicz * build-aux/git-hooks/commit-msg: Do not validate commit message if it starts with “fixup!” or “squash!”. Those are special markers used by git when doing auto squashing and as a result the commit message will not be used in the final commit. * build-aux/git-hooks/commit-msg: Make the massages somehow more ambiguous by mentioning that they error has been found in the commit message. Otherwise, user may be left wondering what the error is referring to. --- build-aux/git-hooks/commit-msg | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/build-aux/git-hooks/commit-msg b/build-aux/git-hooks/commit-msg index 6a09edd..f3b05db 100755 --- a/build-aux/git-hooks/commit-msg +++ b/build-aux/git-hooks/commit-msg @@ -42,7 +42,7 @@ exec awk ' /^#/ { next } !/^.*$/ { - print "Invalid character (not UTF-8)" + print "Commit message contains invalid character (not UTF-8)" status = 1 } @@ -51,38 +51,47 @@ exec awk ' { nlines++ } nlines == 1 && /^[[:space:]]/ { - print "White space at start of first line" + print "Commit message contains white space at start of first line" status = 1 } + nlines == 1 && /^(fixup|squash)! / { + exit status + } + nlines == 2 && /[^[:space:]]/ { - print "Nonempty second line" + print "Commit message must have an empty second line" + status = 1 + } + + /\t/ { + print "Use use spaces instead of tabs in commit message" status = 1 } /[[:cntrl:]]/ { - print "Text contains control character; please use spaces instead of tabs" + print "Commit message contains control character" status = 1 } 72 < length && /[[:space:]]/ { - print "Line longer than 72 characters" + print "Commit message contains line longer than 72 characters" status = 1 } 140 < length { - print "Word longer than 140 characters" + print "Commit message contains word longer than 140 characters" status = 1 } /^Signed-off-by: / { - print "'Signed-off-by:' present" + print "'Signed-off-by:' present in the commit message" status = 1 } END { if (nlines == 0) { - print "Empty change log entry" + print "Empty commit message" status = 1 } exit status -- 2.2.0.rc0.207.ga3a616c