From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Stephen J. Turnbull" Newsgroups: gmane.emacs.devel Subject: Re: Please don't use revision numbers on commit messages (and elsewhere). Date: Tue, 05 Apr 2011 11:20:19 +0900 Message-ID: <8739lxsal8.fsf@uwakimon.sk.tsukuba.ac.jp> References: <877hbfvwyo.fsf@wanadoo.es> <87sju2hoee.fsf@ambire.localdomain> <87pqp6vn3p.fsf@wanadoo.es> <874o6iicxp.fsf@ambire.localdomain> <83mxkapb2g.fsf@gnu.org> <87zkoat20x.fsf@wanadoo.es> <83liztyeed.fsf@gnu.org> <87ipuxu3hb.fsf@wanadoo.es> <87aag9tt7e.fsf@wanadoo.es> <87hbagsr1x.fsf@wanadoo.es> <871v1js48d.fsf@wanadoo.es> <19865.36719.736000.336002@gargle.gargle.HOWL> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Transfer-Encoding: quoted-printable X-Trace: dough.gmane.org 1301971182 8359 80.91.229.12 (5 Apr 2011 02:39:42 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Tue, 5 Apr 2011 02:39:42 +0000 (UTC) Cc: =?iso-8859-1?Q?=D3scar?= Fuentes , emacs-devel@gnu.org To: Uday S Reddy Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Apr 05 04:39:38 2011 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 1Q6wB7-0002iK-Kp for ged-emacs-devel@m.gmane.org; Tue, 05 Apr 2011 04:39:37 +0200 Original-Received: from localhost ([127.0.0.1]:41471 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Q6wB7-00072i-5v for ged-emacs-devel@m.gmane.org; Mon, 04 Apr 2011 22:39:37 -0400 Original-Received: from [140.186.70.92] (port=38186 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Q6wB1-00070h-Hw for emacs-devel@gnu.org; Mon, 04 Apr 2011 22:39:32 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Q6wB0-0000uZ-Ku for emacs-devel@gnu.org; Mon, 04 Apr 2011 22:39:31 -0400 Original-Received: from mgmt2.sk.tsukuba.ac.jp ([130.158.97.224]:58251) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Q6wB0-0000ts-5Z for emacs-devel@gnu.org; Mon, 04 Apr 2011 22:39:30 -0400 Original-Received: from uwakimon.sk.tsukuba.ac.jp (uwakimon.sk.tsukuba.ac.jp [130.158.99.156]) by mgmt2.sk.tsukuba.ac.jp (Postfix) with ESMTP id 66A869706AB; Tue, 5 Apr 2011 11:14:55 +0900 (JST) Original-Received: by uwakimon.sk.tsukuba.ac.jp (Postfix, from userid 1000) id 0F98D1A4B35; Tue, 5 Apr 2011 11:20:19 +0900 (JST) In-Reply-To: <19865.36719.736000.336002@gargle.gargle.HOWL> X-Mailer: VM 8.1.93a under 21.5 (beta29) "garbanzo" eac2e6bd5b2c+ XEmacs Lucid (x86_64-unknown-linux) Cancel-Lock: sha1:jOalpQ6rW8vQHMbMzTB/TM/pl3c= X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 130.158.97.224 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:138169 Archived-At: Uday S Reddy writes: > the problem with such a note is that it says precious little unless > you go and find the revision XXXX. I don't think =D3scar meant that as an example of log style. He was focusing on the the issue of following the reference to a revision. > Those of us that write technical articles have been taught to use > the convention that the text should stand on its own without having > to follow the cross-references to understand what it is saying. Sorry, but you're misrepresenting the convention you cite. Editors of technical articles require both well-written notes and bibliographies "for those proofs that won't fit in this narrow margin." Similarly, the revision log should describe the semantics of the change, while the diff against the revision gives its syntax. Therefore, a commit log message should both describe the change made, and provide a machine-friendly cross-reference (machine-friendly because this is Emacs; we may expect that the developers will have machine assistance in following cross-references). I think there are more important things for the people who will be writing the log browser to do than catch the edge cases that your algorithm doesn't handle, since the browser mode doesn't exist yet. OTOH, change-log-mode does exist; adding something to find and insert unambiguous revision identifiers from any revision specification seems to be more in scope. FWIW IMHO YMMV. HAND.