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