[Box Backup-dev] COMMIT r863 - box/chris/merge/bin/bbstored

[Martin Ebourne]

On Thu, 2006-08-31 at 21:25 +0100, James O'Gorman wrote:
> On Thu, Aug 31, 2006 at 09:15:41PM +0100, Chris Wilson wrote:
> > It did work, but the formatting is not ideal. I wonder if I should format 
> > my commit messages differently, like this:
> > 
> > * bin/bbstored/BackupStoreDaemon.h
> > 
> > 	fixed foo
> > 
> > 	fixed bar
> > 
> > which should look better in trac. Is that a good idea?
> 
> You can either use Trac's WikiFormatting (i.e. use [BR] to force a hard
> line break) or, as you say just double-line space it.
> 
> At the end of the day, I would guess it's probably more important to
> make it readable in the svn commit message rather than in Trac's
> automatic ticket feeding. But then I'm not the one committing, so maybe
> Ben and Martin might have some views on this.

I'm not really fussed. I don't mind wiki formatting in svn as long as
it's still readable in svn log, and I don't mind if it doesn't look
perfect in trac as long as it is still readable.

One thing I've been thinking for a while is that including the list of
files changed in the commit message is completely unnecessary and really
just adds clutter.

If you want to know which files were changed then it's just 'svn log -v'
which is easy enough.

Each entry in trac automatically hyperlinks through to the commit log
and diff so it's not needed there either.

And if you find yourself listing the files in the message so you can say
what you did to each of them it should be in separate commits
instead. :)

Cheers,

Martin.