emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Please don't use revision numbers on commit messages (and elsewhere)


From: Thien-Thi Nguyen
Subject: Re: Please don't use revision numbers on commit messages (and elsewhere).
Date: Fri, 01 Apr 2011 01:16:09 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/24.0.50 (gnu/linux)

() Óscar Fuentes <address@hidden>
() Thu, 31 Mar 2011 22:47:27 +0200

   please use the revision id, which is unique for every commit.

I think it would both more vcs-agnostic and programmer-friendly to use a
date and commit title (presuming the commit has one).  For example:

  2011-03-31  Thien-Thi Nguyen  <address@hidden>
  
        [lib] Fix bug: Reorder #include "libserveez/foo.h" in libserveez.h.
  
        Regression (due to omission) introduced 2011-03-04,
        "Mark #include "libservez/foo.h" as internal".
        Lesson: Take care when discarding dependency (ordering) info!
  
        * libserveez.h: Move ‘pipe-socket’ and ‘portcfg’ before ‘cfg’.
  
Here, the date is 2011-03-04, and the title is "Mark ... internal".
These two pieces of info are usually sufficient to uniquely identify a
particular change, and a nice side benefit is that the window of the bug
is apparently computable (in this example almost four weeks -- eep!).

More mumblings on ChangeLog format at:

  http://git.savannah.gnu.org/cgit/serveez.git/tree/HACKING?h=next#n228



reply via email to

[Prev in Thread] Current Thread [Next in Thread]