git-shortlog.txt: include commit limiting options
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>
Pratyush Yadav committed
Nov 9, 2019 at 00:56 UTC
461caf3e8a6187f4d6de2cf6838dcd56a1b0ebf7
2 files changed
+13
-1
Documentation/git-shortlog.txt
+3
@@ -76,6 +76,9 @@ them.
76
Paths may need to be prefixed with `--` to separate them from
77
options or the revision range, when confusion arises.
78
79
+:git-shortlog: 1
80
+include::rev-list-options.txt[]
81
+
82
MAPPING AUTHORS
83
---------------
84
Documentation/rev-list-options.txt
+10
-1
@@ -579,6 +579,7 @@ above) if (1) they are referenced by tags, or (2) they change the
579
contents of the paths given on the command line. All other
580
commits are marked as TREESAME (subject to be simplified away).
581
582
+ifndef::git-shortlog[]
583
ifdef::git-rev-list[]
584
Bisection Helpers
585
~~~~~~~~~~~~~~~~~
@@ -634,8 +635,9 @@ This option can be used along with `--bisect-vars`, in this case,
635
after all the sorted commit objects, there will be the same text as if
636
`--bisect-vars` had been used alone.
637
endif::git-rev-list[]
638
+endif::git-shortlog[]
639
638
-
640
+ifndef::git-shortlog[]
641
Commit Ordering
642
~~~~~~~~~~~~~~~
643
@@ -677,7 +679,9 @@ together.
679
Output the commits chosen to be shown (see Commit Limiting
680
section above) in reverse order. Cannot be combined with
681
`--walk-reflogs`.
682
+endif::git-shortlog[]
683
684
+ifndef::git-shortlog[]
685
Object Traversal
686
~~~~~~~~~~~~~~~~
687
@@ -801,7 +805,9 @@ endif::git-rev-list[]
805
806
--do-walk::
807
Overrides a previous `--no-walk`.
808
+endif::git-shortlog[]
809
810
+ifndef::git-shortlog[]
811
Commit Formatting
812
~~~~~~~~~~~~~~~~~
813
@@ -957,7 +963,9 @@ ifdef::git-rev-list[]
963
counts and print the count for equivalent commits separated
964
by a tab.
965
endif::git-rev-list[]
966
+endif::git-shortlog[]
967
968
+ifndef::git-shortlog[]
969
ifndef::git-rev-list[]
970
Diff Formatting
971
~~~~~~~~~~~~~~~
@@ -1000,3 +1008,4 @@ options may be given. See linkgit:git-diff-files[1] for more options.
1008
-t::
1009
Show the tree objects in the diff output. This implies `-r`.
1010
endif::git-rev-list[]
1011
+endif::git-shortlog[]