Merge branch 'ah/doc-gitattributes-empty-index' into maint
[git/git.git] / Documentation / git-rm.txt
CommitLineData
d4a1cab5
CW
1git-rm(1)
2=========
3
4NAME
5----
7bd7f280 6git-rm - Remove files from the working tree and from the index
d4a1cab5
CW
7
8SYNOPSIS
9--------
7791a1d9 10[verse]
01144f20 11'git rm' [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch] [--quiet] [--] <file>...
d4a1cab5
CW
12
13DESCRIPTION
14-----------
25dc7200 15Remove files from the index, or from the working tree and the index.
441947f6 16`git rm` will not remove a file from just your working directory.
47b70120 17(There is no option to remove a file only from the working tree
25dc7200
JL
18and yet keep it in the index; use `/bin/rm` if you want to do that.)
19The files being removed have to be identical to the tip of the branch,
20and no updates to their contents can be staged in the index,
21though that default behavior can be overridden with the `-f` option.
441947f6 22When `--cached` is given, the staged content has to
25dc7200
JL
23match either the tip of the branch or the file on disk,
24allowing the file to be removed from just the index.
d4a1cab5
CW
25
26
27OPTIONS
28-------
29<file>...::
08d22488 30 Files to remove. Fileglobs (e.g. `*.c`) can be given to
2de9b711 31 remove all matching files. If you want Git to expand
25dc7200
JL
32 file glob characters, you may need to shell-escape them.
33 A leading directory name
34 (e.g. `dir` to remove `dir/file1` and `dir/file2`) can be
35 given to remove all files in the directory, and recursively
36 all sub-directories,
37 but this requires the `-r` option to be explicitly given.
d4a1cab5
CW
38
39-f::
01144f20 40--force::
08d22488 41 Override the up-to-date check.
d4a1cab5 42
3240240f
SB
43-n::
44--dry-run::
25dc7200
JL
45 Don't actually remove any file(s). Instead, just show
46 if they exist in the index and would otherwise be removed
47 by the command.
d4a1cab5 48
08d22488
JH
49-r::
50 Allow recursive removal when a leading directory name is
51 given.
d4a1cab5 52
e994004f 53\--::
d4a1cab5
CW
54 This option can be used to separate command-line options from
55 the list of files, (useful when filenames might be mistaken
56 for command-line options).
57
3240240f 58--cached::
25dc7200
JL
59 Use this option to unstage and remove paths only from the index.
60 Working tree files, whether modified or not, will be
61 left alone.
08d22488 62
3240240f 63--ignore-unmatch::
bb1faf0d
SG
64 Exit with a zero status even if no files matched.
65
3240240f
SB
66-q::
67--quiet::
441947f6 68 `git rm` normally outputs one line (in the form of an `rm` command)
b48caa20
SG
69 for each file removed. This option suppresses that output.
70
d4a1cab5
CW
71
72DISCUSSION
73----------
74
25dc7200
JL
75The <file> list given to the command can be exact pathnames,
76file glob patterns, or leading directory names. The command
2de9b711
TA
77removes only the paths that are known to Git. Giving the name of
78a file that you have not told Git about does not remove that file.
d4a1cab5 79
25dc7200
JL
80File globbing matches across directory boundaries. Thus, given
81two directories `d` and `d2`, there is a difference between
6cf378f0 82using `git rm 'd*'` and `git rm 'd/*'`, as the former will
25dc7200 83also remove all of directory `d2`.
d4a1cab5 84
47b70120
BG
85REMOVING FILES THAT HAVE DISAPPEARED FROM THE FILESYSTEM
86--------------------------------------------------------
87There is no option for `git rm` to remove from the index only
88the paths that have disappeared from the filesystem. However,
89depending on the use case, there are several ways that can be
90done.
91
f34e9edc
MG
92Using ``git commit -a''
93~~~~~~~~~~~~~~~~~~~~~~~
47b70120
BG
94If you intend that your next commit should record all modifications
95of tracked files in the working tree and record all removals of
96files that have been removed from the working tree with `rm`
97(as opposed to `git rm`), use `git commit -a`, as it will
98automatically notice and record all removals. You can also have a
99similar effect without committing by using `git add -u`.
100
f34e9edc
MG
101Using ``git add -A''
102~~~~~~~~~~~~~~~~~~~~
47b70120
BG
103When accepting a new code drop for a vendor branch, you probably
104want to record both the removal of paths and additions of new paths
105as well as modifications of existing paths.
106
107Typically you would first remove all tracked files from the working
108tree using this command:
109
110----------------
111git ls-files -z | xargs -0 rm -f
112----------------
113
f34e9edc
MG
114and then untar the new code in the working tree. Alternately
115you could 'rsync' the changes into the working tree.
47b70120
BG
116
117After that, the easiest way to record all removals, additions, and
118modifications in the working tree is:
119
120----------------
121git add -A
122----------------
123
124See linkgit:git-add[1].
125
126Other ways
127~~~~~~~~~~
128If all you really want to do is to remove from the index the files
129that are no longer present in the working tree (perhaps because
130your working tree is dirty so that you cannot use `git commit -a`),
131use the following command:
132
133----------------
134git diff --name-only --diff-filter=D -z | xargs -0 git rm --cached
135----------------
136
95c16418
JL
137SUBMODULES
138----------
3469c7eb 139Only submodules using a gitfile (which means they were cloned
2de9b711 140with a Git version 1.7.8 or newer) will be removed from the work
3469c7eb
MK
141tree, as their repository lives inside the .git directory of the
142superproject. If a submodule (or one of those nested inside it)
68602c01
SB
143still uses a .git directory, `git rm` will move the submodules
144git directory into the superprojects git directory to protect
145the submodule's history. If it exists the submodule.<name> section
146in the linkgit:gitmodules[5] file will also be removed and that file
147will be staged (unless --cached or -n are used).
3469c7eb
MK
148
149A submodule is considered up-to-date when the HEAD is the same as
150recorded in the index, no tracked files are modified and no untracked
151files that aren't ignored are present in the submodules work tree.
152Ignored files are deemed expendable and won't stop a submodule's work
153tree from being removed.
154
cf419828
JL
155If you only want to remove the local checkout of a submodule from your
156work tree without committing the removal,
157use linkgit:git-submodule[1] `deinit` instead.
158
d4a1cab5
CW
159EXAMPLES
160--------
5d2fc913 161`git rm Documentation/\*.txt`::
c300578f 162 Removes all `*.txt` files from the index that are under the
a9877f83 163 `Documentation` directory and any of its subdirectories.
d4a1cab5 164+
c300578f 165Note that the asterisk `*` is quoted from the shell in this
2de9b711 166example; this lets Git, and not the shell, expand the pathnames
25dc7200 167of files and subdirectories under the `Documentation/` directory.
d4a1cab5 168
5d2fc913 169`git rm -f git-*.sh`::
a9877f83
JH
170 Because this example lets the shell expand the asterisk
171 (i.e. you are listing the files explicitly), it
08d22488 172 does not remove `subdir/git-foo.sh`.
d4a1cab5 173
bbad9f93
JL
174BUGS
175----
176Each time a superproject update removes a populated submodule
177(e.g. when switching between commits before and after the removal) a
178stale submodule checkout will remain in the old location. Removing the
179old directory is only safe when it uses a gitfile, as otherwise the
180history of the submodule will be deleted too. This step will be
181obsolete when recursive submodule update has been implemented.
182
56ae8df5 183SEE ALSO
872d001f 184--------
5162e697 185linkgit:git-add[1]
d4a1cab5 186
d4a1cab5
CW
187GIT
188---
9e1f0a85 189Part of the linkgit:git[1] suite