bug-standards
[Top][All Lists]
Advanced

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

Re: changelog format


From: Stefano Lattarini
Subject: Re: changelog format
Date: Sat, 28 Apr 2012 19:30:00 +0200

On 04/28/2012 02:15 PM, Thien-Thi Nguyen wrote:
> Oops, forgot the patch.  Here it is:
> 
I really like your patch, it's a definte improvement over the
previous situation.  I strongly disagree on one point though:

  +A reference to another change should be expressed as a date
  +and optionally a title if the date is insufficient to uniquely
  +identify the reference.
  +We recommend this over using a VCS commit identifier primarily
  +to keep the change log self-contained, and secondarily to avoid
  +lossage should the project switch to another VCS in the future.

Here, we should advise to use the date and (optionally) the summary
of the referenced change *in addition* to its commit ID (or a
proper "abridged" versions thereof, e.g., in git, the output of
"git describe").  Otherwise, one loses the possibility of following
cross-references between commits with a single click of mouse when
browsing the VCS history through tools like 'gitk' (and the
equivalent ones for other VCS).

Thanks,
  Stefano



reply via email to

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