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

Re: filenames in log message

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: 2003-11-12 01:27:13 CET

Greg Stein wrote:
> On Fri, Nov 07, 2003 at 12:20:19AM +0000, Julian Foad wrote:
>
>>...
>>I changed the log message a bit, to indicate briefly _why_ the change is
>>being made, and to omit the list of files, since the same change is made
>>to each file and the list of files is recorded automatically.
>
> The standard format lists all files changed. The theory here is that
> somebody might want to search the log messages -- for either file names,
> or maybe for certain functions.
>
> It is also helpful that when you pull up a log message for <FOO> that you
> see all effects during that patch.
>
> I'd request that the file list remains in the log message.
>
>
> All that said, there is an argument that 'svn log -v' will give you the
> list of files, so in certain cases we shouldn't bother. But I believe that
> is a specific discussion to have, and then an update of HACKING.

Here is what HACKING already says on the matter:

   * If your change was only to one file, or was the same change to
      multiple files, then there's no need to list their paths in the
      log message (because "svn log" can show the changed paths for
      that revision anyway). Only when you need to describe how the
      change affected different areas in different ways is it
      necessary to organize the log message by paths and symbols, as
      in the examples above.

I hope it was OK for me to follow that guideline.

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Wed Nov 12 01:25:35 2003

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