Merge branch 'mg/placeholders-are-lowercase' into maint
* mg/placeholders-are-lowercase: Make <identifier> lowercase in Documentation Make <identifier> lowercase as per CodingGuidelines Make <identifier> lowercase as per CodingGuidelines Make <identifier> lowercase as per CodingGuidelines CodingGuidelines: downcase placeholders in usage messages
This commit is contained in:
commit
7633a5ab9a
@ -152,7 +152,7 @@ Writing Documentation:
|
|||||||
when writing or modifying command usage strings and synopsis sections
|
when writing or modifying command usage strings and synopsis sections
|
||||||
in the manual pages:
|
in the manual pages:
|
||||||
|
|
||||||
Placeholders are enclosed in angle brackets:
|
Placeholders are spelled in lowercase and enclosed in angle brackets:
|
||||||
<file>
|
<file>
|
||||||
--sort=<key>
|
--sort=<key>
|
||||||
--abbrev[=<n>]
|
--abbrev[=<n>]
|
||||||
|
@ -7,17 +7,17 @@ git-remote-ext - Bridge smart transport to external command.
|
|||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
git remote add nick "ext::<command>[ <arguments>...]"
|
git remote add <nick> "ext::<command>[ <arguments>...]"
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
This remote helper uses the specified 'program' to connect
|
This remote helper uses the specified '<command>' to connect
|
||||||
to a remote git server.
|
to a remote git server.
|
||||||
|
|
||||||
Data written to stdin of this specified 'program' is assumed
|
Data written to stdin of the specified '<command>' is assumed
|
||||||
to be sent to a git:// server, git-upload-pack, git-receive-pack
|
to be sent to a git:// server, git-upload-pack, git-receive-pack
|
||||||
or git-upload-archive (depending on situation), and data read
|
or git-upload-archive (depending on situation), and data read
|
||||||
from stdout of this program is assumed to be received from
|
from stdout of <command> is assumed to be received from
|
||||||
the same service.
|
the same service.
|
||||||
|
|
||||||
Command and arguments are separated by an unescaped space.
|
Command and arguments are separated by an unescaped space.
|
||||||
@ -40,7 +40,7 @@ The following sequences have a special meaning:
|
|||||||
git wants to invoke.
|
git wants to invoke.
|
||||||
|
|
||||||
'%G' (must be the first characters in an argument)::
|
'%G' (must be the first characters in an argument)::
|
||||||
This argument will not be passed to 'program'. Instead, it
|
This argument will not be passed to '<command>'. Instead, it
|
||||||
will cause the helper to start by sending git:// service requests to
|
will cause the helper to start by sending git:// service requests to
|
||||||
the remote side with the service field set to an appropriate value and
|
the remote side with the service field set to an appropriate value and
|
||||||
the repository field set to rest of the argument. Default is not to send
|
the repository field set to rest of the argument. Default is not to send
|
||||||
@ -50,7 +50,7 @@ This is useful if remote side is git:// server accessed over
|
|||||||
some tunnel.
|
some tunnel.
|
||||||
|
|
||||||
'%V' (must be first characters in argument)::
|
'%V' (must be first characters in argument)::
|
||||||
This argument will not be passed to 'program'. Instead it sets
|
This argument will not be passed to '<command>'. Instead it sets
|
||||||
the vhost field in the git:// service request (to rest of the argument).
|
the vhost field in the git:// service request (to rest of the argument).
|
||||||
Default is not to send vhost in such request (if sent).
|
Default is not to send vhost in such request (if sent).
|
||||||
|
|
||||||
@ -76,7 +76,7 @@ EXAMPLES:
|
|||||||
---------
|
---------
|
||||||
This remote helper is transparently used by git when
|
This remote helper is transparently used by git when
|
||||||
you use commands such as "git fetch <URL>", "git clone <URL>",
|
you use commands such as "git fetch <URL>", "git clone <URL>",
|
||||||
, "git push <URL>" or "git remote add nick <URL>", where <URL>
|
, "git push <URL>" or "git remote add <nick> <URL>", where <URL>
|
||||||
begins with `ext::`. Examples:
|
begins with `ext::`. Examples:
|
||||||
|
|
||||||
"ext::ssh -i /home/foo/.ssh/somekey user@host.example %S 'foo/repo'"::
|
"ext::ssh -i /home/foo/.ssh/somekey user@host.example %S 'foo/repo'"::
|
||||||
|
@ -201,12 +201,12 @@ REF LIST ATTRIBUTES
|
|||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
'option verbosity' <N>::
|
'option verbosity' <n>::
|
||||||
Changes the verbosity of messages displayed by the helper.
|
Changes the verbosity of messages displayed by the helper.
|
||||||
A value of 0 for N means that processes operate
|
A value of 0 for <n> means that processes operate
|
||||||
quietly, and the helper produces only error output.
|
quietly, and the helper produces only error output.
|
||||||
1 is the default level of verbosity, and higher values
|
1 is the default level of verbosity, and higher values
|
||||||
of N correspond to the number of -v flags passed on the
|
of <n> correspond to the number of -v flags passed on the
|
||||||
command line.
|
command line.
|
||||||
|
|
||||||
'option progress' \{'true'|'false'\}::
|
'option progress' \{'true'|'false'\}::
|
||||||
|
@ -66,7 +66,7 @@ COMMANDS
|
|||||||
Set the 'rewriteRoot' option in the [svn-remote] config.
|
Set the 'rewriteRoot' option in the [svn-remote] config.
|
||||||
--rewrite-uuid=<UUID>;;
|
--rewrite-uuid=<UUID>;;
|
||||||
Set the 'rewriteUUID' option in the [svn-remote] config.
|
Set the 'rewriteUUID' option in the [svn-remote] config.
|
||||||
--username=<USER>;;
|
--username=<user>;;
|
||||||
For transports that SVN handles authentication for (http,
|
For transports that SVN handles authentication for (http,
|
||||||
https, and plain svn), specify the username. For other
|
https, and plain svn), specify the username. For other
|
||||||
transports (eg svn+ssh://), you must include the username in
|
transports (eg svn+ssh://), you must include the username in
|
||||||
@ -443,8 +443,8 @@ OPTIONS
|
|||||||
Only used with the 'init' command.
|
Only used with the 'init' command.
|
||||||
These are passed directly to 'git init'.
|
These are passed directly to 'git init'.
|
||||||
|
|
||||||
-r <ARG>::
|
-r <arg>::
|
||||||
--revision <ARG>::
|
--revision <arg>::
|
||||||
Used with the 'fetch' command.
|
Used with the 'fetch' command.
|
||||||
+
|
+
|
||||||
This allows revision ranges for partial/cauterized history
|
This allows revision ranges for partial/cauterized history
|
||||||
|
@ -119,13 +119,13 @@ static struct option builtin_commit_options[] = {
|
|||||||
|
|
||||||
OPT_GROUP("Commit message options"),
|
OPT_GROUP("Commit message options"),
|
||||||
OPT_FILENAME('F', "file", &logfile, "read message from file"),
|
OPT_FILENAME('F', "file", &logfile, "read message from file"),
|
||||||
OPT_STRING(0, "author", &force_author, "AUTHOR", "override author for commit"),
|
OPT_STRING(0, "author", &force_author, "author", "override author for commit"),
|
||||||
OPT_STRING(0, "date", &force_date, "DATE", "override date for commit"),
|
OPT_STRING(0, "date", &force_date, "date", "override date for commit"),
|
||||||
OPT_CALLBACK('m', "message", &message, "MESSAGE", "commit message", opt_parse_m),
|
OPT_CALLBACK('m', "message", &message, "message", "commit message", opt_parse_m),
|
||||||
OPT_STRING('c', "reedit-message", &edit_message, "COMMIT", "reuse and edit message from specified commit"),
|
OPT_STRING('c', "reedit-message", &edit_message, "commit", "reuse and edit message from specified commit"),
|
||||||
OPT_STRING('C', "reuse-message", &use_message, "COMMIT", "reuse message from specified commit"),
|
OPT_STRING('C', "reuse-message", &use_message, "commit", "reuse message from specified commit"),
|
||||||
OPT_STRING(0, "fixup", &fixup_message, "COMMIT", "use autosquash formatted message to fixup specified commit"),
|
OPT_STRING(0, "fixup", &fixup_message, "commit", "use autosquash formatted message to fixup specified commit"),
|
||||||
OPT_STRING(0, "squash", &squash_message, "COMMIT", "use autosquash formatted message to squash specified commit"),
|
OPT_STRING(0, "squash", &squash_message, "commit", "use autosquash formatted message to squash specified commit"),
|
||||||
OPT_BOOLEAN(0, "reset-author", &renew_authorship, "the commit is authored by me now (used with -C-c/--amend)"),
|
OPT_BOOLEAN(0, "reset-author", &renew_authorship, "the commit is authored by me now (used with -C-c/--amend)"),
|
||||||
OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
|
OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
|
||||||
OPT_FILENAME('t', "template", &template_file, "use specified template file"),
|
OPT_FILENAME('t', "template", &template_file, "use specified template file"),
|
||||||
|
@ -52,7 +52,7 @@ static struct option builtin_config_options[] = {
|
|||||||
OPT_BOOLEAN(0, "global", &use_global_config, "use global config file"),
|
OPT_BOOLEAN(0, "global", &use_global_config, "use global config file"),
|
||||||
OPT_BOOLEAN(0, "system", &use_system_config, "use system config file"),
|
OPT_BOOLEAN(0, "system", &use_system_config, "use system config file"),
|
||||||
OPT_BOOLEAN(0, "local", &use_local_config, "use repository config file"),
|
OPT_BOOLEAN(0, "local", &use_local_config, "use repository config file"),
|
||||||
OPT_STRING('f', "file", &given_config_file, "FILE", "use given config file"),
|
OPT_STRING('f', "file", &given_config_file, "file", "use given config file"),
|
||||||
OPT_GROUP("Action"),
|
OPT_GROUP("Action"),
|
||||||
OPT_BIT(0, "get", &actions, "get value: name [value-regex]", ACTION_GET),
|
OPT_BIT(0, "get", &actions, "get value: name [value-regex]", ACTION_GET),
|
||||||
OPT_BIT(0, "get-all", &actions, "get all values: key [value-regex]", ACTION_GET_ALL),
|
OPT_BIT(0, "get-all", &actions, "get all values: key [value-regex]", ACTION_GET_ALL),
|
||||||
|
@ -619,9 +619,9 @@ int cmd_fast_export(int argc, const char **argv, const char *prefix)
|
|||||||
OPT_CALLBACK(0, "tag-of-filtered-object", &tag_of_filtered_mode, "mode",
|
OPT_CALLBACK(0, "tag-of-filtered-object", &tag_of_filtered_mode, "mode",
|
||||||
"select handling of tags that tag filtered objects",
|
"select handling of tags that tag filtered objects",
|
||||||
parse_opt_tag_of_filtered_mode),
|
parse_opt_tag_of_filtered_mode),
|
||||||
OPT_STRING(0, "export-marks", &export_filename, "FILE",
|
OPT_STRING(0, "export-marks", &export_filename, "file",
|
||||||
"Dump marks to this file"),
|
"Dump marks to this file"),
|
||||||
OPT_STRING(0, "import-marks", &import_filename, "FILE",
|
OPT_STRING(0, "import-marks", &import_filename, "file",
|
||||||
"Import marks from this file"),
|
"Import marks from this file"),
|
||||||
OPT_BOOLEAN(0, "fake-missing-tagger", &fake_missing_tagger,
|
OPT_BOOLEAN(0, "fake-missing-tagger", &fake_missing_tagger,
|
||||||
"Fake a tagger when tags lack one"),
|
"Fake a tagger when tags lack one"),
|
||||||
|
@ -49,7 +49,7 @@ static struct option builtin_fetch_options[] = {
|
|||||||
"fetch from all remotes"),
|
"fetch from all remotes"),
|
||||||
OPT_BOOLEAN('a', "append", &append,
|
OPT_BOOLEAN('a', "append", &append,
|
||||||
"append to .git/FETCH_HEAD instead of overwriting"),
|
"append to .git/FETCH_HEAD instead of overwriting"),
|
||||||
OPT_STRING(0, "upload-pack", &upload_pack, "PATH",
|
OPT_STRING(0, "upload-pack", &upload_pack, "path",
|
||||||
"path to upload pack on remote end"),
|
"path to upload pack on remote end"),
|
||||||
OPT__FORCE(&force, "force overwrite of local branch"),
|
OPT__FORCE(&force, "force overwrite of local branch"),
|
||||||
OPT_BOOLEAN('m', "multiple", &multiple,
|
OPT_BOOLEAN('m', "multiple", &multiple,
|
||||||
@ -69,9 +69,9 @@ static struct option builtin_fetch_options[] = {
|
|||||||
OPT_BOOLEAN('u', "update-head-ok", &update_head_ok,
|
OPT_BOOLEAN('u', "update-head-ok", &update_head_ok,
|
||||||
"allow updating of HEAD ref"),
|
"allow updating of HEAD ref"),
|
||||||
OPT_BOOLEAN(0, "progress", &progress, "force progress reporting"),
|
OPT_BOOLEAN(0, "progress", &progress, "force progress reporting"),
|
||||||
OPT_STRING(0, "depth", &depth, "DEPTH",
|
OPT_STRING(0, "depth", &depth, "depth",
|
||||||
"deepen history of shallow clone"),
|
"deepen history of shallow clone"),
|
||||||
{ OPTION_STRING, 0, "submodule-prefix", &submodule_prefix, "DIR",
|
{ OPTION_STRING, 0, "submodule-prefix", &submodule_prefix, "dir",
|
||||||
"prepend this to submodule path output", PARSE_OPT_HIDDEN },
|
"prepend this to submodule path output", PARSE_OPT_HIDDEN },
|
||||||
OPT_END()
|
OPT_END()
|
||||||
};
|
};
|
||||||
|
@ -194,7 +194,7 @@ static struct option builtin_merge_options[] = {
|
|||||||
"merge strategy to use", option_parse_strategy),
|
"merge strategy to use", option_parse_strategy),
|
||||||
OPT_CALLBACK('X', "strategy-option", &xopts, "option=value",
|
OPT_CALLBACK('X', "strategy-option", &xopts, "option=value",
|
||||||
"option for selected merge strategy", option_parse_x),
|
"option for selected merge strategy", option_parse_x),
|
||||||
OPT_CALLBACK('m', "message", &merge_msg, "MESSAGE",
|
OPT_CALLBACK('m', "message", &merge_msg, "message",
|
||||||
"merge commit message (for a non-fast-forward merge)",
|
"merge commit message (for a non-fast-forward merge)",
|
||||||
option_parse_message),
|
option_parse_message),
|
||||||
OPT__VERBOSITY(&verbosity),
|
OPT__VERBOSITY(&verbosity),
|
||||||
|
@ -537,16 +537,16 @@ static int add(int argc, const char **argv, const char *prefix)
|
|||||||
const unsigned char *note;
|
const unsigned char *note;
|
||||||
struct msg_arg msg = { 0, 0, STRBUF_INIT };
|
struct msg_arg msg = { 0, 0, STRBUF_INIT };
|
||||||
struct option options[] = {
|
struct option options[] = {
|
||||||
{ OPTION_CALLBACK, 'm', "message", &msg, "MSG",
|
{ OPTION_CALLBACK, 'm', "message", &msg, "msg",
|
||||||
"note contents as a string", PARSE_OPT_NONEG,
|
"note contents as a string", PARSE_OPT_NONEG,
|
||||||
parse_msg_arg},
|
parse_msg_arg},
|
||||||
{ OPTION_CALLBACK, 'F', "file", &msg, "FILE",
|
{ OPTION_CALLBACK, 'F', "file", &msg, "file",
|
||||||
"note contents in a file", PARSE_OPT_NONEG,
|
"note contents in a file", PARSE_OPT_NONEG,
|
||||||
parse_file_arg},
|
parse_file_arg},
|
||||||
{ OPTION_CALLBACK, 'c', "reedit-message", &msg, "OBJECT",
|
{ OPTION_CALLBACK, 'c', "reedit-message", &msg, "object",
|
||||||
"reuse and edit specified note object", PARSE_OPT_NONEG,
|
"reuse and edit specified note object", PARSE_OPT_NONEG,
|
||||||
parse_reedit_arg},
|
parse_reedit_arg},
|
||||||
{ OPTION_CALLBACK, 'C', "reuse-message", &msg, "OBJECT",
|
{ OPTION_CALLBACK, 'C', "reuse-message", &msg, "object",
|
||||||
"reuse specified note object", PARSE_OPT_NONEG,
|
"reuse specified note object", PARSE_OPT_NONEG,
|
||||||
parse_reuse_arg},
|
parse_reuse_arg},
|
||||||
OPT__FORCE(&force, "replace existing notes"),
|
OPT__FORCE(&force, "replace existing notes"),
|
||||||
@ -682,16 +682,16 @@ static int append_edit(int argc, const char **argv, const char *prefix)
|
|||||||
const char * const *usage;
|
const char * const *usage;
|
||||||
struct msg_arg msg = { 0, 0, STRBUF_INIT };
|
struct msg_arg msg = { 0, 0, STRBUF_INIT };
|
||||||
struct option options[] = {
|
struct option options[] = {
|
||||||
{ OPTION_CALLBACK, 'm', "message", &msg, "MSG",
|
{ OPTION_CALLBACK, 'm', "message", &msg, "msg",
|
||||||
"note contents as a string", PARSE_OPT_NONEG,
|
"note contents as a string", PARSE_OPT_NONEG,
|
||||||
parse_msg_arg},
|
parse_msg_arg},
|
||||||
{ OPTION_CALLBACK, 'F', "file", &msg, "FILE",
|
{ OPTION_CALLBACK, 'F', "file", &msg, "file",
|
||||||
"note contents in a file", PARSE_OPT_NONEG,
|
"note contents in a file", PARSE_OPT_NONEG,
|
||||||
parse_file_arg},
|
parse_file_arg},
|
||||||
{ OPTION_CALLBACK, 'c', "reedit-message", &msg, "OBJECT",
|
{ OPTION_CALLBACK, 'c', "reedit-message", &msg, "object",
|
||||||
"reuse and edit specified note object", PARSE_OPT_NONEG,
|
"reuse and edit specified note object", PARSE_OPT_NONEG,
|
||||||
parse_reedit_arg},
|
parse_reedit_arg},
|
||||||
{ OPTION_CALLBACK, 'C', "reuse-message", &msg, "OBJECT",
|
{ OPTION_CALLBACK, 'C', "reuse-message", &msg, "object",
|
||||||
"reuse specified note object", PARSE_OPT_NONEG,
|
"reuse specified note object", PARSE_OPT_NONEG,
|
||||||
parse_reuse_arg},
|
parse_reuse_arg},
|
||||||
OPT_END()
|
OPT_END()
|
||||||
|
@ -104,8 +104,8 @@ int cmd_read_tree(int argc, const char **argv, const char *unused_prefix)
|
|||||||
struct unpack_trees_options opts;
|
struct unpack_trees_options opts;
|
||||||
int prefix_set = 0;
|
int prefix_set = 0;
|
||||||
const struct option read_tree_options[] = {
|
const struct option read_tree_options[] = {
|
||||||
{ OPTION_CALLBACK, 0, "index-output", NULL, "FILE",
|
{ OPTION_CALLBACK, 0, "index-output", NULL, "file",
|
||||||
"write resulting index to <FILE>",
|
"write resulting index to <file>",
|
||||||
PARSE_OPT_NONEG, index_output_cb },
|
PARSE_OPT_NONEG, index_output_cb },
|
||||||
OPT_SET_INT(0, "empty", &read_empty,
|
OPT_SET_INT(0, "empty", &read_empty,
|
||||||
"only empty the index", 1),
|
"only empty the index", 1),
|
||||||
|
@ -376,7 +376,7 @@ int cmd_tag(int argc, const char **argv, const char *prefix)
|
|||||||
OPT_GROUP("Tag creation options"),
|
OPT_GROUP("Tag creation options"),
|
||||||
OPT_BOOLEAN('a', NULL, &annotate,
|
OPT_BOOLEAN('a', NULL, &annotate,
|
||||||
"annotated tag, needs a message"),
|
"annotated tag, needs a message"),
|
||||||
OPT_CALLBACK('m', NULL, &msg, "MESSAGE",
|
OPT_CALLBACK('m', NULL, &msg, "message",
|
||||||
"tag message", parse_msg_arg),
|
"tag message", parse_msg_arg),
|
||||||
OPT_FILENAME('F', NULL, &msgfile, "read message from file"),
|
OPT_FILENAME('F', NULL, &msgfile, "read message from file"),
|
||||||
OPT_BOOLEAN('s', NULL, &sign, "annotated and GPG-signed tag"),
|
OPT_BOOLEAN('s', NULL, &sign, "annotated and GPG-signed tag"),
|
||||||
|
@ -141,7 +141,7 @@ struct option {
|
|||||||
{ OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
|
{ OPTION_NUMBER, 0, NULL, (v), NULL, (h), \
|
||||||
PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
|
PARSE_OPT_NOARG | PARSE_OPT_NONEG, (f) }
|
||||||
#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
|
#define OPT_FILENAME(s, l, v, h) { OPTION_FILENAME, (s), (l), (v), \
|
||||||
"FILE", (h) }
|
"file", (h) }
|
||||||
#define OPT_COLOR_FLAG(s, l, v, h) \
|
#define OPT_COLOR_FLAG(s, l, v, h) \
|
||||||
{ OPTION_CALLBACK, (s), (l), (v), "when", (h), PARSE_OPT_OPTARG, \
|
{ OPTION_CALLBACK, (s), (l), (v), "when", (h), PARSE_OPT_OPTARG, \
|
||||||
parse_opt_color_flag_cb, (intptr_t)"always" }
|
parse_opt_color_flag_cb, (intptr_t)"always" }
|
||||||
|
@ -19,7 +19,7 @@ usage: test-parse-options <options>
|
|||||||
--set23 set integer to 23
|
--set23 set integer to 23
|
||||||
-t <time> get timestamp of <time>
|
-t <time> get timestamp of <time>
|
||||||
-L, --length <str> get length of <str>
|
-L, --length <str> get length of <str>
|
||||||
-F, --file <FILE> set file to <FILE>
|
-F, --file <file> set file to <file>
|
||||||
|
|
||||||
String options
|
String options
|
||||||
-s, --string <string>
|
-s, --string <string>
|
||||||
|
@ -46,7 +46,7 @@ int main(int argc, const char **argv)
|
|||||||
OPT_DATE('t', NULL, ×tamp, "get timestamp of <time>"),
|
OPT_DATE('t', NULL, ×tamp, "get timestamp of <time>"),
|
||||||
OPT_CALLBACK('L', "length", &integer, "str",
|
OPT_CALLBACK('L', "length", &integer, "str",
|
||||||
"get length of <str>", length_callback),
|
"get length of <str>", length_callback),
|
||||||
OPT_FILENAME('F', "file", &file, "set file to <FILE>"),
|
OPT_FILENAME('F', "file", &file, "set file to <file>"),
|
||||||
OPT_GROUP("String options"),
|
OPT_GROUP("String options"),
|
||||||
OPT_STRING('s', "string", &string, "string", "get a string"),
|
OPT_STRING('s', "string", &string, "string", "get a string"),
|
||||||
OPT_STRING(0, "string2", &string, "str", "get another string"),
|
OPT_STRING(0, "string2", &string, "str", "get another string"),
|
||||||
|
Loading…
x
Reference in New Issue
Block a user