From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Paul Eggert Newsgroups: gmane.emacs.devel Subject: Re: Commit header lines (was: git history tracking across renames (and emacs support)) Date: Sat, 14 Jul 2018 16:57:12 -0500 Message-ID: References: <877etklvsa.fsf@lifelogs.com> <83y3m0pv8u.fsf@gnu.org> <86608msw0h.fsf@dod.no> <838tdiet25.fsf@gnu.org> <87y3li4vh7.fsf@telefonica.net> <87efnan46u.fsf@linux-m68k.org> <86wp12qtgo.fsf@dod.no> <83tvw6chqv.fsf@gnu.org> <86shbprix7.fsf_-_@dod.no> <838t6jgl1k.fsf@gnu.org> <601m6cc6.fsf@lifelogs.com> <83o9fefnv9.fsf@gnu.org> <83d0vtfx4f.fsf@gnu.org> <83o9fce4np.fsf@gnu.org> <8336wneemw.fsf@gnu.org> <907edf27-ed0c-5166-88ea-c3db9d9d7f74@cs.ucla.edu> <83pnzqb8wl.fsf@gnu.org> <55bb3a0b-e948-9e5d-8332-bed47b913026@cs.ucla.edu> <83va9haiqv.fsf@gnu.org> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="------------85B9B9D8D86D42C78594FC8B" X-Trace: blaine.gmane.org 1531607644 757 195.159.176.226 (14 Jul 2018 22:34:04 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sat, 14 Jul 2018 22:34:04 +0000 (UTC) User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1 Cc: rms@gnu.org, emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Jul 15 00:34:00 2018 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1feT71-0008VG-OE for ged-emacs-devel@m.gmane.org; Sun, 15 Jul 2018 00:33:59 +0200 Original-Received: from localhost ([::1]:43294 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1feT98-0002QM-4p for ged-emacs-devel@m.gmane.org; Sat, 14 Jul 2018 18:36:10 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:46213) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1feT8v-0002Q0-W7 for emacs-devel@gnu.org; Sat, 14 Jul 2018 18:36:02 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1feT8s-0001wW-A9 for emacs-devel@gnu.org; Sat, 14 Jul 2018 18:35:57 -0400 Original-Received: from zimbra.cs.ucla.edu ([131.179.128.68]:38960) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1feSXV-0000cH-Rp; Sat, 14 Jul 2018 17:57:19 -0400 Original-Received: from localhost (localhost [127.0.0.1]) by zimbra.cs.ucla.edu (Postfix) with ESMTP id C9F4B1606C2; Sat, 14 Jul 2018 14:57:14 -0700 (PDT) Original-Received: from zimbra.cs.ucla.edu ([127.0.0.1]) by localhost (zimbra.cs.ucla.edu [127.0.0.1]) (amavisd-new, port 10032) with ESMTP id CqiYSGgwKul7; Sat, 14 Jul 2018 14:57:14 -0700 (PDT) Original-Received: from localhost (localhost [127.0.0.1]) by zimbra.cs.ucla.edu (Postfix) with ESMTP id 03C471606C5; Sat, 14 Jul 2018 14:57:14 -0700 (PDT) X-Virus-Scanned: amavisd-new at zimbra.cs.ucla.edu Original-Received: from zimbra.cs.ucla.edu ([127.0.0.1]) by localhost (zimbra.cs.ucla.edu [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id NwO8Z1EwiEyJ; Sat, 14 Jul 2018 14:57:13 -0700 (PDT) Original-Received: from [192.168.0.8] (ip72-206-6-38.fv.ks.cox.net [72.206.6.38]) by zimbra.cs.ucla.edu (Postfix) with ESMTPSA id 9B5D71606C2; Sat, 14 Jul 2018 14:57:13 -0700 (PDT) In-Reply-To: <83va9haiqv.fsf@gnu.org> Content-Language: en-US X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [fuzzy] X-Received-From: 131.179.128.68 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 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.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:227416 Archived-At: This is a multi-part message in MIME format. --------------85B9B9D8D86D42C78594FC8B Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit On 07/14/2018 11:23 AM, Eli Zaretskii wrote: >> If a summary line is a shorter version of the main text, that's a good >> thing. It's like a good title for a news article or a research paper: it >> restates the main text briefly, and there is real value in that. > I disagree with your perception, but I guess we are getting into the > gray area where personal preferences mean more than anything else. > I suppose it could be called a personal preference, in that I prefer to follow the common practice of summarizing the commit message in its first line. This standard for Git, where the summary line is commonly used to good effect. We old-timers know about predecessor version-control systems like RCS and CVS where other commit-message conventions might have made sense too. But those days are gone, and good riddance if you ask me. Today the primary use of a summary line is to give readers a quick way to see whether a change is worth looking into in more detail, and authors of patches should keep this in mind. --------------85B9B9D8D86D42C78594FC8B Content-Type: text/html; charset=utf-8 Content-Transfer-Encoding: 7bit
On 07/14/2018 11:23 AM, Eli Zaretskii wrote:
If a summary line is a shorter version of the main text, that's a good
thing. It's like a good title for a news article or a research paper: it
restates the main text briefly, and there is real value in that.

I disagree with your perception, but I guess we are getting into the
gray area where personal preferences mean more than anything else.

I suppose it could be called a personal preference, in that I prefer to follow the common practice of summarizing the commit message in its first line. This standard for Git, where the summary line is commonly used to good effect. We old-timers know about predecessor version-control systems like RCS and CVS where other commit-message conventions might have made sense too. But those days are gone, and good riddance if you ask me.

Today the primary use of a summary line is to give readers a quick way to see whether a change is worth looking into in more detail, and authors of patches should keep this in mind.

--------------85B9B9D8D86D42C78594FC8B--