diff options
| author |  Stephan Beyer <s-beyer@gmx.net> | 2008-06-08 03:36:09 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2008-06-08 13:46:38 -0700 |
| commit | 3240240ff427fa2e26a847c7c9fd89e6a4313daa (patch) | |
| tree | a1e21579aca42b7e4d8d718050bc522961530cfa /Documentation/git-config.txt | |
| parent | git-commit.txt: Add missing long/short options (diff) | |
| download | tgif-3240240ff427fa2e26a847c7c9fd89e6a4313daa.tar.xz | |
Docs: Use "-l::\n--long\n" format in OPTIONS sections
The OPTIONS section of a documentation file contains a list
of the options a git command accepts.
Currently there are several variants to describe the case that
different options (almost) do the same in the OPTIONS section.
Some are:
-f, --foo::
-f|--foo::
-f | --foo::
But AsciiDoc has the special form:
-f::
--foo::
This patch applies this form to the documentation of the whole git suite,
and removes useless em-dash prevention, so \--foo becomes --foo.
Signed-off-by: Stephan Beyer <s-beyer@gmx.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-config.txt')
| -rw-r--r-- | Documentation/git-config.txt | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index 84b754f8d0..c90421ee7f 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -101,7 +101,8 @@ rather than from all available files. + See also <<FILES>>. --f config-file, --file config-file:: +-f config-file:: +--file config-file:: Use the given config file instead of the one specified by GIT_CONFIG. --remove-section:: @@ -116,7 +117,8 @@ See also <<FILES>>. --unset-all:: Remove all lines matching the key from config file. --l, --list:: +-l:: +--list:: List all variables set in config file. --bool:: @@ -128,7 +130,8 @@ See also <<FILES>>. in the config file will cause the value to be multiplied by 1024, 1048576, or 1073741824 prior to output. --z, --null:: +-z:: +--null:: For all options that output values and/or keys, always end values with the null character (instead of a newline). Use newline instead as a delimiter between |