GNU bug report logs - #36208
26.2.50; Add tooling for commit message format checking

Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.

Package: emacs; Severity: wishlist; Reported by: Damien Cassou <damien@HIDDEN>; dated Fri, 14 Jun 2019 16:48:01 UTC; Maintainer for emacs is bug-gnu-emacs@HIDDEN.

Message received at 36208 <at> debbugs.gnu.org:


Received: (at 36208) by debbugs.gnu.org; 5 Jul 2019 16:21:30 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Fri Jul 05 12:21:30 2019
Received: from localhost ([127.0.0.1]:53645 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1hjQxm-00082a-GQ
	for submit <at> debbugs.gnu.org; Fri, 05 Jul 2019 12:21:30 -0400
Received: from mail-wm1-f43.google.com ([209.85.128.43]:38587)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <contovob@HIDDEN>) id 1hjQxk-00082L-Si
 for 36208 <at> debbugs.gnu.org; Fri, 05 Jul 2019 12:21:29 -0400
Received: by mail-wm1-f43.google.com with SMTP id s15so10266625wmj.3
 for <36208 <at> debbugs.gnu.org>; Fri, 05 Jul 2019 09:21:28 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=tcd-ie.20150623.gappssmtp.com; s=20150623;
 h=from:to:cc:subject:references:date:in-reply-to:message-id
 :user-agent:mime-version;
 bh=9YlgYeRNdWFE8YSZdaeI2yrhVLO/kzQNf46pznn0F0Q=;
 b=Wq1RlKSzKM/eNkOUVt9c8FSGDPmtXvFgyVa5W6H+RCH+heHrk2LxIWvrgB85ZRaqxj
 ZVlajG/5/R04CMRrO4Je+D45TjPtWxIGd0+9uaU+dGLisqWFyBFjsnRbhc2ydz3PtXL1
 wyqLaSH6RE4rvjRAbs1u8gOKHwul/W8XYqE56NCFHjowMmfF5MVZqnFA3BgmJDJQ216j
 d5imlhbX2AXo2N3TomhEE+sN+VawKhWb2fsQUSTvzCs/58Z9dchZN4v1gCqrhr9ohMjD
 Wd2nAxv3M3BzpvbgkADxeUcDS2qjagJpV6yLCe1tmK02xIU/3bx/09LX1LjtnYtWLmKh
 jcdQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20161025;
 h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to
 :message-id:user-agent:mime-version;
 bh=9YlgYeRNdWFE8YSZdaeI2yrhVLO/kzQNf46pznn0F0Q=;
 b=LIuMec/aW0C569knAu7sXqLYXUBdNGRWjqgqGOkU9EE7PRcAAPkFc7aLozdRKSP7hN
 PSABOmQZF9PmTT4psYwWJzortvzCjM4srFR8jCP744ZJbvr9jilSDzw1kCj5rJVOOz66
 uMX1M90QAzs7+q1WqKdnPhTBmyN6MFTmvbfG0SGV8zbYjskWqZ/OhT/DUq6vUn72VQI/
 z5KAKvSOAJwjbcoLpPbd8E8PrTkxyKAYkhV4I5o2iOsY0sdsvrPPIsysOBS4tKCbuoEX
 BbNfbgx8cmjybOwEDnHB6GdmX3Ubx8Nr291AAEziWUa17CrS/OI3QLymBbsTIj1IurWm
 lHnA==
X-Gm-Message-State: APjAAAWZDzmVlBGJrz+RyrAO9pa0nmU+txE4GA7RHXnxnrsfTpNSG+R1
 2AJGL14ygLyleTTFCDx2uPrxJg==
X-Google-Smtp-Source: APXvYqzses6Ckt5V85iJw2/TDkgBMZy0++t9IQUST/lIYG2JAvmYBDVR2zUhRYoRx7ZrgipAF5Yo5g==
X-Received: by 2002:aa7:c693:: with SMTP id n19mr4797881edq.106.1562343682953; 
 Fri, 05 Jul 2019 09:21:22 -0700 (PDT)
Received: from localhost (86-41-18-212-dynamic.agg3.crz.crz-crz.eircom.net.
 [86.41.18.212])
 by smtp.gmail.com with ESMTPSA id m2sm1752116ejl.40.2019.07.05.09.21.21
 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256);
 Fri, 05 Jul 2019 09:21:21 -0700 (PDT)
