git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] git-shortlog.txt: mention commit filtering options

From
Junio C Hamano <gitster@pobox.com>
Date
Nov 2, 2019, 05:43 UTC
Message-ID
<xmqqftj64yv2.fsf@gitster-ct.c.googlers.com>
In-Reply-To
<20191030203603.27497-1-me@yadavpratyush.com>
Pratyush Yadav <me@yadavpratyush.com> writes:
Show 27 quoted lines
> 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.
Show 5 quoted lines
>  MAPPING AUTHORS
>  ---------------
>
> --
> 2.21.0
Previous: Pratyush YadavNext: Pratyush Yadav
Message 2 of 7 in “git-shortlog.txt: mention commit filtering options”
  1. git-shortlog.txt: mention commit filtering optionsPratyush Yadav, Oct 30, 2019
  2. Junio C HamanoNov 2, 2019
  3. Pratyush YadavNov 2, 2019
  4. Junio C HamanoNov 4, 2019
  5. git-shortlog.txt: include commit limiting optionsPratyush Yadav, Nov 4, 2019
  6. Junio C HamanoNov 6, 2019
  7. git-shortlog.txt: include commit limiting optionsPratyush Yadav, Nov 8, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.