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

Re: [PATCH] 1.5.x branch: python/cmdline

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: Thu, 29 May 2008 22:01:36 +0100

Alexander Sinyushkin wrote:
> Sorry, I don't understand what I'm missing. It's not exactly a paste, I
> added description to changes
>
> >> * subversion/tests/cmdline/svntest/main.py
> >> (def copy_repos): close dump_in just after the first call to
> open_pipe()
> >> (def run): set SVN_CURRENT_TEST environment variable to the
> current test
> >> being run
> >> (def run_tests): make svndumpfilter_binary point to jsvndumpfilter
> binary if
> >> --use-jsvn is specified
>
> And why can not that entire and detailed description of mine be a log
> message?

Everyone else,

Please remember to be gentle on new committers.

Alexander,

Your log message is not bad, it's just that regular committers are accustomed
to a fairly precise and consistent style of log message, and it would be easier
for us (and would enable your patches to be accepted more quickly) if your log
message would conform to that style. As well as
<http://subversion.tigris.org/hacking.html#patches> which tries to explain that
style, looking at some previous log messages is a good way to get used to it.

One of the main points is that the description of the changes should be
concise, because people often need to quickly read through log messages to see
if they affect something in particular. Therefore, most of your introductory
text is too much detail about a particular environment. You only need to say
that it closes the stream so that any program waiting for the end of the stream
will not be held up.

Some other standards we keep are 79-column line width, sentences beginning with
a capital letter and ending with a period, and putting just the function names
in parentheses without the keyword "def ".

It is common for a new contributor not to have got used to that style and for
one of us to take the extra time to re-write it in a way that we like. However,
it's quite likely that nobody feels they can afford the time to do that at the
moment.

- Julian

> Daniel Shahaf wrote:
>
>> Alexander, I asked for a log message, not for a paste of your original
>> email surrounded by triple square brackets.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe_at_subversion.tigris.org
For additional commands, e-mail: dev-help_at_subversion.tigris.org
Received on 2008-05-29 23:01:59 CEST

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