man1/git-rm.1

   1 '\" t
   2 .\"     Title: git-rm
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-09-30
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.47.0.rc0.18.ge9356ba3ea
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-RM" "1" "2024-09-30" "Git 2\&.47\&.0\&.rc0\&.18\&.ge" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-rm \- Remove files from the working tree and from the index
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit rm\fR [\-f | \-\-force] [\-n] [\-r] [\-\-cached] [\-\-ignore\-unmatch]
  36           [\-\-quiet] [\-\-pathspec\-from\-file=<file> [\-\-pathspec\-file\-nul]]
  37           [\-\-] [<pathspec>\&...\:]
  38 .fi
  39 .SH "DESCRIPTION"
  40 .sp
  41 Remove files matching pathspec from the index, or from the working tree and the index\&. \fBgit rm\fR will not remove a file from just your working directory\&. (There is no option to remove a file only from the working tree and yet keep it in the index; use \fB/bin/rm\fR if you want to do that\&.) The files being removed have to be identical to the tip of the branch, and no updates to their contents can be staged in the index, though that default behavior can be overridden with the \fB\-f\fR option\&. When \fB\-\-cached\fR is given, the staged content has to match either the tip of the branch or the file on disk, allowing the file to be removed from just the index\&. When sparse\-checkouts are in use (see \fBgit-sparse-checkout\fR(1)), \fBgit rm\fR will only remove paths within the sparse\-checkout patterns\&.
  42 .SH "OPTIONS"
  43 .PP
  44 <pathspec>\&...\:
  45 .RS 4
  46 Files to remove\&. A leading directory name (e\&.g\&.
  47 \fBdir\fR
  48 to remove
  49 \fBdir/file1\fR
  50 and
  51 \fBdir/file2\fR) can be given to remove all files in the directory, and recursively all sub\-directories, but this requires the
  52 \fB\-r\fR
  53 option to be explicitly given\&.
  54 .sp
  55 The command removes only the paths that are known to Git\&.
  56 .sp
  57 File globbing matches across directory boundaries\&. Thus, given two directories
  58 \fBd\fR
  59 and
  60 \fBd2\fR, there is a difference between using
  61 \fBgit rm \*(Aqd*\*(Aq\fR
  62 and
  63 \fBgit rm \*(Aqd/*\*(Aq\fR, as the former will also remove all of directory
  64 \fBd2\fR\&.
  65 .sp
  66 For more details, see the
  67 \fIpathspec\fR
  68 entry in
  69 \fBgitglossary\fR(7)\&.
  70 .RE
  71 .PP
  72 \-f, \-\-force
  73 .RS 4
  74 Override the up\-to\-date check\&.
  75 .RE
  76 .PP
  77 \-n, \-\-dry\-run
  78 .RS 4
  79 Don\(cqt actually remove any file(s)\&. Instead, just show if they exist in the index and would otherwise be removed by the command\&.
  80 .RE
  81 .PP
  82 \-r
  83 .RS 4
  84 Allow recursive removal when a leading directory name is given\&.
  85 .RE
  86 .PP
  87 \-\-
  88 .RS 4
  89 This option can be used to separate command\-line options from the list of files, (useful when filenames might be mistaken for command\-line options)\&.
  90 .RE
  91 .PP
  92 \-\-cached
  93 .RS 4
  94 Use this option to unstage and remove paths only from the index\&. Working tree files, whether modified or not, will be left alone\&.
  95 .RE
  96 .PP
  97 \-\-ignore\-unmatch
  98 .RS 4
  99 Exit with a zero status even if no files matched\&.
 100 .RE
 101 .PP
 102 \-\-sparse
 103 .RS 4
 104 Allow updating index entries outside of the sparse\-checkout cone\&. Normally,
 105 \fBgit rm\fR
 106 refuses to update index entries whose paths do not fit within the sparse\-checkout cone\&. See
 107 \fBgit-sparse-checkout\fR(1)
 108 for more\&.
 109 .RE
 110 .PP
 111 \-q, \-\-quiet
 112 .RS 4
 113 \fBgit rm\fR
 114 normally outputs one line (in the form of an
 115 \fBrm\fR
 116 command) for each file removed\&. This option suppresses that output\&.
 117 .RE
 118 .PP
 119 \-\-pathspec\-from\-file=<file>
 120 .RS 4
 121 Pathspec is passed in
 122 \fB<file>\fR
 123 instead of commandline args\&. If
 124 \fB<file>\fR
 125 is exactly
 126 \fB\-\fR
 127 then standard input is used\&. Pathspec elements are separated by LF or CR/LF\&. Pathspec elements can be quoted as explained for the configuration variable
 128 \fBcore\&.quotePath\fR
 129 (see
 130 \fBgit-config\fR(1))\&. See also
 131 \fB\-\-pathspec\-file\-nul\fR
 132 and global
 133 \fB\-\-literal\-pathspecs\fR\&.
 134 .RE
 135 .PP
 136 \-\-pathspec\-file\-nul
 137 .RS 4
 138 Only meaningful with
 139 \fB\-\-pathspec\-from\-file\fR\&. Pathspec elements are separated with NUL character and all other characters are taken literally (including newlines and quotes)\&.
 140 .RE
 141 .SH "REMOVING FILES THAT HAVE DISAPPEARED FROM THE FILESYSTEM"
 142 .sp
 143 There is no option for \fBgit rm\fR to remove from the index only the paths that have disappeared from the filesystem\&. However, depending on the use case, there are several ways that can be done\&.
 144 .SS "Using \(lqgit commit \-a\(rq"
 145 .sp
 146 If you intend that your next commit should record all modifications of tracked files in the working tree and record all removals of files that have been removed from the working tree with \fBrm\fR (as opposed to \fBgit rm\fR), use \fBgit commit \-a\fR, as it will automatically notice and record all removals\&. You can also have a similar effect without committing by using \fBgit add \-u\fR\&.
 147 .SS "Using \(lqgit add \-A\(rq"
 148 .sp
 149 When accepting a new code drop for a vendor branch, you probably want to record both the removal of paths and additions of new paths as well as modifications of existing paths\&.
 150 .sp
 151 Typically you would first remove all tracked files from the working tree using this command:
 152 .sp
 153 .if n \{\
 154 .RS 4
 155 .\}
 156 .nf
 157 git ls\-files \-z | xargs \-0 rm \-f
 158 .fi
 159 .if n \{\
 160 .RE
 161 .\}
 162 .sp
 163 and then untar the new code in the working tree\&. Alternately you could \fIrsync\fR the changes into the working tree\&.
 164 .sp
 165 After that, the easiest way to record all removals, additions, and modifications in the working tree is:
 166 .sp
 167 .if n \{\
 168 .RS 4
 169 .\}
 170 .nf
 171 git add \-A
 172 .fi
 173 .if n \{\
 174 .RE
 175 .\}
 176 .sp
 177 See \fBgit-add\fR(1)\&.
 178 .SS "Other ways"
 179 .sp
 180 If all you really want to do is to remove from the index the files that are no longer present in the working tree (perhaps because your working tree is dirty so that you cannot use \fBgit commit \-a\fR), use the following command:
 181 .sp
 182 .if n \{\
 183 .RS 4
 184 .\}
 185 .nf
 186 git diff \-\-name\-only \-\-diff\-filter=D \-z | xargs \-0 git rm \-\-cached
 187 .fi
 188 .if n \{\
 189 .RE
 190 .\}
 191 .SH "SUBMODULES"
 192 .sp
 193 Only submodules using a gitfile (which means they were cloned with a Git version 1\&.7\&.8 or newer) will be removed from the work tree, as their repository lives inside the \&.git directory of the superproject\&. If a submodule (or one of those nested inside it) still uses a \&.git directory, \fBgit rm\fR will move the submodules git directory into the superprojects git directory to protect the submodule\(cqs history\&. If it exists the submodule\&.<name> section in the \fBgitmodules\fR(5) file will also be removed and that file will be staged (unless \-\-cached or \-n are used)\&.
 194 .sp
 195 A submodule is considered up to date when the HEAD is the same as recorded in the index, no tracked files are modified and no untracked files that aren\(cqt ignored are present in the submodule\(cqs work tree\&. Ignored files are deemed expendable and won\(cqt stop a submodule\(cqs work tree from being removed\&.
 196 .sp
 197 If you only want to remove the local checkout of a submodule from your work tree without committing the removal, use \fBgit-submodule\fR(1) \fBdeinit\fR instead\&. Also see \fBgitsubmodules\fR(7) for details on submodule removal\&.
 198 .SH "EXAMPLES"
 199 .PP
 200 \fBgit rm Documentation/\e*\&.txt\fR
 201 .RS 4
 202 Removes all
 203 \fB*\&.txt\fR
 204 files from the index that are under the
 205 \fBDocumentation\fR
 206 directory and any of its subdirectories\&.
 207 .sp
 208 Note that the asterisk
 209 \fB*\fR
 210 is quoted from the shell in this example; this lets Git, and not the shell, expand the pathnames of files and subdirectories under the
 211 \fBDocumentation/\fR
 212 directory\&.
 213 .RE
 214 .PP
 215 \fBgit rm \-f git\-*\&.sh\fR
 216 .RS 4
 217 Because this example lets the shell expand the asterisk (i\&.e\&. you are listing the files explicitly), it does not remove
 218 \fBsubdir/git\-foo\&.sh\fR\&.
 219 .RE
 220 .SH "BUGS"
 221 .sp
 222 Each time a superproject update removes a populated submodule (e\&.g\&. when switching between commits before and after the removal) a stale submodule checkout will remain in the old location\&. Removing the old directory is only safe when it uses a gitfile, as otherwise the history of the submodule will be deleted too\&. This step will be obsolete when recursive submodule update has been implemented\&.
 223 .SH "SEE ALSO"
 224 .sp
 225 \fBgit-add\fR(1)
 226 .SH "GIT"
 227 .sp
 228 Part of the \fBgit\fR(1) suite