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-rm.txt | |
parent | bc47c29ec18164ba1f05600333457cf6f2432856 (diff) | |
download | git-3240240ff427fa2e26a847c7c9fd89e6a4313daa.tar.gz |
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-rm.txt')
-rw-r--r-- | Documentation/git-rm.txt | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt index da3fe59135..d88554bedc 100644 --- a/Documentation/git-rm.txt +++ b/Documentation/git-rm.txt @@ -38,7 +38,8 @@ OPTIONS -f:: Override the up-to-date check. --n, \--dry-run:: +-n:: +--dry-run:: Don't actually remove any file(s). Instead, just show if they exist in the index and would otherwise be removed by the command. @@ -52,15 +53,16 @@ OPTIONS the list of files, (useful when filenames might be mistaken for command-line options). -\--cached:: +--cached:: Use this option to unstage and remove paths only from the index. Working tree files, whether modified or not, will be left alone. -\--ignore-unmatch:: +--ignore-unmatch:: Exit with a zero status even if no files matched. --q, \--quiet:: +-q:: +--quiet:: git-rm normally outputs one line (in the form of an "rm" command) for each file removed. This option suppresses that output. |