undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

git-shortlog.txt: include commit limiting options

Browse Source 
git-shortlog, like git-log, supports options to filter what commits are
used to generate the log. These options come from git-rev-list, and are
documented in Documentation/rev-list-options.txt. Include those options
in shortlog's documentation.

But since rev-list-options.txt contains some other options that don't
really apply in the context of shortlog (like diff formatting, commit
ordering, etc), add a switch in rev-list-options.txt that excludes those
sections from the shortlog documentation. To be more specific, include
only the "Commit Limiting" and "History Simplification" sections.

Signed-off-by: Pratyush Yadav <me@yadavpratyush.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Pratyush Yadav 2019-11-09 00:56:27 +05:30 committed by Junio C Hamano
parent 5fa0f5238b
commit 461caf3e8a
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/git-shortlog.txt
View File

@ -76,6 +76,9 @@ them.
Paths may need to be prefixed with `--` to separate them from Paths may need to be prefixed with `--` to separate them from
options or the revision range, when confusion arises. options or the revision range, when confusion arises.
:git-shortlog: 1
include::rev-list-options.txt[]
MAPPING AUTHORS MAPPING AUTHORS
--------------- ---------------

11
Documentation/rev-list-options.txt
View File

@ -579,6 +579,7 @@ above) if (1) they are referenced by tags, or (2) they change the
contents of the paths given on the command line. All other contents of the paths given on the command line. All other
commits are marked as TREESAME (subject to be simplified away). commits are marked as TREESAME (subject to be simplified away).
ifndef::git-shortlog[]
ifdef::git-rev-list[] ifdef::git-rev-list[]
Bisection Helpers Bisection Helpers
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
@ -634,8 +635,9 @@ This option can be used along with `--bisect-vars`, in this case,
after all the sorted commit objects, there will be the same text as if after all the sorted commit objects, there will be the same text as if
`--bisect-vars` had been used alone. `--bisect-vars` had been used alone.
endif::git-rev-list[] endif::git-rev-list[]
endif::git-shortlog[]
ifndef::git-shortlog[]
Commit Ordering Commit Ordering
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
@ -677,7 +679,9 @@ together.
Output the commits chosen to be shown (see Commit Limiting Output the commits chosen to be shown (see Commit Limiting
section above) in reverse order. Cannot be combined with section above) in reverse order. Cannot be combined with
`--walk-reflogs`. `--walk-reflogs`.
endif::git-shortlog[]
ifndef::git-shortlog[]
Object Traversal Object Traversal
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
@ -801,7 +805,9 @@ endif::git-rev-list[]
--do-walk:: --do-walk::
Overrides a previous `--no-walk`. Overrides a previous `--no-walk`.
endif::git-shortlog[]
ifndef::git-shortlog[]
Commit Formatting Commit Formatting
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
@ -957,7 +963,9 @@ ifdef::git-rev-list[]
counts and print the count for equivalent commits separated counts and print the count for equivalent commits separated
by a tab. by a tab.
endif::git-rev-list[] endif::git-rev-list[]
endif::git-shortlog[]
ifndef::git-shortlog[]
ifndef::git-rev-list[] ifndef::git-rev-list[]
Diff Formatting Diff Formatting
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
@ -1000,3 +1008,4 @@ options may be given. See linkgit:git-diff-files[1] for more options.
-t:: -t::
Show the tree objects in the diff output. This implies `-r`. Show the tree objects in the diff output. This implies `-r`.
endif::git-rev-list[] endif::git-rev-list[]
endif::git-shortlog[]