git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Pratyush Yadav <me@yadavpratyush.com>
Cc: <git@vger.kernel.org>
Subject: Re: [PATCH] git-shortlog.txt: mention commit filtering options
Date: Sat, 02 Nov 2019 14:43:29 +0900	[thread overview]
Message-ID: <xmqqftj64yv2.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <20191030203603.27497-1-me@yadavpratyush.com> (Pratyush Yadav's message of "Thu, 31 Oct 2019 02:06:03 +0530")

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?

Thanks.

>  MAPPING AUTHORS
>  ---------------
>
> --
> 2.21.0

  reply	other threads:[~2019-11-02  5:43 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 [this message]
2019-11-02 22:50   ` Pratyush Yadav
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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqftj64yv2.fsf@gitster-ct.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=me@yadavpratyush.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.
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 NNTP newsgroup(s).