From: "Basil L. Contovounesios" <contovob@HIDDEN>
To: Damien Cassou <damien@HIDDEN>
Subject: Re: bug#36208: 26.2.50; Add tooling for commit message format checking
References: <87ftocyuzi.fsf@HIDDEN>
Date: Fri, 05 Jul 2019 17:21:16 +0100
In-Reply-To: <87ftocyuzi.fsf@HIDDEN> (Damien Cassou's message of "Fri, 14
 Jun 2019 18:47:29 +0200")
Message-ID: <871rz4mozn.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux)
MIME-Version: 1.0
Content-Type: text/plain
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 36208
Cc: 36208 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

Damien Cassou <damien@HIDDEN> writes:

> writing commit messages that comply with Emacs' guidelines requires a
> good understanding of many details described in CONTRIBUTE.  To reduce
> the workload of new contributors and of reviewers, part of these
> guidelines could be transformed into tools.
>
> Here are some of the checks that humans have to do these days:
>
> 1. dots after every sentence (even just "New function" must terminate
>    with a dot)
> 2. double-space after dots ending sentences
> 3. no indentation (M-q adds 2 spaces which we don't want)

Are you using Magit's git-commit-mode?  If so, see PR #3911:
https://github.com/magit/magit/pull/3911

Thanks,

-- 
Basil




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#36208; Package emacs. Full text available.

Message received at 36208 <at> debbugs.gnu.org:


Received: (at 36208) by debbugs.gnu.org; 5 Jul 2019 02:02:36 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Thu Jul 04 22:02:36 2019
Received: from localhost ([127.0.0.1]:52180 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1hjDYa-0003Y6-2O
	for submit <at> debbugs.gnu.org; Thu, 04 Jul 2019 22:02:36 -0400
Received: from mail-io1-f52.google.com ([209.85.166.52]:38727)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <npostavs@HIDDEN>) id 1hjDYZ-0003TS-1q
 for 36208 <at> debbugs.gnu.org; Thu, 04 Jul 2019 22:02:35 -0400
Received: by mail-io1-f52.google.com with SMTP id j6so16037547ioa.5
 for <36208 <at> debbugs.gnu.org>; Thu, 04 Jul 2019 19:02:34 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025;
 h=from:to:cc:subject:references:date:in-reply-to:message-id
 :user-agent:mime-version;
 bh=B9tbpsWKUuUKYrw4Wa+vBkVXPFl677NjmW4xJ3cseXA=;
 b=mCzaLcxHtow5zCoUJtFU+MFwHsD4y5wkQCAPg7mB8onHDZ+PePZMDTi+JGb4qdI3OU
 sxgoT1cq7pUuvCL9cgltpqVaEQC6427TIHG1mIR33BEAi1uoIi6SCs5bGcEKuhaXpAls
 ezJ12zvdQhvKOwbQfn77g184CgwJy8Rvny7/1XHMbBqAOUHZfHpc26nJTNyADZ5DjwFP
 HU3LLk6giJA9gB1gL3/VMU8Era/mcLETEkM7/U86qhAv/Izl0wLVxYZ68/9e4ph6W6e5
 HNTLQfjksRQouREaHCUb3prTMXA2YyMqxhzH8BUQnArdDnCzyvcnmuqEJcSbCPrWZH9X
 C2OA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20161025;
 h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to
 :message-id:user-agent:mime-version;
 bh=B9tbpsWKUuUKYrw4Wa+vBkVXPFl677NjmW4xJ3cseXA=;
 b=pEPVfc80oCxNDCIAQOaKfkWq59aAnSII4NWSWXW1O9yQ2psofgYKNVOrEv9U+QD62u
 jJ42d/W8GfaUznbcNI+aCuDdAKk3n5o/zTa4uhRjifv2cshoWhJTZh54DYoakUMrxHGz
 NFd+OQd4RVIK2vG22zLy7Jbos2x42WbAcG5dkod1yYtFqJc6QGPGNqdLSbGZcPGUFF3Y
 fIc8W1zSwvlJh7Wbo6bETmdvOUQa7b7FL3ig9HEYxv7RuSvSiwFIdCd4UVS8HapA3k9P
 5trQ262Nng2O26qkX90H9+in9CsA7aen8Ns9Z03rn51F5FDZ4tIIFL/iuPduQ8ajtgYL
 vmaw==
X-Gm-Message-State: APjAAAXOHQyo3vx0fnY+KiONyxpvR5ioYYY0MjLTaT5U35v2GD5V9uU/
 iDLV1OdBcgufBkkexQLUMRyxx+rP
X-Google-Smtp-Source: APXvYqxRu381w5ESqyIBNdzjbsxcqN+DB037maVKXvxYE3ZMdIi29Ph8su83F7WYe+lZzjqEHYe4lw==
X-Received: by 2002:a5e:d615:: with SMTP id w21mr1475200iom.0.1562292149411;
 Thu, 04 Jul 2019 19:02:29 -0700 (PDT)
Received: from minid (cbl-45-2-119-34.yyz.frontiernetworks.ca. [45.2.119.34])
 by smtp.gmail.com with ESMTPSA id
 v13sm6361171ioq.13.2019.07.04.19.02.28
 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256);
 Thu, 04 Jul 2019 19:02:28 -0700 (PDT)
