On 02/11/19 02:43PM, Junio C Hamano wrote: > Pratyush Yadav <me@xxxxxxxxxxxxxxxxx> 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@xxxxxxxxxxxxxxxxx> > > --- > > 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@xxxxxxxxxxxxxxxxx/ > > > > 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@xxxxxxxxxxxxxxxxx/ -- Regards, Pratyush Yadav
