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

git-rev-list.txt: prune options in synopsis

Browse Source 
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>
This commit is contained in:
Denton Liu 2019-10-04 17:13:08 -07:00 committed by Junio C Hamano
parent 5fa0f5238b
commit 11a3d3aadd
1 changed files with 1 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
Documentation/git-rev-list.txt
View File

@ -9,59 +9,7 @@ git-rev-list - Lists commit objects in reverse chronological order
SYNOPSIS
--------
[verse]
'git rev-list' [ --max-count=<number> ]
[ --skip=<number> ]
[ --max-age=<timestamp> ]
[ --min-age=<timestamp> ]
[ --sparse ]
[ --merges ]
[ --no-merges ]
[ --min-parents=<number> ]
[ --no-min-parents ]
[ --max-parents=<number> ]
[ --no-max-parents ]
[ --first-parent ]
[ --remove-empty ]
[ --full-history ]
[ --not ]
[ --all ]
[ --branches[=<pattern>] ]
[ --tags[=<pattern>] ]
[ --remotes[=<pattern>] ]
[ --glob=<glob-pattern> ]
[ --ignore-missing ]
[ --stdin ]
[ --quiet ]
[ --topo-order ]
[ --parents ]
[ --timestamp ]
[ --left-right ]
[ --left-only ]
[ --right-only ]
[ --cherry-mark ]
[ --cherry-pick ]
[ --encoding=<encoding> ]
[ --(author|committer|grep)=<pattern> ]
[ --regexp-ignore-case | -i ]
[ --extended-regexp | -E ]
[ --fixed-strings | -F ]
[ --date=<format>]
[ [ --objects | --objects-edge | --objects-edge-aggressive ]
[ --unpacked ]
[ --object-names | --no-object-names ]
[ --filter=<filter-spec> [ --filter-print-omitted ] ] ]
[ --missing=<missing-action> ]
[ --pretty | --header ]
[ --bisect ]
[ --bisect-vars ]
[ --bisect-all ]
[ --merge ]
[ --reverse ]
[ --walk-reflogs ]
[ --no-walk ] [ --do-walk ]
[ --count ]
[ --use-bitmap-index ]
<commit>... [ \-- <paths>... ]
'git rev-list' [<options>] <commit>... [[--] <path>...]
DESCRIPTION
-----------