From: Noam Postavsky <npostavs@HIDDEN>
To: Damien Cassou <damien@HIDDEN>
Subject: Re: bug#36208: 26.2.50; Add tooling for commit message format checking
References: <87ftocyuzi.fsf@HIDDEN>
Date: Thu, 04 Jul 2019 22:02:28 -0400
In-Reply-To: <87ftocyuzi.fsf@HIDDEN> (Damien Cassou's message of "Fri, 14
 Jun 2019 18:47:29 +0200")
Message-ID: <871rz55jd7.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.2.90 (gnu/linux)
MIME-Version: 1.0
Content-Type: text/plain
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 36208
Cc: 36208 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

Damien Cassou <damien@HIDDEN> writes:

> 1. dots after every sentence (even just "New function" must terminate
>    with a dot)
> 2. double-space after dots ending sentences

>   - for check 6., a shortcut (beyond `C' which triggers
>     `magit-commit-add-log-insert') could add a template with all the
>     changes

I've started work on a command which can generate the ChangeLog
skeleton, see https://debbugs.gnu.org/16301#11.  While doing that, I
found that we already have log-edit-mode (and derived mode
vc-git-log-edit-mode) which already has some checking for 1 and 2 in its
font-lock rules.





Information forwarded to bug-gnu-emacs@HIDDEN:
bug#36208; Package emacs. Full text available.

Message received at 36208 <at> debbugs.gnu.org:


Received: (at 36208) by debbugs.gnu.org; 17 Jun 2019 15:10:29 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Jun 17 11:10:29 2019
Received: from localhost ([127.0.0.1]:43145 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1hctHA-0008FB-VI
	for submit <at> debbugs.gnu.org; Mon, 17 Jun 2019 11:10:29 -0400
Received: from mail-io1-f50.google.com ([209.85.166.50]:37711)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <npostavs@HIDDEN>) id 1hctH9-0008Ex-9t
 for 36208 <at> debbugs.gnu.org; Mon, 17 Jun 2019 11:10:27 -0400
Received: by mail-io1-f50.google.com with SMTP id e5so21991332iok.4
 for <36208 <at> debbugs.gnu.org>; Mon, 17 Jun 2019 08:10:27 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025;
 h=from:to:cc:subject:references:date:in-reply-to:message-id
 :user-agent:mime-version;
 bh=uqt+mx5PmYQTNElAY0hRUKO+BN9PiPZ1KXa8J1ldBRk=;
 b=XdGcXuQYSzwWGh9Yu/KD39Id127z5foVbTQ0VScr2ga1qGa1HAXIvoF9pORltu0kxQ
 XWatofQtsnPXDqwAZzppN/fvhOgvFHPFg1spc7hcyKPPcHEF4wv6qOnGTi7NVoH7E5D+
 jUdFY+MGjySGEp8/eO+prS+xQA41XDyAT1CAT/qO6SJovrPQmsNa0p2z+eYC6sqtZBrN
 qzLjdo7K3wfFaBmK4ViO+5QR+7bQ0h+rFXkED7iVLOCGXuhR9VvBkYF8flEQ49WMx3Ls
 OT71r2aNqiLc2VXgFVHuHXBkImZWZeJDZhXoPnuY7dWz6cts1x/7YySKJTp4pOyr37DW
 bjEQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20161025;
 h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to
 :message-id:user-agent:mime-version;
 bh=uqt+mx5PmYQTNElAY0hRUKO+BN9PiPZ1KXa8J1ldBRk=;
 b=eko90VKw4MqjhbNvcV69GiUZ00gnxD1qiRqAAhjBYKkKMrO4mVzsi5TNU87fgXdhex
 Cpk3Rh293FgGdyf/de7VY0fr/ax/wbtf/CMahcrrI9433iKFKmld4U3LZjbVKmpIPRpB
 LU8e5yZdZ6VdIq16K1qmZq1TCN+5B4KBMMy/CE8k7kgBHPQMk2/Pfe8e3q288YHBkSKd
 nO0FobSnjPNBx6C8V/t+dEbKQc8deAPRohriOkrOKnNTqpxztwN1PBzw9SJ50m2ejEFu
 7Om+vaL+Ovujl4VJk93ZrGpMsOqeOE3S8DVTrKhAR1SI8PcKQuUBpaiwhl1CLvkI23cu
 uicg==
X-Gm-Message-State: APjAAAUqfLAWQpFDE1EIAb1hMc+gSwAmKApODHuUSrKVJyU77bBKRgJ9
 dT0bgDbW5ThN5c+GtkZvipLluDk1
X-Google-Smtp-Source: APXvYqyQ1sWe1HuRlbQFcDkOR5g0yK4zDtkRumgoQ5IkM9z7pp8cX623Cntj+lu6a8YVH/ehIsrkrw==
X-Received: by 2002:a02:710f:: with SMTP id n15mr18612002jac.119.1560784221480; 
 Mon, 17 Jun 2019 08:10:21 -0700 (PDT)
Received: from vhost2
 (CPE001143542e1f-CMf81d0f809fa0.cpe.net.cable.rogers.com. [99.230.51.196])
 by smtp.gmail.com with ESMTPSA id l11sm17033879ioj.32.2019.06.17.08.10.20
 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256);
 Mon, 17 Jun 2019 08:10:20 -0700 (PDT)
From: Noam Postavsky <npostavs@HIDDEN>
To: Juanma Barranquero <lekktu@HIDDEN>
Subject: Re: bug#36208: 26.2.50; Add tooling for commit message format checking
References: <87ftocyuzi.fsf@HIDDEN>
 <mailman.90.1560530885.10840.bug-gnu-emacs@HIDDEN>
 <20190617073932.62027.qmail@HIDDEN>
 <CAAeL0SRXyj-aC+dzO++vVk7C5Y8Dhg8uB1qbEQ3Q3KkjXtEkQQ@HIDDEN>
Date: Mon, 17 Jun 2019 11:10:22 -0400
In-Reply-To: <CAAeL0SRXyj-aC+dzO++vVk7C5Y8Dhg8uB1qbEQ3Q3KkjXtEkQQ@HIDDEN>
 (Juanma Barranquero's message of "Mon, 17 Jun 2019 09:46:17 +0200")
Message-ID: <85v9x4l02p.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.1.92 (windows-nt)
MIME-Version: 1.0
Content-Type: text/plain
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 36208
Cc: Damien Cassou <damien@HIDDEN>, Alan Mackenzie <acm@HIDDEN>,
 36208 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

Juanma Barranquero <lekktu@HIDDEN> writes:

>> What we are really missing is an ability to edit commit messages after
>> committing with a faulty message.  This is a deficiency of git.
>
> We can add information with git notes, though I think we're not using
> that capability.

Last time I checked this out, having many note refs in the git
repository would noticeably slow down all git operations.

https://lists.gnu.org/archive/html/emacs-devel/2016-07/msg01184.html




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#36208; Package emacs. Full text available.

Message received at 36208 <at> debbugs.gnu.org:


Received: (at 36208) by debbugs.gnu.org; 17 Jun 2019 07:47:01 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Jun 17 03:47:00 2019
Received: from localhost ([127.0.0.1]:41847 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1hcmM0-0001FT-Jg
	for submit <at> debbugs.gnu.org; Mon, 17 Jun 2019 03:47:00 -0400
Received: from mail-qt1-f182.google.com ([209.85.160.182]:39984)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <lekktu@HIDDEN>) id 1hcmLy-0001FC-JZ
 for 36208 <at> debbugs.gnu.org; Mon, 17 Jun 2019 03:46:59 -0400
Received: by mail-qt1-f182.google.com with SMTP id a15so9588695qtn.7
 for <36208 <at> debbugs.gnu.org>; Mon, 17 Jun 2019 00:46:58 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025;
 h=mime-version:references:in-reply-to:from:date:message-id:subject:to
 :cc; bh=Rncd0NvqidUEhjvSqykQ3XbFxLID5etR9yXJi6XoYn8=;
 b=qRTHqvWx/bMKSqGO/mhYX+1V+vX3Lwc69RTVkmOXJQuOf2x/U4qyYZ7xIgi1R9lwHS
 pVDcfas4IVGBLG2cMYt9WEBNDioXnVfZcOK9OfPEBejxYfh539SgxZlYC34MbkgbtVBR
 0isBUXaBnceuxEZzLbZ5R3b+TWcvSbCQJQNmYzee4rsdEkZXSz2EulozDYdg9AeoQ6Ur
 uhBiVnosWpJDDAHSmTgMi3yvBpnTIe3vZ87bGAC/UqvJr0xmP503JNwRO04/4/4pw7AT
 SogacNIn8NajpJ0r8t+csrFiPwEcR1nPhjHc2Vp7uzE5q2ujFvLyu6Ydr3d3e+pbSGrs
 8MXg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20161025;
 h=x-gm-message-state:mime-version:references:in-reply-to:from:date
 :message-id:subject:to:cc;
 bh=Rncd0NvqidUEhjvSqykQ3XbFxLID5etR9yXJi6XoYn8=;
 b=QEVLPi5mELO/s32/tShM6jgT16Ej1hbM8qGjN5TORIqOMu/hfKdlk1Ey+WftLD/iod
 PFij+7UJSSC/idg3R8jrV131VjLRWG+e6JMKI2Cvxpz6JI7ethf/zLHoZBj8LMfs9hpq
 XRDd8wu4ZrSiO7ibOFeIDZ1xBhYU1/LXbmIZNSIhBmz7hfP1z6+z3KZCsmU7U0uCTFix
 PTT6sLDYnngk2ed2uOue9ZO9hnJkhjFcN63U3kEzMG2i10fMLGaGak8OjMPn3eHiG0Ee
 YN147rPZLJWhlZm/c8LFZR3cBFmM7cuX9uBtvjGAL+kcajDU6OzxvxSYtNZ3LEsVAbhG
 HQ8A==
X-Gm-Message-State: APjAAAXVnCfHbsAVWSjdEo54afd/6IbhFBmOXQgsY5+99hpaV/oMnwJP
 NsZ4Ye3ISyHdAHUOPRAmxJ7hYok7iE7ZoiFtmMsUMHdc
X-Google-Smtp-Source: APXvYqx/mfWrdvjT0kA0UW/JHQNTYGmznRvgs7wRaN4lJGLzLyvwBe1JbMQjJhO4PupR23SAebBSyW01z+csUQlFFrw=
X-Received: by 2002:ac8:41d1:: with SMTP id o17mr18559253qtm.17.1560757612996; 
 Mon, 17 Jun 2019 00:46:52 -0700 (PDT)
MIME-Version: 1.0
References: <87ftocyuzi.fsf@HIDDEN>
 <mailman.90.1560530885.10840.bug-gnu-emacs@HIDDEN>
 <20190617073932.62027.qmail@HIDDEN>
In-Reply-To: <20190617073932.62027.qmail@HIDDEN>
From: Juanma Barranquero <lekktu@HIDDEN>
Date: Mon, 17 Jun 2019 09:46:17 +0200
Message-ID: <CAAeL0SRXyj-aC+dzO++vVk7C5Y8Dhg8uB1qbEQ3Q3KkjXtEkQQ@HIDDEN>
Subject: Re: bug#36208: 26.2.50; Add tooling for commit message format checking
To: Alan Mackenzie <acm@HIDDEN>
Content-Type: text/plain; charset="UTF-8"
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 36208
Cc: Damien Cassou <damien@HIDDEN>, 36208 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

> What we are really missing is an ability to edit commit messages after
> committing with a faulty message.  This is a deficiency of git.

We can add information with git notes, though I think we're not using
that capability.




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#36208; Package emacs. Full text available.

Message received at 36208 <at> debbugs.gnu.org:


Received: (at 36208) by debbugs.gnu.org; 17 Jun 2019 07:39:42 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Jun 17 03:39:42 2019
Received: from localhost ([127.0.0.1]:41843 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1hcmEv-00013F-NT
	for submit <at> debbugs.gnu.org; Mon, 17 Jun 2019 03:39:41 -0400
Received: from colin.muc.de ([193.149.48.1]:60051 helo=mail.muc.de)
 by debbugs.gnu.org with smtp (Exim 4.84_2)
 (envelope-from <acm@HIDDEN>) id 1hcmEs-000133-VT
 for 36208 <at> debbugs.gnu.org; Mon, 17 Jun 2019 03:39:39 -0400
Received: (qmail 62028 invoked by uid 3782); 17 Jun 2019 07:39:32 -0000
Date: 17 Jun 2019 07:39:32 -0000
Message-ID: <20190617073932.62027.qmail@HIDDEN>
From: Alan Mackenzie <acm@HIDDEN>
To: Damien Cassou <damien@HIDDEN>
Subject: Re: bug#36208: 26.2.50; Add tooling for commit message format checking
Organization: muc.de e.V.
In-Reply-To: <mailman.90.1560530885.10840.bug-gnu-emacs@HIDDEN>
X-Newsgroups: gnu.emacs.bug
User-Agent: tin/2.4.2-20171224 ("Lochhead") (UNIX) (FreeBSD/11.2-RELEASE-p9
 (amd64))
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 36208
Cc: 36208 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

Hello, Damien.

In article <mailman.90.1560530885.10840.bug-gnu-emacs@HIDDEN> you wrote:
> Hi

> writing commit messages that comply with Emacs' guidelines requires a
> good understanding of many details described in CONTRIBUTE.  To reduce
> the workload of new contributors and of reviewers, part of these
> guidelines could be transformed into tools.

It's worth pointing out that C-x 4 a
(add-change-log-entry-other-window), from the days when we used to
write ChangeLog entries, does some of what you're asking for.  Maybe
this could be adapted.

> Here are some of the checks that humans have to do these days:

> 1. dots after every sentence (even just "New function" must terminate
>    with a dot)
> 2. double-space after dots ending sentences
> 3. no indentation (M-q adds 2 spaces which we don't want)
> 4. line length
> 5. the Copyright-paperwork-exempt token
> 6. every single change is documented
> 7. no colon if another function of the same file has the same comment

What we are really missing is an ability to edit commit messages after
committing with a faulty message.  This is a deficiency of git.

> I can imagine several tools:

> - a major mode for editing commit messages:

>   - for check 2., sentence-end-double-space could be set to t

>   - for check 3., I guess another variable could be set

>   - for check 4., setting fill-column

>   - for check 5., a shortcut could help adding such tokens

>   - for check 6., a shortcut (beyond `C' which triggers
>     `magit-commit-add-log-insert') could add a template with all the
>     changes

> - a flymake backend to mark problems:

>   - for checks 1., 3., 4., and 7., I believe it's obvious

>   - for check 2., words ending with a dot and just one space (with a
>     whitelist to avoid false positives such as "etc."  and "aka.")

> - a patch checker (e.g., `./check_patch.sh *.patch`):

>   - could check the same as the flymake backend and also checks 5 and 6.

> Best,

> -- 
> Damien Cassou
> http://damiencassou.seasidehosting.st

> "Success is the ability to go from one failure to another without
> losing enthusiasm." --Winston Churchill

-- 
Alan Mackenzie (Nuremberg, Germany).





Information forwarded to bug-gnu-emacs@HIDDEN:
bug#36208; Package emacs. Full text available.

Message received at submit <at> debbugs.gnu.org:


Received: (at submit) by debbugs.gnu.org; 14 Jun 2019 16:47:41 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Fri Jun 14 12:47:41 2019
Received: from localhost ([127.0.0.1]:37690 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1hbpMb-00035u-3d
	for submit <at> debbugs.gnu.org; Fri, 14 Jun 2019 12:47:41 -0400
Received: from lists.gnu.org ([209.51.188.17]:45407)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <damien@HIDDEN>) id 1hbpMZ-00035m-6h
 for submit <at> debbugs.gnu.org; Fri, 14 Jun 2019 12:47:39 -0400
Received: from eggs.gnu.org ([2001:470:142:3::10]:47540)
 by lists.gnu.org with esmtp (Exim 4.86_2)
 (envelope-from <damien@HIDDEN>) id 1hbpMX-0001V2-Qs
 for bug-gnu-emacs@HIDDEN; Fri, 14 Jun 2019 12:47:38 -0400
X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org
X-Spam-Level: 
X-Spam-Status: No, score=0.8 required=5.0 tests=BAYES_50,URIBL_BLOCKED
 autolearn=disabled version=3.3.2
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <damien@HIDDEN>) id 1hbpMW-0005hI-Jg
 for bug-gnu-emacs@HIDDEN; Fri, 14 Jun 2019 12:47:37 -0400
Received: from mail.choca.pics ([2001:bc8:20ab::1]:60596)
 by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)
 (Exim 4.71) (envelope-from <damien@HIDDEN>) id 1hbpMW-0005ev-DP
 for bug-gnu-emacs@HIDDEN; Fri, 14 Jun 2019 12:47:36 -0400
Received: from localhost (localhost.localdomain [IPv6:::1])
 by mail.choca.pics (Postfix) with ESMTP id E03E0F1A866
 for <bug-gnu-emacs@HIDDEN>; Fri, 14 Jun 2019 18:47:31 +0200 (CEST)
Received: from mail.choca.pics ([IPv6:::1])
 by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10032)
 with ESMTP id c8mRVQtYQAMG for <bug-gnu-emacs@HIDDEN>;
 Fri, 14 Jun 2019 18:47:31 +0200 (CEST)
Received: from localhost (localhost.localdomain [IPv6:::1])
 by mail.choca.pics (Postfix) with ESMTP id 34789F1ACD2
 for <bug-gnu-emacs@HIDDEN>; Fri, 14 Jun 2019 18:47:31 +0200 (CEST)
X-Virus-Scanned: amavisd-new at choca.pics
Received: from mail.choca.pics ([IPv6:::1])
 by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10026)
 with ESMTP id CTusVIOo8Dth for <bug-gnu-emacs@HIDDEN>;
 Fri, 14 Jun 2019 18:47:31 +0200 (CEST)
Received: from luz4 (92.116.5.93.rev.sfr.net [93.5.116.92])
 by mail.choca.pics (Postfix) with ESMTPSA id EFDD2F1A866
 for <bug-gnu-emacs@HIDDEN>; Fri, 14 Jun 2019 18:47:30 +0200 (CEST)
From: Damien Cassou <damien@HIDDEN>
To: bug-gnu-emacs@HIDDEN
Subject: 26.2.50; Add tooling for commit message format checking
Date: Fri, 14 Jun 2019 18:47:29 +0200
Message-ID: <87ftocyuzi.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain
X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]
X-Received-From: 2001:bc8:20ab::1
X-Spam-Score: -1.4 (-)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -2.4 (--)

