[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

RE: Change documentation

From: Fournier,Danny [NCR] <Danny.Fournier_at_ec.gc.ca>
Date: 2006-12-24 02:41:16 CET

Very good points... So much so that I should have picked this up myself.

Any guidelines on using the commit message for documentation. Are there
Subversion variables that one can use $abc$ or somethin'? There was also
something about Trac.

Thanks a lot... Looking forward to starting 07 on the right (and good)
foot :)

DF

-----Original Message-----
From: Andy Levy [mailto:andy.levy@gmail.com]
Sent: Wednesday, December 20, 2006 7:55 PM
To: Fournier,Danny [NCR]
Cc: users@subversion.tigris.org
Subject: Re: Change documentation

On 12/20/06, Fournier,Danny [NCR] <Danny.Fournier@ec.gc.ca> wrote:
> If I maintain a header in each page, stating the changes (date, whom
> and
> description) that I've made to them, is there a real need to provide
> comments during commit? If so, would it be adequate to provide the
> same message/info?

But then you'd have to read through every revision of that file to find
the change history (comments). Put into the actual commit messages and
svn log <filename> does it for you, and you can turn around and use it
for your changelog as well.

Plus, if you ever want to release a snapshot of your code and the
receiver(s) don't need the change history (or you don't want them to see
it - maybe you have sensitive information in there), you'll have to go
through and scrub the files if you keep the history right in the file
contents.

I don't see the advantage to doing what you're describing. If you're
using a version-control tool, use everything it makes available to keep
track of things.

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@subversion.tigris.org
For additional commands, e-mail: users-help@subversion.tigris.org
Received on Sun Dec 24 02:41:52 2006

This is an archived mail posted to the Subversion Users mailing list.