doc txt & -h consistency: add missing options

Change those built-in commands that were attempting to exhaustively
list the options in the "-h" output to actually do so, and always
have *.txt documentation know about the exhaustive list of options.

Let's also fix the documentation and -h output for those built-in
commands where the *.txt and -h output was a mismatch of missing
options on both sides.

In the case of "interpret-trailers" fixing the missing options reveals
that the *.txt version was implicitly claiming that the command had
two operating modes, which a look at the -h version (and studying the
documentation) will show is not the case.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Ævar Arnfjörð Bjarmason 2022-10-13 17:39:18 +02:00 committed by Junio C Hamano
parent 3e4ebe3a40
commit d9054a19ed
8 changed files with 20 additions and 8 deletions

View File

@ -10,7 +10,10 @@ SYNOPSIS
-------- --------
[verse] [verse]
'git commit-graph verify' [--object-dir <dir>] [--shallow] [--[no-]progress] 'git commit-graph verify' [--object-dir <dir>] [--shallow] [--[no-]progress]
'git commit-graph write' <options> [--object-dir <dir>] [--[no-]progress] 'git commit-graph write' [--object-dir <dir>] [--append]
[--split[=<strategy>]] [--reachable | --stdin-packs | --stdin-commits]
[--changed-paths] [--[no-]max-new-filters <n>] [--[no-]progress]
<split options>
DESCRIPTION DESCRIPTION

View File

@ -8,8 +8,9 @@ git-interpret-trailers - Add or parse structured information in commit messages
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git interpret-trailers' [<options>] [(--trailer <token>[(=|:)<value>])...] [<file>...] 'git interpret-trailers' [--in-place] [--trim-empty]
'git interpret-trailers' [<options>] [--parse] [<file>...] [(--trailer <token>[(=|:)<value>])...]
[--parse] [<file>...]
DESCRIPTION DESCRIPTION
----------- -----------

View File

@ -15,6 +15,7 @@
#include "parse-options.h" #include "parse-options.h"
static const char * const commit_tree_usage[] = { static const char * const commit_tree_usage[] = {
N_("git commit-tree <tree> [(-p <parent>)...]"),
N_("git commit-tree [(-p <parent>)...] [-S[<keyid>]] [(-m <message>)...]\n" N_("git commit-tree [(-p <parent>)...] [-S[<keyid>]] [(-m <message>)...]\n"
" [(-F <file>)...] <tree>"), " [(-F <file>)...] <tree>"),
NULL NULL

View File

@ -819,7 +819,10 @@ static int mark_packed_for_connectivity(const struct object_id *oid,
} }
static char const * const fsck_usage[] = { static char const * const fsck_usage[] = {
N_("git fsck [<options>] [<object>...]"), N_("git fsck [--tags] [--root] [--unreachable] [--cache] [--no-reflogs]\n"
" [--[no-]full] [--strict] [--verbose] [--lost-found]\n"
" [--[no-]dangling] [--[no-]progress] [--connectivity-only]\n"
" [--[no-]name-objects] [<object>...]"),
NULL NULL
}; };

View File

@ -81,8 +81,8 @@ int cmd_hash_object(int argc, const char **argv, const char *prefix)
{ {
static const char * const hash_object_usage[] = { static const char * const hash_object_usage[] = {
N_("git hash-object [-t <type>] [-w] [--path=<file> | --no-filters]\n" N_("git hash-object [-t <type>] [-w] [--path=<file> | --no-filters]\n"
" [--stdin] [--] <file>..."), " [--stdin [--literally]] [--] <file>..."),
"git hash-object --stdin-paths", N_("git hash-object [-t <type>] [-w] --stdin-paths [--no-filters]"),
NULL NULL
}; };
const char *type = blob_type; const char *type = blob_type;

View File

@ -516,6 +516,8 @@ static int shared_callback(const struct option *opt, const char *arg, int unset)
static const char *const init_db_usage[] = { static const char *const init_db_usage[] = {
N_("git init [-q | --quiet] [--bare] [--template=<template-directory>]\n" N_("git init [-q | --quiet] [--bare] [--template=<template-directory>]\n"
" [--separate-git-dir <git-dir>] [--object-format=<format>]\n"
" [-b <branch-name> | --initial-branch=<branch-name>]\n"
" [--shared[=<permissions>]] [<directory>]"), " [--shared[=<permissions>]] [<directory>]"),
NULL NULL
}; };

View File

@ -15,7 +15,7 @@
static const char * const git_interpret_trailers_usage[] = { static const char * const git_interpret_trailers_usage[] = {
N_("git interpret-trailers [--in-place] [--trim-empty]\n" N_("git interpret-trailers [--in-place] [--trim-empty]\n"
" [(--trailer <token>[(=|:)<value>])...]\n" " [(--trailer <token>[(=|:)<value>])...]\n"
" [<file>...]"), " [--parse] [<file>...]"),
NULL NULL
}; };

View File

@ -17,7 +17,9 @@
#include "pathspec.h" #include "pathspec.h"
static const char * const builtin_rm_usage[] = { static const char * const builtin_rm_usage[] = {
N_("git rm [<options>] [--] <file>..."), N_("git rm [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch]\n"
" [--quiet] [--pathspec-from-file=<file> [--pathspec-file-nul]]\n"
" [--] [<pathspec>...]"),
NULL NULL
}; };