Merge branch 'cr/reset-parseopt'

[git.git] / Documentation / git-rm.txt

diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt
index 78f45dca2e37415cbeafb02db559edc6ca511d51..dc36c662ae0d60b7dc706fce67a7c81849caace6 100644 (file)
--- a/Documentation/git-rm.txt
+++ b/Documentation/git-rm.txt
@@ -14,7 +14,8 @@ DESCRIPTION
 Remove files from the working tree and from the index.  The
 files have to be identical to the tip of the branch, and no
 updates to its contents must have been placed in the staging
-area (aka index).
+area (aka index).  When --cached is given, the staged content has to
+match either the tip of the branch *or* the file on disk.
 
 
 OPTIONS
@@ -29,7 +30,7 @@ OPTIONS
 -f::
        Override the up-to-date check.
 
--n::
+-n, \--dry-run::
         Don't actually remove the file(s), just show if they exist in
         the index.
 
@@ -50,7 +51,7 @@ OPTIONS
 \--ignore-unmatch::
        Exit with a zero status even if no files matched.
 
-\--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.
 
@@ -82,7 +83,7 @@ git-rm -f git-*.sh::
 
 See Also
 --------
-gitlink:git-add[1]
+linkgit:git-add[1]
 
 Author
 ------
@@ -94,4 +95,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[7] suite