You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Karl Fogel <kf...@red-bean.com> on 2007/09/11 18:29:21 UTC

Re: svn commit: r26498 - in branches/svnpatch-diff/subversion: libsvn_client libsvn_wc

cacknin@tigris.org writes:
> Author: cacknin
> Date: Sat Sep  8 11:00:26 2007
> New Revision: 26498
>
> Log:
> * subversion/libsvn_wc/diff.c
>   (transmit_svndiff, close_file, change_file_prop, change_dir_prop):
>   remove unused variables.
>
> * subversion/libsvn_client/repos_diff.c
>   (apply_textdelta): remove unused variables.
>
> * subversion/libsvn_client/patch.c
>   (get_empty_file): fix messy use of ||
>   (merge_file_added): avoid useless sprintf()
>   (open_directory, add_file, open_file, apply_textdelta,
>   change_file_prop, change_dir_prop): remove unused variables.
>
> * subversion/libsvn_client/diff.c
>   (diff_dir_added, diff_dir_deleted): remove unused variables.
>
> Messy || and useless sprintf()
> Found by: glasser

It's better to put the summary line at the start of the log message,
not the end.  That way, the reader can already be in the proper frame
of mind when reading the detailed part of the log message.

-K

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Re: svn commit: r26498 - in branches/svnpatch-diff/subversion: libsvn_client libsvn_wc

Posted by Karl Fogel <kf...@red-bean.com>.
"Charles Acknin" <ch...@gmail.com> writes:
> There's no summary line in this log message.  The last two lines were
> supposed to be read like so : "messy '||' and useless sprintf() buggy
> parts found by ...".
>
> Basically, this commit includes both things glasser fixed and things I
> fixed on my side.  So I had to write a "selective" 'found by'
> statement, i.e. one that does mention and filter out the parts the
> person was involved in.  And the reason this fits in two lines instead
> of one is because it seems the contrib parser
> (tools/dev/contribulyze.py) uses something like "^Found by:"  regexp,
> so the line had to begin by one of the field keyword.

Ah.  Thanks -- what you want to do is usually done in a parenthetical
aside after the "Found by" line, like so:

   Found by: glasser
   (Just the "messy ||" and "useless sprintf()" parts.)

> I guess we're here discussing this for the sole reason that this
> commit is breaking the "a patch must contain only one logical change"
> rule.  I'll make sure I don't make this mistake again in the future.

Well, that would be the ideal, yes :-).  But if you do commit a
miscellaneous bunch of changes at once, then there should still be a
summary line saying that's what you've done, so a reader doesn't go
looking for some unifying pattern that isn't there.  E.g.:

   Various random and unrelated cleanups:

   * subversion/libsvn_wc/diff.c
   (transmit_svndiff, close_file, change_file_prop, change_dir_prop):
   remove unused variables.

   [...]

-Karl

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Re: svn commit: r26498 - in branches/svnpatch-diff/subversion: libsvn_client libsvn_wc

Posted by Charles Acknin <ch...@gmail.com>.
On 9/11/07, Karl Fogel <kf...@red-bean.com> wrote:
> cacknin@tigris.org writes:
> > Author: cacknin
> > Date: Sat Sep  8 11:00:26 2007
> > New Revision: 26498
> >
> > Log:
> > * subversion/libsvn_wc/diff.c
> >   (transmit_svndiff, close_file, change_file_prop, change_dir_prop):
> >   remove unused variables.
> >
> > * subversion/libsvn_client/repos_diff.c
> >   (apply_textdelta): remove unused variables.
> >
> > * subversion/libsvn_client/patch.c
> >   (get_empty_file): fix messy use of ||
> >   (merge_file_added): avoid useless sprintf()
> >   (open_directory, add_file, open_file, apply_textdelta,
> >   change_file_prop, change_dir_prop): remove unused variables.
> >
> > * subversion/libsvn_client/diff.c
> >   (diff_dir_added, diff_dir_deleted): remove unused variables.
> >
> > Messy || and useless sprintf()
> > Found by: glasser
>
> It's better to put the summary line at the start of the log message,
> not the end.  That way, the reader can already be in the proper frame
> of mind when reading the detailed part of the log message.

There's no summary line in this log message.  The last two lines were
supposed to be read like so : "messy '||' and useless sprintf() buggy
parts found by ...".

Basically, this commit includes both things glasser fixed and things I
fixed on my side.  So I had to write a "selective" 'found by'
statement, i.e. one that does mention and filter out the parts the
person was involved in.  And the reason this fits in two lines instead
of one is because it seems the contrib parser
(tools/dev/contribulyze.py) uses something like "^Found by:"  regexp,
so the line had to begin by one of the field keyword.

I guess we're here discussing this for the sole reason that this
commit is breaking the "a patch must contain only one logical change"
rule.  I'll make sure I don't make this mistake again in the future.

Cheers,
Charles

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org