From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Miles Bader Newsgroups: gmane.emacs.devel Subject: Re: Summarizing the purpose of a change. Date: Sat, 21 Nov 2009 17:07:29 +0900 Message-ID: <87bpiwz4fy.fsf@catnip.gol.com> References: <87iqd4tkv4.fsf@red-bean.com> Reply-To: Miles Bader NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: ger.gmane.org 1258790881 22370 80.91.229.12 (21 Nov 2009 08:08:01 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 21 Nov 2009 08:08:01 +0000 (UTC) Cc: emacs-devel@gnu.org To: Karl Fogel Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sat Nov 21 09:07:49 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 1NBl0W-0006Vp-Fg for ged-emacs-devel@m.gmane.org; Sat, 21 Nov 2009 09:07:49 +0100 Original-Received: from localhost ([127.0.0.1]:41775 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1NBl0V-0006It-OD for ged-emacs-devel@m.gmane.org; Sat, 21 Nov 2009 03:07:47 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1NBl0P-0006Hr-Ce for emacs-devel@gnu.org; Sat, 21 Nov 2009 03:07:41 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1NBl0K-0006Gp-OL for emacs-devel@gnu.org; Sat, 21 Nov 2009 03:07:40 -0500 Original-Received: from [199.232.76.173] (port=36915 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1NBl0K-0006Gm-KS for emacs-devel@gnu.org; Sat, 21 Nov 2009 03:07:36 -0500 Original-Received: from mx20.gnu.org ([199.232.41.8]:4423) by monty-python.gnu.org with esmtps (TLS-1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1NBl0H-00008F-UD; Sat, 21 Nov 2009 03:07:34 -0500 Original-Received: from smtp12.dentaku.gol.com ([203.216.5.74]) by mx20.gnu.org with esmtp (Exim 4.60) (envelope-from ) id 1NBl0G-00038X-VZ; Sat, 21 Nov 2009 03:07:33 -0500 Original-Received: from 218.231.174.56.eo.eaccess.ne.jp ([218.231.174.56] helo=catnip.gol.com) by smtp12.dentaku.gol.com with esmtpa (Dentaku) id 1NBl0E-0005T1-FE; Sat, 21 Nov 2009 17:07:30 +0900 Original-Received: by catnip.gol.com (Postfix, from userid 1000) id BB965DF8C; Sat, 21 Nov 2009 17:07:29 +0900 (JST) System-Type: x86_64-unknown-linux-gnu In-Reply-To: <87iqd4tkv4.fsf@red-bean.com> (Karl Fogel's message of "Sat, 21 Nov 2009 01:09:19 -0600") Original-Lines: 16 X-Virus-Scanned: ClamAV GOL (outbound) X-Abuse-Complaints: abuse@gol.com X-detected-operating-system: by mx20.gnu.org: GNU/Linux 2.6 (newer, 3) X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6, seldom 2.4 (older, 4) 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:117418 Archived-At: 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. -Miles -- The automobile has not merely taken over the street, it has dissolved the living tissue of the city. Its appetite for space is absolutely insatiable; moving and parked, it devours urban land, leaving the buildings as mere islands of habitable space in a sea of dangerous and ugly traffic. [James Marston Fitch, New York Times, 1 May 1960]