X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-rm.txt;h=5afb1e7428126c79171cf7e7b1fb027e1de64c86;hb=01d386121758ac72aedd5f268feb763d53fc3cdf;hp=d88554bedcaa9acdf8828e9abe6d5169e32446a3;hpb=5f54de5bd07481f6d88e8dbd5551f3356ecbf513;p=git.git diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt index d88554bed..5afb1e742 100644 --- a/Documentation/git-rm.txt +++ b/Documentation/git-rm.txt @@ -7,12 +7,12 @@ git-rm - Remove files from the working tree and from the index SYNOPSIS -------- -'git-rm' [-f] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] ... +'git rm' [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] ... DESCRIPTION ----------- Remove files from the index, or from the working tree and the index. -`git rm` will not remove a file from just your working directory. +'git-rm' will not remove a file from just your working directory. (There is no option to remove a file only from the work tree and yet keep it in the index; use `/bin/rm` if you want to do that.) The files being removed have to be identical to the tip of the branch, @@ -36,6 +36,7 @@ OPTIONS but this requires the `-r` option to be explicitly given. -f:: +--force:: Override the up-to-date check. -n:: @@ -63,7 +64,7 @@ OPTIONS -q:: --quiet:: - git-rm normally outputs one line (in the form of an "rm" command) + '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 @@ also remove all of directory `d2`. EXAMPLES -------- -git-rm Documentation/\\*.txt:: +git rm Documentation/\\*.txt:: Removes all `\*.txt` files from the index that are under the `Documentation` directory and any of its subdirectories. + @@ -90,7 +91,7 @@ Note that the asterisk `\*` is quoted from the shell in this example; this lets git, and not the shell, expand the pathnames of files and subdirectories under the `Documentation/` directory. -git-rm -f git-*.sh:: +git rm -f git-*.sh:: 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`.