From: Jeff King <peff@peff.net>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: Git List <git@vger.kernel.org>
Subject: Re: [PATCH 2/8] shortlog: refactor committer/author grouping
Date: Sun, 27 Sep 2020 04:03:45 -0400 [thread overview]
Message-ID: <20200927080345.GB1286220@coredump.intra.peff.net> (raw)
In-Reply-To: <CAPig+cTfYmNAP_65RDa_fZOyuQEH65HuLs-UYSPT0yJ=s6BftA@mail.gmail.com>
On Fri, Sep 25, 2020 at 04:05:04PM -0400, Eric Sunshine wrote:
> > +--group=<type>::
> > + By default, `shortlog` collects and collates author identities;
> > + using `--group` will collect other fields.
> > + `<type>` is one of:
> > ++
> > + - `author`, commits are grouped by author (this is the default)
> > + - `committer`, commits are grouped by committer (the same as `-c`)
>
> I had trouble interpreting "(this is the default)". It made me think
> that <type> is optional:
>
> --group[=<type>]
>
> but that isn't the case at all. Instead, it means that if --group
> isn't specified, then grouping is done by `author` by default.
Right.
> It also
> repeats what the general description of --group already says with
> regard to the default, thus it is redundant to say it again when
> describing the `author` type. Therefore, perhaps drop "(this is the
> default)" altogether?
OK. I was worried somebody wouldn't quite pick up on the default. We
could spell it out as:
- `author`, commits are grouped by author (this is the default if no
--group is given)
but that's pretty lengthy. We could also reword the whole thing as:
--group=<type>::
Collect and collate values of type `<type>`; if no `--group`
option is given, the default is `author`:
- `author`, commits are grouped by author
- `committer`, commits are grouped by committer (the same as `-c`)
I'm not sure if that's clearer or not. The first sentence seems a bit
opaque, but I'm not sure how to improve it.
For now (and what plan to send out in v2), I'll take your suggestion to
just drop the phrase.
-Peff
next prev parent reply other threads:[~2020-09-27 8:03 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-25 7:01 [PATCH 0/8] parsing trailers with shortlog Jeff King
2020-09-25 7:01 ` [PATCH 1/8] shortlog: change "author" variables to "ident" Jeff King
2020-09-25 7:02 ` [PATCH 2/8] shortlog: refactor committer/author grouping Jeff King
2020-09-25 20:05 ` Eric Sunshine
2020-09-27 8:03 ` Jeff King [this message]
2020-09-27 8:08 ` Jeff King
2020-09-27 8:23 ` Eric Sunshine
2020-09-26 12:31 ` Martin Ågren
2020-09-27 7:59 ` Jeff King
2020-09-25 7:02 ` [PATCH 3/8] trailer: add interface for iterating over commit trailers Jeff King
2020-09-26 12:39 ` Martin Ågren
2020-09-27 8:20 ` Jeff King
2020-09-25 7:03 ` [PATCH 4/8] shortlog: match commit trailers with --group Jeff King
2020-09-25 7:05 ` [PATCH 5/8] shortlog: de-duplicate trailer values Jeff King
2020-09-25 7:05 ` [PATCH 6/8] shortlog: rename parse_stdin_ident() Jeff King
2020-09-25 7:05 ` [PATCH 7/8] shortlog: parse trailer idents Jeff King
2020-09-25 7:05 ` [PATCH 8/8] shortlog: allow multiple groups to be specified Jeff King
2020-09-25 20:23 ` Eric Sunshine
2020-09-27 8:06 ` Jeff King
2020-09-26 12:48 ` Martin Ågren
2020-09-27 8:25 ` Jeff King
2020-09-25 14:27 ` [PATCH 0/8] parsing trailers with shortlog Derrick Stolee
2020-09-25 16:57 ` Junio C Hamano
2020-09-27 8:39 ` [PATCH v2 " Jeff King
2020-09-27 8:39 ` [PATCH v2 1/8] shortlog: change "author" variables to "ident" Jeff King
2020-09-27 19:18 ` Junio C Hamano
2020-09-27 8:39 ` [PATCH v2 2/8] shortlog: add grouping option Jeff King
2020-09-27 8:40 ` [PATCH v2 3/8] trailer: add interface for iterating over commit trailers Jeff King
2020-09-27 8:40 ` [PATCH v2 4/8] shortlog: match commit trailers with --group Jeff King
2020-09-27 19:51 ` Junio C Hamano
2020-09-28 3:17 ` Jeff King
2020-09-28 17:01 ` Junio C Hamano
2020-09-27 8:40 ` [PATCH v2 5/8] shortlog: de-duplicate trailer values Jeff King
2020-09-27 20:23 ` Junio C Hamano
2020-09-28 3:19 ` Jeff King
2020-09-27 8:40 ` [PATCH v2 6/8] shortlog: rename parse_stdin_ident() Jeff King
2020-09-27 8:40 ` [PATCH v2 7/8] shortlog: parse trailer idents Jeff King
2020-09-27 20:49 ` Junio C Hamano
2020-09-27 8:40 ` [PATCH v2 8/8] shortlog: allow multiple groups to be specified Jeff King
2020-09-27 21:18 ` Junio C Hamano
2020-09-28 3:25 ` Jeff King
2020-12-28 11:29 ` Junio C Hamano
2021-02-04 6:44 ` Junio C Hamano
2020-09-27 14:38 ` [PATCH v2 0/8] parsing trailers with shortlog Martin Ågren
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200927080345.GB1286220@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).