develooper Front page | perl.perl5.porters | Postings from January 2020

Re: request for better commit subject lines

Thread Previous | Thread Next
From:
demerphq
Date:
January 14, 2020 17:34
Subject:
Re: request for better commit subject lines
Message ID:
CANgJU+XcQb-+vQowPppWBn8GAiJ3iVLGCjfcJuPhF1D_B=osRA@mail.gmail.com
On Tue, 14 Jan 2020, 18:26 Dave Mitchell, <davem@iabyn.com> wrote:

> I don't know whether its got worse since moving to github, but we seem to
> have had a spate of commit messages whose first lines give no clue as to
> what part of the perl distribution is being modified. To take a typical
> example (I'm not naming the author here - its just a random example), the
> commit message is:
>
>     Move keywords from a regexp to a qw() list
>
> What keywords are these? Is it discussing a new way for perl's tokenizer
> to process source code perhaps? No! Looking at the actual diff, its just
> making a test script (t/op/coreamp.t) more readable / greppable.
>
> Please folks, remember (where sensible) to prefix or otherwise decorate
> the commit message with some location info, e.g.
>
>     t/op/coreamp.t: Move keywords from a regexp to a qw() list
>
> More examples of good practice (if I may say so myself):
>
>     avoid use-after free in /(?{...})/
>     Perl_Slab_Alloc(): tweak logging
>     fix leak in APItest.xs
>     signatures: add taint tests
>
> That concludes today's grumble.
>

Are you familiar with the --stat argument?
$ git log --stat -1 ca902fb80835be4a725df117917a4b62cc7022fe
commit ca902fb80835be4a725df117917a4b62cc7022fe (origin/blead, origin/HEAD)
Author: Yves Orton <demerphq@gmail.com>
Date:   Thu Jan 9 15:36:41 2020 +0100

    Fix Issue #17372 - Deal with NOTHING regops in trie code properly

    We weren't handling NOTHING regops that were not followed
    by a trieable type in the trie code.

 regcomp.c     | 25 ++++++++++++++++++++++++-
 t/re/re_tests |  3 ++-
 2 files changed, 26 insertions(+), 2 deletions(-)

Notice the file and linecount data is added to the log message. Works with
most of the other options, eg --oneline

ca902fb808 (origin/blead, origin/HEAD) Fix Issue #17372 - Deal with NOTHING
regops in trie code properly
 regcomp.c     | 25 ++++++++++++++++++++++++-
 t/re/re_tests |  3 ++-
 2 files changed, 26 insertions(+), 2 deletions(-)

Yves

Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About