Hi



writing commit messages that comply with Emacs' guidelines requires a
good understanding of many details described in CONTRIBUTE.  To reduce
the workload of new contributors and of reviewers, part of these
guidelines could be transformed into tools.

Here are some of the checks that humans have to do these days:

1. dots after every sentence (even just "New function" must terminate
   with a dot)
2. double-space after dots ending sentences
3. no indentation (M-q adds 2 spaces which we don't want)
4. line length
5. the Copyright-paperwork-exempt token
6. every single change is documented
7. no colon if another function of the same file has the same comment

I can imagine several tools:

- a major mode for editing commit messages:

  - for check 2., sentence-end-double-space could be set to t

  - for check 3., I guess another variable could be set

  - for check 4., setting fill-column

  - for check 5., a shortcut could help adding such tokens

  - for check 6., a shortcut (beyond `C' which triggers
    `magit-commit-add-log-insert') could add a template with all the
    changes

- a flymake backend to mark problems:

  - for checks 1., 3., 4., and 7., I believe it's obvious

  - for check 2., words ending with a dot and just one space (with a
    whitelist to avoid false positives such as "etc."  and "aka.")

- a patch checker (e.g., `./check_patch.sh *.patch`):

  - could check the same as the flymake backend and also checks 5 and 6.

Best,

-- 
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill




Acknowledgement sent to Damien Cassou <damien@HIDDEN>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs@HIDDEN. Full text available.
Report forwarded to bug-gnu-emacs@HIDDEN:
bug#36208; Package emacs. Full text available.
Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.
Last modified: Mon, 25 Nov 2019 12:00:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.