git-rev-list.txt: prune options in synopsis
The synopsis section in git-rev-list.txt has grown to be a huge list that probably needs its own synopsis. Since the list is huge, users may be given the false impression that the list is complete, however it is not. It is missing many of the available options. Since the list of options in the synopsis is not only annoying but actively harmful, replace it with `[<options>]` so users know to explicitly look through the documentation for further information. While we're at it, update the optional path notation so that it is more modern. Signed-off-by: Denton Liu <liu.denton@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Denton Liu committed
Oct 4, 2019 at 17:13 UTC
11a3d3aadd3ec1747a4cb216b2676aeb07c0d64b
1 file changed
+1
-53
Documentation/git-rev-list.txt
+1
-53
@@ -9,59 +9,7 @@ git-rev-list - Lists commit objects in reverse chronological order
9
SYNOPSIS
10
--------
11
[verse]
12
-'git rev-list' [ --max-count=<number> ]
13
- [ --skip=<number> ]
14
- [ --max-age=<timestamp> ]
15
- [ --min-age=<timestamp> ]
16
- [ --sparse ]
17
- [ --merges ]
18
- [ --no-merges ]
19
- [ --min-parents=<number> ]
20
- [ --no-min-parents ]
21
- [ --max-parents=<number> ]
22
- [ --no-max-parents ]
23
- [ --first-parent ]
24
- [ --remove-empty ]
25
- [ --full-history ]
26
- [ --not ]
27
- [ --all ]
28
- [ --branches[=<pattern>] ]
29
- [ --tags[=<pattern>] ]
30
- [ --remotes[=<pattern>] ]
31
- [ --glob=<glob-pattern> ]
32
- [ --ignore-missing ]
33
- [ --stdin ]
34
- [ --quiet ]
35
- [ --topo-order ]
36
- [ --parents ]
37
- [ --timestamp ]
38
- [ --left-right ]
39
- [ --left-only ]
40
- [ --right-only ]
41
- [ --cherry-mark ]
42
- [ --cherry-pick ]
43
- [ --encoding=<encoding> ]
44
- [ --(author|committer|grep)=<pattern> ]
45
- [ --regexp-ignore-case | -i ]
46
- [ --extended-regexp | -E ]
47
- [ --fixed-strings | -F ]
48
- [ --date=<format>]
49
- [ [ --objects | --objects-edge | --objects-edge-aggressive ]
50
- [ --unpacked ]
51
- [ --object-names | --no-object-names ]
52
- [ --filter=<filter-spec> [ --filter-print-omitted ] ] ]
53
- [ --missing=<missing-action> ]
54
- [ --pretty | --header ]
55
- [ --bisect ]
56
- [ --bisect-vars ]
57
- [ --bisect-all ]
58
- [ --merge ]
59
- [ --reverse ]
60
- [ --walk-reflogs ]
61
- [ --no-walk ] [ --do-walk ]
62
- [ --count ]
63
- [ --use-bitmap-index ]
64
- <commit>... [ \-- <paths>... ]
12
+'git rev-list' [<options>] <commit>... [[--] <path>...]
13
14
DESCRIPTION
15
-----------