undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

git-rm: Documentation

Browse Source 
Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
Junio C Hamano 2006-12-25 03:23:45 -08:00
parent 467e1b5383
commit 08d22488a6
1 changed files with 27 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
Documentation/git-rm.txt
View File

@ -7,51 +7,54 @@ git-rm - Remove files from the working tree and from the index
SYNOPSIS SYNOPSIS
-------- --------
'git-rm' [-f] [-n] [-v] [--] <file>... 'git-rm' [-f] [-n] [-r] [--cached] [--] <file>...
DESCRIPTION DESCRIPTION
----------- -----------
A convenience wrapper for git-update-index --remove. For those coming Remove files from the working tree and from the index. The
from cvs, git-rm provides an operation similar to "cvs rm" or "cvs files have to be identical to the tip of the branch, and no
remove". updates to its contents must have been placed in the staging
area (aka index).
OPTIONS OPTIONS
------- -------
<file>...:: <file>...::
Files to remove from the index and optionally, from the Files to remove. Fileglobs (e.g. `*.c`) can be given to
working tree as well. remove all matching files. Also a leading directory name
(e.g. `dir` to add `dir/file1` and `dir/file2`) can be
given to remove all files in the directory, recursively,
but this requires `-r` option to be given for safety.
-f:: -f::
Remove files from the working tree as well as from the index. Override the up-to-date check.
-n:: -n::
Don't actually remove the file(s), just show if they exist in Don't actually remove the file(s), just show if they exist in
the index. the index.
-v:: -r::
Be verbose. Allow recursive removal when a leading directory name is
given.
\--:: \--::
This option can be used to separate command-line options from This option can be used to separate command-line options from
the list of files, (useful when filenames might be mistaken the list of files, (useful when filenames might be mistaken
for command-line options). for command-line options).
\--cached::
This option can be used to tell the command to remove
the paths only from the index, leaving working tree
files.
DISCUSSION DISCUSSION
---------- ----------
The list of <file> given to the command is fed to `git-ls-files` The list of <file> given to the command can be exact pathnames,
command to list files that are registered in the index and file glob patterns, or leading directory name. The command
are not ignored/excluded by `$GIT_DIR/info/exclude` file or removes only the paths that is known to git. Giving the name of
`.gitignore` file in each directory. This means two things: a file that you have not told git about does not remove that file.
. You can put the name of a directory on the command line, and the
command will remove all files in it and its subdirectories (the
directories themselves are never removed from the working tree);
. Giving the name of a file that is not in the index does not
remove that file.
EXAMPLES EXAMPLES
@ -69,10 +72,10 @@ subdirectories of `Documentation/` directory.
git-rm -f git-*.sh:: git-rm -f git-*.sh::
Remove all git-*.sh scripts that are in the index. The files Remove all git-*.sh scripts that are in the index. The files
are removed from the index, and (because of the -f option), are removed from the index, and from the working
from the working tree as well. Because this example lets the tree. Because this example lets the shell expand the
shell expand the asterisk (i.e. you are listing the files asterisk (i.e. you are listing the files explicitly), it
explicitly), it does not remove `subdir/git-foo.sh`. does not remove `subdir/git-foo.sh`.
See Also See Also
-------- --------