unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Thien-Thi Nguyen <ttn@gnuvola.org>
To: "Óscar Fuentes" <ofv@wanadoo.es>
Cc: emacs-devel@gnu.org
Subject: Re: Please don't use revision numbers on commit messages (and elsewhere).
Date: Fri, 01 Apr 2011 10:38:26 +0200	[thread overview]
Message-ID: <874o6iicxp.fsf@ambire.localdomain> (raw)
In-Reply-To: <87pqp6vn3p.fsf@wanadoo.es> ("Óscar Fuentes"'s message of "Fri, 01 Apr 2011 02:20:26 +0200")

[-- Attachment #1: Type: text/plain, Size: 1012 bytes --]

() Óscar Fuentes <ofv@wanadoo.es>
() Fri, 01 Apr 2011 02:20:26 +0200

   It is actually informative, although it makes difficult to pinpoint the
   mentioned revision or to answer the question "is the mentioned revision on
   branch X?" which is automatic when you have a revision id.

To dereference a DATE-TITLE pair to a VCS commit the VCS needs to be able to
grep for DATE or TITLE or both in its (internal) commit log representation.
It's an extra step, true, and might be difficult if the VCS is lame.  Likewise
for localizing the commit to a branch.

   A different issue is to convince people to write proper commit messages,
   with the first line acting as the commit title. But that is another
   battle.

All it takes is for the Emacs maintainers to promote the practice from IWBN to
required.  I think concurrent to such a move should be to publish tools to make
the ChangeLog(s) -> VCS commit message flow less balky.  FWIW, i attach some
sketches (that i find useful) here.


[-- Attachment #2: changelog-to-vcs-commit-message-flow.el --]
[-- Type: application/emacs-lisp, Size: 3513 bytes --]

[-- Attachment #3: Type: text/plain, Size: 1031 bytes --]


Example flow:
(0) Munge source in file src/foo.c,
    related docs in file doc/foo.texi.

(1) C-x C-f src/ChangeLog RET
    C-c C-a TITLE RET
    foo.c (func): Change. RET RET
    C-x C-s
    C-x C-k RET

(2) C-x C-f doc/ChangeLog RET
    C-c C-a M-p RET
    foo.texi (functionality): Change. RET RET
    C-x C-s
    C-x C-k RET

(3) initiate commit sequence, specifying files:
      src/ChangeLog
      src/foo.c
      doc/ChangeLog
      doc/foo.texi
    => end up in buffer in Log Edit mode

(4) C-c C-d        ; git-scan-log-buffer-and-insert-commit-log
    tweak aesthetics (paragraph order, primarily)
    C-c C-c        ; log-edit-done
    C-c C-M-r      ; revert-some-buffers

This example assumes the details of each change fits in my head, which often
is not the case.  More typically, there is a series of ‘vc-diff’ invocations
prior to (1) and (2).  I sometimes (very rarely) interleave (0) and (1)/(2).
Anyway, the point is that (3) and (4) take little thought/effort to perform.

  reply	other threads:[~2011-04-01  8:38 UTC|newest]

Thread overview: 86+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-03-31 20:47 Please don't use revision numbers on commit messages (and elsewhere) Óscar Fuentes
2011-03-31 21:36 ` Lennart Borgman
2011-03-31 21:53   ` Óscar Fuentes
2011-03-31 21:59     ` Lennart Borgman
2011-03-31 22:06       ` Óscar Fuentes
2011-03-31 22:18         ` Lennart Borgman
2011-03-31 22:58       ` Juanma Barranquero
2011-04-01  7:42   ` Eli Zaretskii
2011-04-01  7:58     ` Andreas Schwab
2011-04-01  8:02       ` Eli Zaretskii
2011-04-01  8:17         ` Andreas Schwab
2011-04-01  8:42           ` Eli Zaretskii
2011-04-01  8:54             ` Andreas Schwab
2011-04-01 10:11               ` Eli Zaretskii
2011-04-01 10:21                 ` Andreas Schwab
2011-04-01 10:48                   ` Eli Zaretskii
2011-04-01 11:18                     ` Andreas Schwab
2011-04-01 13:15                       ` Eli Zaretskii
2011-04-01 13:32                         ` Andreas Schwab
2011-04-01 13:47                           ` Eli Zaretskii
2011-04-01 13:51                             ` Deniz Dogan
2011-04-01 15:26         ` Óscar Fuentes
2011-04-01 19:13           ` Eli Zaretskii
2011-04-01 20:17             ` Óscar Fuentes
2011-03-31 23:14 ` Juanma Barranquero
2011-04-01  0:11   ` Óscar Fuentes
2011-04-01  0:28     ` Juanma Barranquero
2011-04-01  1:20       ` Óscar Fuentes
2011-04-01  8:18         ` Eli Zaretskii
2011-04-01 12:08           ` David Kastrup
2011-04-01 13:15             ` Eli Zaretskii
2011-04-01 15:35           ` Óscar Fuentes
2011-04-01 19:52             ` Eli Zaretskii
2011-04-01 20:04               ` David Kastrup
2011-04-01 20:36                 ` Eli Zaretskii
2011-04-01 20:43               ` Óscar Fuentes
2011-04-01 10:34         ` Juanma Barranquero
2011-04-01 15:55           ` Óscar Fuentes
2011-04-01 21:53             ` Juanma Barranquero
2011-04-04 16:32           ` Nils Ackermann
2011-04-04 21:27             ` Juanma Barranquero
2011-04-04 21:36               ` Lennart Borgman
2011-04-04 21:49                 ` Juanma Barranquero
2011-04-04 22:03                   ` Lennart Borgman
2011-04-04 22:09                     ` Juanma Barranquero
2011-04-04 22:27               ` Stefan Monnier
2011-04-04 22:35                 ` Juanma Barranquero
2011-04-05 21:00                   ` Thien-Thi Nguyen
2011-04-05 21:00                   ` Thien-Thi Nguyen
2011-04-06  1:30                     ` Stefan Monnier
2011-04-06  2:55                       ` Stephen J. Turnbull
2011-04-06 12:47                         ` Thien-Thi Nguyen
2011-04-01  1:59       ` Stephen J. Turnbull
2011-04-01 10:00         ` Uday S Reddy
2011-04-01 15:00           ` Stephen J. Turnbull
2011-04-01 16:38             ` Uday S Reddy
2011-04-01 18:08               ` Stephen J. Turnbull
2011-04-01 18:56                 ` Uday S Reddy
2011-04-01 20:49                   ` Stephen J. Turnbull
2011-04-01 10:45         ` Juanma Barranquero
2011-04-01 14:51           ` Stefan Monnier
2011-04-01 15:14             ` Ted Zlatanov
2011-04-01 19:58             ` Juanma Barranquero
2011-04-02  2:12     ` Chong Yidong
2011-04-01  1:35   ` Stephen J. Turnbull
2011-04-01 10:39     ` Juanma Barranquero
2011-03-31 23:16 ` Thien-Thi Nguyen
2011-04-01  0:20   ` Óscar Fuentes
2011-04-01  8:38     ` Thien-Thi Nguyen [this message]
2011-04-01  9:36       ` Eli Zaretskii
2011-04-01 10:14         ` Eli Zaretskii
2011-04-01 17:38           ` Thien-Thi Nguyen
2011-04-01 15:38         ` Óscar Fuentes
2011-04-01 19:12           ` Eli Zaretskii
2011-04-01 20:21             ` Óscar Fuentes
2011-04-01 20:38               ` Eli Zaretskii
2011-04-01 21:40               ` Uday S Reddy
2011-04-02  0:03                 ` Óscar Fuentes
2011-04-02  6:20                   ` Uday S Reddy
2011-04-02 13:47                     ` Óscar Fuentes
2011-04-03  8:00                       ` Uday S Reddy
2011-04-03 16:13                         ` Óscar Fuentes
2011-04-04  9:29                           ` Uday S Reddy
2011-04-05  2:20                             ` Stephen J. Turnbull
2011-04-02  2:57                 ` Stephen J. Turnbull
2011-04-01  0:55 ` Stefan Monnier

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=874o6iicxp.fsf@ambire.localdomain \
    --to=ttn@gnuvola.org \
    --cc=emacs-devel@gnu.org \
    --cc=ofv@wanadoo.es \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).