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: Commit netiquette. Date: Mon, 22 Feb 2010 11:17:23 +0900 Message-ID: <87pr3y6mks.fsf@catnip.gol.com> References: <87eikjzaug.fsf@telefonica.net> <87vdds6lmc.fsf@catnip.gol.com> <83ljeovvd0.fsf@gnu.org> Reply-To: Miles Bader NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: dough.gmane.org 1266806572 31172 80.91.229.12 (22 Feb 2010 02:42:52 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Mon, 22 Feb 2010 02:42:52 +0000 (UTC) Cc: ofv@wanadoo.es, lekktu@gmail.com, ams@gnu.org, emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Feb 22 03:42:47 2010 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.69) (envelope-from ) id 1NjNrg-0002Wm-7m for ged-emacs-devel@m.gmane.org; Mon, 22 Feb 2010 03:17:40 +0100 Original-Received: from localhost ([127.0.0.1]:55313 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1NjNrf-0008RG-8v for ged-emacs-devel@m.gmane.org; Sun, 21 Feb 2010 21:17:39 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1NjNrZ-0008RB-1c for emacs-devel@gnu.org; Sun, 21 Feb 2010 21:17:33 -0500 Original-Received: from [140.186.70.92] (port=45898 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1NjNrY-0008R2-5E for emacs-devel@gnu.org; Sun, 21 Feb 2010 21:17:32 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1NjNrX-0000wy-MA for emacs-devel@gnu.org; Sun, 21 Feb 2010 21:17:32 -0500 Original-Received: from smtp11.dentaku.gol.com ([203.216.5.73]:57900) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1NjNrS-0000wJ-S7; Sun, 21 Feb 2010 21:17:27 -0500 Original-Received: from 218.231.96.119.eo.eaccess.ne.jp ([218.231.96.119] helo=catnip.gol.com) by smtp11.dentaku.gol.com with esmtpa (Dentaku) id 1NjNrQ-00067H-QP; Mon, 22 Feb 2010 11:17:24 +0900 Original-Received: by catnip.gol.com (Postfix, from userid 1000) id AF118DF91; Mon, 22 Feb 2010 11:17:23 +0900 (JST) System-Type: x86_64-unknown-linux-gnu In-Reply-To: <83ljeovvd0.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 20 Feb 2010 16:23:55 +0200") Original-Lines: 51 X-Virus-Scanned: ClamAV GOL (outbound) X-Abuse-Complaints: abuse@gol.com X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) 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:121257 Archived-At: Eli Zaretskii writes: >> Of course, people could also provide summary lines in a ChangeLog -- >> e.g., prefix a classic ChangeLog entry with a "SUMMARY:" line. Indeed, >> I'd recommend that people do this, even though it's not a part of the >> classic ChangeLog format (I do this sometimes when adding a single >> cohesive change that touches many files); it makes ChangeLogs easier to >> read and more useful. > > However, the "SUMMARY:" part just wastes precious real estate of the > single line produced by "bzr log --line". Eh? I'm confused... I don't mean they should literally write the string "SUMMARY:", and I was talking about ChangeLog files, not commit-logs. What I was advocating was, _in ChangeLog files_, a style like: 2010-02-22 Miles Bader > Frobbed the grot system: * grot-blah.el (fun1, fun2): Blurged frebly. * grot-zung.el (fun3): Nug n ug. * some-grup.el (zoon): Wabawaba. This isn't always necessary for small/trivial changes, but for longer ones, i think it's a useful addition. Indeed, one can imagine a ChangeLog style where the commit-log text (following typical commit-log conventions) is used a prefix for traditional ChangeLog-type per-file entries. For instance: 2010-02-22 Miles Bader > Frobbed the grot system The Grot system was blorked, so rewrite all the zoong-nurbs using an explicit snood cache. * grot-blah.el (fun1, fun2): Blurged frebly. * grot-zung.el (fun3): Nug n ug. * some-grup.el (zoon): Wabawaba. Again, all the comments above pertain to ChangeLog files, not commit-logs [for commit-logs, of course I recommend the standard 1-line (without period) summary followed if necessary by a more verbose description in additional paragraphs]. -Miles -- "... The revolution will be no re-run brothers; The revolution will be live."