path: root/Documentation/git-rm.txt
diff options
authorStephan Beyer <>2008-06-08 01:36:09 (GMT)
committerJunio C Hamano <>2008-06-08 20:46:38 (GMT)
commit3240240ff427fa2e26a847c7c9fd89e6a4313daa (patch)
treea1e21579aca42b7e4d8d718050bc522961530cfa /Documentation/git-rm.txt
parentbc47c29ec18164ba1f05600333457cf6f2432856 (diff)
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 <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-rm.txt')
1 files changed, 6 insertions, 4 deletions
diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt
index da3fe59..d88554b 100644
--- a/Documentation/git-rm.txt
+++ b/Documentation/git-rm.txt
@@ -38,7 +38,8 @@ OPTIONS
Override the up-to-date check.
--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).
Use this option to unstage and remove paths only from the index.
Working tree files, whether modified or not, will be
left alone.
Exit with a zero status even if no files matched.
--q, \--quiet::
git-rm normally outputs one line (in the form of an "rm" command)
for each file removed. This option suppresses that output.