From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Alan Mackenzie Newsgroups: gmane.emacs.devel Subject: Re: Mistakes in commit log messages Date: Sat, 15 Apr 2023 10:44:42 +0000 Message-ID: References: <319d616d-9230-0a82-331f-0f57488e4c80@gmail.com> <834jpm9s1g.fsf@gnu.org> <83v8i28b3j.fsf@gnu.org> <693285d2-e50b-289d-4f3e-ddd817ddc75b@gmail.com> <48d4dffa-cfa8-7949-3043-a1efa937902d@gmail.com> <838rew5lak.fsf@gnu.org> <5adfbf6f-fbcb-f4e8-3662-48bd5eb6a269@gmail.com> <9c8826af-a160-d36f-7577-2bc5ec0c2004@gmail.com> <83ildxehvc.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="19143"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Jim Porter , emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat Apr 15 12:45:45 2023 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pndPc-0004qh-CD for ged-emacs-devel@m.gmane-mx.org; Sat, 15 Apr 2023 12:45:44 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pndP1-0004kX-V3; Sat, 15 Apr 2023 06:45:07 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pndOx-0004jk-53 for emacs-devel@gnu.org; Sat, 15 Apr 2023 06:45:04 -0400 Original-Received: from mx3.muc.de ([193.149.48.5]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pndOr-00031E-8R for emacs-devel@gnu.org; Sat, 15 Apr 2023 06:44:59 -0400 Original-Received: (qmail 24494 invoked by uid 3782); 15 Apr 2023 12:44:43 +0200 Original-Received: from acm.muc.de (p4fe1504c.dip0.t-ipconnect.de [79.225.80.76]) (using STARTTLS) by colin.muc.de (tmda-ofmipd) with ESMTP; Sat, 15 Apr 2023 12:44:42 +0200 Original-Received: (qmail 6262 invoked by uid 1000); 15 Apr 2023 10:44:42 -0000 Content-Disposition: inline In-Reply-To: <83ildxehvc.fsf@gnu.org> X-Submission-Agent: TMDA/1.3.x (Ph3nix) X-Primary-Address: acm@muc.de Received-SPF: pass client-ip=193.149.48.5; envelope-from=acm@muc.de; helo=mx3.muc.de X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:305327 Archived-At: Hello, Eli. On Sat, Apr 15, 2023 at 10:15:19 +0300, Eli Zaretskii wrote: > > Date: Fri, 14 Apr 2023 22:45:44 -0700 > > From: Jim Porter > > Cc: acm@muc.de, emacs-devel@gnu.org > > There's also one more commit I'm not quite sure what to do about: > > 0a95a81d8d36722ccf030a6194ecd953fc257a59. It has this in the commit message: > > This fixes bug #61144. If the space around the * is "symmetric" we > > leave foo > > * bar unfontified, a multiplication operation. If it is > > "asymmetric" we > > fontify it as a pointer declaration. > > The second line of this excerpt is treated like a file entry. Maybe our > > hook could allow that if it were clever enough, or maybe this is a rare > > enough occurrence that we should just have committers reformat the > > message slightly. > The latter, IMO. There's absolutely no reason for a log message to > have a '*' as the first non-whitespace character of a line. Fixing > that is easy. It can happen easily as a result of filling. I think it would be good if one of Jim's scripts flagged it up as an error. What is less easy than it might be, is correcting an erroneous commit message and submitting the commit again using this correction. The erroneous message remains in ..../.git/COMMIT_EDITMSG but I'm not sure how to get it back into one's editor at the next commit attempt. Maybe the error message could give some help, here. > Btw, Alan, this is a good example of your log messages, which are > filled using a much larger value of fill-column that the default. The > resulting ChangeLog entries appear ugly and stand out from the rest. > Would you please adjust your customizations to use a smaller > fill-column value, like at most 76, when writing commit log messages? I've been using a fill-column of 78, to match the maximum allowed width. I'll try cutting that down to 63, as recommended in CONTRIBUTE. -- Alan Mackenzie (Nuremberg, Germany).