From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Summarizing the purpose of a change. Date: Sat, 21 Nov 2009 11:11:15 +0200 Message-ID: <83iqd4p7ik.fsf@gnu.org> References: <87iqd4tkv4.fsf@red-bean.com> <87bpiwz4fy.fsf@catnip.gol.com> Reply-To: Eli Zaretskii NNTP-Posting-Host: lo.gmane.org X-Trace: ger.gmane.org 1258794705 29973 80.91.229.12 (21 Nov 2009 09:11:45 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 21 Nov 2009 09:11:45 +0000 (UTC) Cc: kfogel@red-bean.com, emacs-devel@gnu.org To: Miles Bader Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sat Nov 21 10:11:38 2009 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1NBm0H-0007hS-0N for ged-emacs-devel@m.gmane.org; Sat, 21 Nov 2009 10:11:37 +0100 Original-Received: from localhost ([127.0.0.1]:52057 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1NBm0F-00087G-P2 for ged-emacs-devel@m.gmane.org; Sat, 21 Nov 2009 04:11:35 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1NBm08-000861-OL for emacs-devel@gnu.org; Sat, 21 Nov 2009 04:11:28 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1NBm03-00084L-9g for emacs-devel@gnu.org; Sat, 21 Nov 2009 04:11:27 -0500 Original-Received: from [199.232.76.173] (port=53274 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1NBm03-00084I-0t for emacs-devel@gnu.org; Sat, 21 Nov 2009 04:11:23 -0500 Original-Received: from mtaout22.012.net.il ([80.179.55.172]:41370) by monty-python.gnu.org with esmtp (Exim 4.60) (envelope-from ) id 1NBm00-00007J-0n; Sat, 21 Nov 2009 04:11:20 -0500 Original-Received: from conversion-daemon.a-mtaout22.012.net.il by a-mtaout22.012.net.il (HyperSendmail v2007.08) id <0KTG00C00C3NWN00@a-mtaout22.012.net.il>; Sat, 21 Nov 2009 11:11:15 +0200 (IST) Original-Received: from HOME-C4E4A596F7 ([87.70.37.193]) by a-mtaout22.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0KTG00AAMC6QXZ60@a-mtaout22.012.net.il>; Sat, 21 Nov 2009 11:11:15 +0200 (IST) In-reply-to: <87bpiwz4fy.fsf@catnip.gol.com> X-012-Sender: halo1@inter.net.il X-detected-operating-system: by monty-python.gnu.org: Solaris 10 (beta) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:117421 Archived-At: > From: Miles Bader > Date: Sat, 21 Nov 2009 17:07:29 +0900 > Cc: emacs-devel@gnu.org > > Karl Fogel writes: > > In many projects, there is a convention of summarizing the purpose of a > > change in one or two sentences at the start of the log entry. This makes > > the rest of the log entry (and the change itself) easier to understand. > > And if possible, make the summary not "1 or 2" sentences, but a single > not-to-long line, such as you'd use for an email Subject: header. I suspect pointing to the relevant discussion on emacs-devel, or to a bug number (if there is any) would be a lesser burden.