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