[PATCH] git-rev-list.txt: prune options in synopsis
- From
Denton Liu <liu.denton@gmail.com>
- Date
- Oct 5, 2019, 00:13 UTC
- Message-ID
- <645cc54c4c86493c855ec6b0b892a0bc8e999249.1570234118.git.liu.denton@gmail.com>
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> --- I initially wrote a patch to document --children in the synopsis alongside --parents. However, I quickly realised that --children was only one of many missing options. Other options included:
--since --after --until --before --show-notes --all-match --invert-grep --basic-regexp --perl-regexp --exclude --reflog --alternate-refs --single-worktree --boundary --progress --simplify-by-decoration ... stopped checking here
so I decided it wasn't worth it to keep this list around if it's so incomplete when even the porcelain git-log.txt doesn't carry a huge list in the synopsis.
I went through and manually checked each option to ensure that there was a corresponding option in either rev-list-options.txt or pretty-options.txt so we shouldn't lose any information by deleting this list.
Documentation/git-rev-list.txt | 54 +--------------------------------- 1 file changed, 1 insertion(+), 53 deletions(-)
diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt index 9392760b25..025c911436 100644 --- a/Documentation/git-rev-list.txt +++ b/Documentation/git-rev-list.txt @@ -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 -----------
-- 2.23.0.687.g391267506c