| blob | 69bb5aa47603c258aaffa1098faf5d29d520400b |
1 '\" t
2 .\" Title: git-restore
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-25
6 .\" Manual: Git Manual
7 .\" Source: Git 2.47.0.rc0
8 .\" Language: English
9 .\"
10 .TH "GIT\-RESTORE" "1" "2024-09-25" "Git 2\&.47\&.0\&.rc0" "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-restore \- Restore working tree files
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit restore\fR [<options>] [\-\-source=<tree>] [\-\-staged] [\-\-worktree] [\-\-] <pathspec>\&...\:
36 \fIgit restore\fR [<options>] [\-\-source=<tree>] [\-\-staged] [\-\-worktree] \-\-pathspec\-from\-file=<file> [\-\-pathspec\-file\-nul]
37 \fIgit restore\fR (\-p|\-\-patch) [<options>] [\-\-source=<tree>] [\-\-staged] [\-\-worktree] [\-\-] [<pathspec>\&...\:]
38 .fi
39 .SH "DESCRIPTION"
40 .sp
41 Restore specified paths in the working tree with some contents from a restore source\&. If a path is tracked but does not exist in the restore source, it will be removed to match the source\&.
42 .sp
43 The command can also be used to restore the content in the index with \fB\-\-staged\fR, or restore both the working tree and the index with \fB\-\-staged \-\-worktree\fR\&.
44 .sp
45 By default, if \fB\-\-staged\fR is given, the contents are restored from \fBHEAD\fR, otherwise from the index\&. Use \fB\-\-source\fR to restore from a different commit\&.
46 .sp
47 See "Reset, restore and revert" in \fBgit\fR(1) for the differences between the three commands\&.
48 .sp
49 THIS COMMAND IS EXPERIMENTAL\&. THE BEHAVIOR MAY CHANGE\&.
50 .SH "OPTIONS"
51 .PP
52 \-s <tree>, \-\-source=<tree>
53 .RS 4
54 Restore the working tree files with the content from the given tree\&. It is common to specify the source tree by naming a commit, branch or tag associated with it\&.
55 .sp
56 If not specified, the contents are restored from
57 \fBHEAD\fR
58 if
59 \fB\-\-staged\fR
60 is given, otherwise from the index\&.
61 .sp
62 As a special case, you may use
63 \fB"A\&.\&.\&.B"\fR
64 as a shortcut for the merge base of
65 \fBA\fR
66 and
67 \fBB\fR
68 if there is exactly one merge base\&. You can leave out at most one of
69 \fBA\fR
70 and
71 \fBB\fR, in which case it defaults to
72 \fBHEAD\fR\&.
73 .RE
74 .PP
75 \-p, \-\-patch
76 .RS 4
77 Interactively select hunks in the difference between the restore source and the restore location\&. See the
78 \(lqInteractive Mode\(rq
79 section of
80 \fBgit-add\fR(1)
81 to learn how to operate the
82 \fB\-\-patch\fR
83 mode\&.
84 .sp
85 Note that
86 \fB\-\-patch\fR
87 can accept no pathspec and will prompt to restore all modified paths\&.
88 .RE
89 .PP
90 \-W, \-\-worktree, \-S, \-\-staged
91 .RS 4
92 Specify the restore location\&. If neither option is specified, by default the working tree is restored\&. Specifying
93 \fB\-\-staged\fR
94 will only restore the index\&. Specifying both restores both\&.
95 .RE
96 .PP
97 \-q, \-\-quiet
98 .RS 4
99 Quiet, suppress feedback messages\&. Implies
100 \fB\-\-no\-progress\fR\&.
101 .RE
102 .PP
103 \-\-progress, \-\-no\-progress
104 .RS 4
105 Progress status is reported on the standard error stream by default when it is attached to a terminal, unless
106 \fB\-\-quiet\fR
107 is specified\&. This flag enables progress reporting even if not attached to a terminal, regardless of
108 \fB\-\-quiet\fR\&.
109 .RE
110 .PP
111 \-\-ours, \-\-theirs
112 .RS 4
113 When restoring files in the working tree from the index, use stage #2 (\fIours\fR) or #3 (\fItheirs\fR) for unmerged paths\&. This option cannot be used when checking out paths from a tree\-ish (i\&.e\&. with the
114 \fB\-\-source\fR
115 option)\&.
116 .sp
117 Note that during
118 \fBgit rebase\fR
119 and
120 \fBgit pull \-\-rebase\fR,
121 \fIours\fR
122 and
123 \fItheirs\fR
124 may appear swapped\&. See the explanation of the same options in
125 \fBgit-checkout\fR(1)
126 for details\&.
127 .RE
128 .PP
129 \-m, \-\-merge
130 .RS 4
131 When restoring files on the working tree from the index, recreate the conflicted merge in the unmerged paths\&. This option cannot be used when checking out paths from a tree\-ish (i\&.e\&. with the
132 \fB\-\-source\fR
133 option)\&.
134 .RE
135 .PP
136 \-\-conflict=<style>
137 .RS 4
138 The same as
139 \fB\-\-merge\fR
140 option above, but changes the way the conflicting hunks are presented, overriding the
141 \fBmerge\&.conflictStyle\fR
142 configuration variable\&. Possible values are "merge" (default), "diff3", and "zdiff3"\&.
143 .RE
144 .PP
145 \-\-ignore\-unmerged
146 .RS 4
147 When restoring files on the working tree from the index, do not abort the operation if there are unmerged entries and neither
148 \fB\-\-ours\fR,
149 \fB\-\-theirs\fR,
150 \fB\-\-merge\fR
151 or
152 \fB\-\-conflict\fR
153 is specified\&. Unmerged paths on the working tree are left alone\&.
154 .RE
155 .PP
156 \-\-ignore\-skip\-worktree\-bits
157 .RS 4
158 In sparse checkout mode, the default is to only update entries matched by
159 \fB<pathspec>\fR
160 and sparse patterns in $GIT_DIR/info/sparse\-checkout\&. This option ignores the sparse patterns and unconditionally restores any files in
161 \fB<pathspec>\fR\&.
162 .RE
163 .PP
164 \-\-recurse\-submodules, \-\-no\-recurse\-submodules
165 .RS 4
166 If
167 \fB<pathspec>\fR
168 names an active submodule and the restore location includes the working tree, the submodule will only be updated if this option is given, in which case its working tree will be restored to the commit recorded in the superproject, and any local modifications overwritten\&. If nothing (or
169 \fB\-\-no\-recurse\-submodules\fR) is used, submodules working trees will not be updated\&. Just like
170 \fBgit-checkout\fR(1), this will detach
171 \fBHEAD\fR
172 of the submodule\&.
173 .RE
174 .PP
175 \-\-overlay, \-\-no\-overlay
176 .RS 4
177 In overlay mode, the command never removes files when restoring\&. In no\-overlay mode, tracked files that do not appear in the
178 \fB\-\-source\fR
179 tree are removed, to make them match
180 \fB<tree>\fR
181 exactly\&. The default is no\-overlay mode\&.
182 .RE
183 .PP
184 \-\-pathspec\-from\-file=<file>
185 .RS 4
186 Pathspec is passed in
187 \fB<file>\fR
188 instead of commandline args\&. If
189 \fB<file>\fR
190 is exactly
191 \fB\-\fR
192 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
193 \fBcore\&.quotePath\fR
194 (see
195 \fBgit-config\fR(1))\&. See also
196 \fB\-\-pathspec\-file\-nul\fR
197 and global
198 \fB\-\-literal\-pathspecs\fR\&.
199 .RE
200 .PP
201 \-\-pathspec\-file\-nul
202 .RS 4
203 Only meaningful with
204 \fB\-\-pathspec\-from\-file\fR\&. Pathspec elements are separated with NUL character and all other characters are taken literally (including newlines and quotes)\&.
205 .RE
206 .PP
207 \-\-
208 .RS 4
209 Do not interpret any more arguments as options\&.
210 .RE
211 .PP
212 <pathspec>\&...\:
213 .RS 4
214 Limits the paths affected by the operation\&.
215 .sp
216 For more details, see the
217 \fIpathspec\fR
218 entry in
219 \fBgitglossary\fR(7)\&.
220 .RE
221 .SH "EXAMPLES"
222 .sp
223 The following sequence switches to the \fBmaster\fR branch, reverts the \fBMakefile\fR to two revisions back, deletes hello\&.c by mistake, and gets it back from the index\&.
224 .sp
225 .if n \{\
226 .RS 4
227 .\}
228 .nf
229 $ git switch master
230 $ git restore \-\-source master~2 Makefile \fB(1)\fR
231 $ rm \-f hello\&.c
232 $ git restore hello\&.c \fB(2)\fR
233 .fi
234 .if n \{\
235 .RE
236 .\}
237 .sp
238 .TS
239 tab(:);
240 r lw(\n(.lu*75u/100u).
241 \fB1.\fR\h'-2n':T{
242 take a file out of another commit
243 T}
244 \fB2.\fR\h'-2n':T{
245 restore hello\&.c from the index
246 T}
247 .TE
248 .sp
249 If you want to restore \fIall\fR C source files to match the version in the index, you can say
250 .sp
251 .if n \{\
252 .RS 4
253 .\}
254 .nf
255 $ git restore \*(Aq*\&.c\*(Aq
256 .fi
257 .if n \{\
258 .RE
259 .\}
260 .sp
261 Note the quotes around \fB*\&.c\fR\&. The file \fBhello\&.c\fR will also be restored, even though it is no longer in the working tree, because the file globbing is used to match entries in the index (not in the working tree by the shell)\&.
262 .sp
263 To restore all files in the current directory
264 .sp
265 .if n \{\
266 .RS 4
267 .\}
268 .nf
269 $ git restore \&.
270 .fi
271 .if n \{\
272 .RE
273 .\}
274 .sp
275 or to restore all working tree files with \fItop\fR pathspec magic (see \fBgitglossary\fR(7))
276 .sp
277 .if n \{\
278 .RS 4
279 .\}
280 .nf
281 $ git restore :/
282 .fi
283 .if n \{\
284 .RE
285 .\}
286 .sp
287 To restore a file in the index to match the version in \fBHEAD\fR (this is the same as using \fBgit-reset\fR(1))
288 .sp
289 .if n \{\
290 .RS 4
291 .\}
292 .nf
293 $ git restore \-\-staged hello\&.c
294 .fi
295 .if n \{\
296 .RE
297 .\}
298 .sp
299 or you can restore both the index and the working tree (this is the same as using \fBgit-checkout\fR(1))
300 .sp
301 .if n \{\
302 .RS 4
303 .\}
304 .nf
305 $ git restore \-\-source=HEAD \-\-staged \-\-worktree hello\&.c
306 .fi
307 .if n \{\
308 .RE
309 .\}
310 .sp
311 or the short form which is more practical but less readable:
312 .sp
313 .if n \{\
314 .RS 4
315 .\}
316 .nf
317 $ git restore \-s@ \-SW hello\&.c
318 .fi
319 .if n \{\
320 .RE
321 .\}
322 .SH "SEE ALSO"
323 .sp
324 \fBgit-checkout\fR(1), \fBgit-reset\fR(1)
325 .SH "GIT"
326 .sp
327 Part of the \fBgit\fR(1) suite