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

Re: [PATCH] issue#2317 - Problem with Peg Revisions for filescontaining '@' - V2

From: <kfogel_at_collab.net>
Date: 2005-07-05 21:33:31 CEST

Julian Foad <julianfoad@btopenworld.com> writes:
> Alexander Thomas wrote:
> > Hey Julian,
> > Welcome Back :)
>
> Thanks.
>
> > On Tue, 2005-07-05 at 14:53 +0100, Julian Foad wrote:
> >>Alexander Thomas wrote:
> >>>[[[
> >>>Version 2: Fix for issue 2317 - Problem with Peg Revisions for files
> >>>containing '@'.
> >>
> >> Please state here what the patch does, and don't state here (in the
> >> log message) that it is "Version 2".
> > Sorry, Version 2 of the patch attached
> > [[[
> > Fix for issue 2317 - Problem with Peg Revisions for files containing
> > '@'.
>
> Um, when I said "state what the patch does" I meant that you should
> write a sentence or two describing the effect of this patch - in other
> words, how the behaviour of Subversion after this patch differs from
> the behaviour before the patch. If this were a simple bug with a
> single, obvious solution, that would be unnecessary, but it's not.

Alexander, perhaps this meta-explanation will help with log messages:

The intended audience is a Subversion developer who is not familiar
with the change. Usually when someone goes back and reads a change
(which happens surprisingly frequently), they no longer have in their
head all the context around that change. They've forgotten the mails
about it, the issue, the code discussions, etc. It could be six
months later and they're porting it to a release branch and need to
review it, or something like that.

Your log message is the introduction to the change. Write it for an
experienced Subversion developer who is starting with no particular
knowledge of what this change is about, but who knows Subversion in
general.

Hope this helps,
-Karl

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Tue Jul 5 22:35:57 2005

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