Merge branch 'maint-1.5.4' into maint
[gitweb.git] / Documentation / git-rm.txt
index 3a8f279e1a5b699f23f908540f828a87a3a4d779..dc36c662ae0d60b7dc706fce67a7c81849caace6 100644 (file)
@@ -7,14 +7,15 @@ git-rm - Remove files from the working tree and from the index
 
 SYNOPSIS
 --------
-'git-rm' [-f] [-n] [-r] [--cached] [--] <file>...
+'git-rm' [-f] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] <file>...
 
 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.
 
@@ -47,6 +48,13 @@ OPTIONS
        the paths only from the index, leaving working tree
        files.
 
+\--ignore-unmatch::
+       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.
+
 
 DISCUSSION
 ----------
@@ -60,26 +68,22 @@ a file that you have not told git about does not remove that file.
 EXAMPLES
 --------
 git-rm Documentation/\\*.txt::
-
        Removes all `\*.txt` files from the index that are under the
-       `Documentation` directory and any of its subdirectories. The
-       files are not removed from the working tree.
+       `Documentation` directory and any of its subdirectories.
 +
 Note that the asterisk `\*` is quoted from the shell in this
 example; this lets the command include the files from
 subdirectories of `Documentation/` directory.
 
 git-rm -f git-*.sh::
-
-       Remove all git-*.sh scripts that are in the index. The files
-       are removed from the index, and from the working
-       tree. Because this example lets the shell expand the
-       asterisk (i.e. you are listing the files explicitly), it
+       Remove all git-*.sh scripts that are in the index.
+       Because this example lets the shell expand the asterisk
+       (i.e. you are listing the files explicitly), it
        does not remove `subdir/git-foo.sh`.
 
 See Also
 --------
-gitlink:git-add[1]
+linkgit:git-add[1]
 
 Author
 ------
@@ -91,5 +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