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