From: Pratyush Yadav <me@yadavpratyush.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] git-shortlog.txt: mention commit filtering options
Date: Sun, 3 Nov 2019 04:20:45 +0530 [thread overview]
Message-ID: <20191102225045.zxxomy357zctxhfh@yadavpratyush.com> (raw)
In-Reply-To: <xmqqftj64yv2.fsf@gitster-ct.c.googlers.com>
On 02/11/19 02:43PM, Junio C Hamano wrote:
> Pratyush Yadav <me@yadavpratyush.com> writes:
>
> > git-shortlog, like git-log, supports options to filter what commits are
> > used to generate the log. These options come from git-rev-list. Add a
> > pointer to these options in the documentation page so readers can know
> > these filtering options can be used with git-shortlog too.
> >
> > Signed-off-by: Pratyush Yadav <me@yadavpratyush.com>
> > ---
> > Since [0] didn't get any responses, I figured a patch might get some
> > more attention since it is something concrete to comment on.
> >
> > [0] https://public-inbox.org/git/20191024191709.gqkjljuibyashtma@yadavpratyush.com/
> >
> > Documentation/git-shortlog.txt | 5 +++++
> > 1 file changed, 5 insertions(+)
> >
> > diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
> > index bc80905a8a..acae695388 100644
> > --- a/Documentation/git-shortlog.txt
> > +++ b/Documentation/git-shortlog.txt
> > @@ -76,6 +76,11 @@ them.
> > Paths may need to be prefixed with `--` to separate them from
> > options or the revision range, when confusion arises.
> >
> > +In addition to the options above, 'git shortlog' also supports a range of
> > +options to select which subset of commits will be used to generate the
> > +shortlog. A list of these options can be found in the "Commit Limiting"
> > +section of linkgit:git-rev-list[1].
>
> How does "git log --help" handle the corresponding part of its
> documentation?
>
> ... goes and looks ...
>
> I wonder if it is better to just include rev-list-options.txt like
> "git-log.txt" does, instead of adding these four lines?
Quoting from my initial email [0] about this topic:
rev-list-options.txt is a rather large file and I'm not sure if
including it in both git-log and git-shortlog would be a good idea.
The way I see it, git-log is the "primary" log interface, and
git-shortlog is a "secondary" log interface, so git-log warrants such
a large man page, but git-shortlog doesn't especially since most
options are repeated. So maybe it is a better idea to just include a
pointer to git-rev-list in the shortlog man page.
But if you think including the whole thing is better, I don't mind that
either. Will re-roll.
[0] https://public-inbox.org/git/20191024191709.gqkjljuibyashtma@yadavpratyush.com/
--
Regards,
Pratyush Yadav
next prev parent reply other threads:[~2019-11-02 22:50 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-30 20:36 [PATCH] git-shortlog.txt: mention commit filtering options Pratyush Yadav
2019-11-02 5:43 ` Junio C Hamano
2019-11-02 22:50 ` Pratyush Yadav [this message]
2019-11-04 3:37 ` Junio C Hamano
2019-11-04 13:08 ` [PATCH v2] git-shortlog.txt: include commit limiting options Pratyush Yadav
2019-11-06 1:24 ` Junio C Hamano
2019-11-08 19:26 ` [PATCH v3] " Pratyush Yadav
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=20191102225045.zxxomy357zctxhfh@yadavpratyush.com \
--to=me@yadavpratyush.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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).