]>
Commit | Line | Data |
---|---|---|
46e91b66 NTND |
1 | git-restore(1) |
2 | ============== | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-restore - Restore working tree files | |
7 | ||
8 | SYNOPSIS | |
9 | -------- | |
10 | [verse] | |
cfd9376c | 11 | 'git restore' [<options>] [--source=<tree>] [--staged] [--worktree] [--] <pathspec>... |
a9aecc7a | 12 | 'git restore' [<options>] [--source=<tree>] [--staged] [--worktree] --pathspec-from-file=<file> [--pathspec-file-nul] |
cfd9376c | 13 | 'git restore' (-p|--patch) [<options>] [--source=<tree>] [--staged] [--worktree] [--] [<pathspec>...] |
46e91b66 NTND |
14 | |
15 | DESCRIPTION | |
16 | ----------- | |
17 | Restore specified paths in the working tree with some contents from a | |
18 | restore source. If a path is tracked but does not exist in the restore | |
19 | source, it will be removed to match the source. | |
20 | ||
21 | The command can also be used to restore the content in the index with | |
22 | `--staged`, or restore both the working tree and the index with | |
23 | `--staged --worktree`. | |
24 | ||
088018e3 ES |
25 | By default, if `--staged` is given, the contents are restored from `HEAD`, |
26 | otherwise from the index. Use `--source` to restore from a different commit. | |
46e91b66 NTND |
27 | |
28 | See "Reset, restore and revert" in linkgit:git[1] for the differences | |
29 | between the three commands. | |
30 | ||
4e43b7ff NTND |
31 | THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE. |
32 | ||
46e91b66 NTND |
33 | OPTIONS |
34 | ------- | |
35 | -s <tree>:: | |
36 | --source=<tree>:: | |
37 | Restore the working tree files with the content from the given | |
38 | tree. It is common to specify the source tree by naming a | |
39 | commit, branch or tag associated with it. | |
40 | + | |
088018e3 ES |
41 | If not specified, the contents are restored from `HEAD` if `--staged` is |
42 | given, otherwise from the index. | |
46e91b66 NTND |
43 | |
44 | -p:: | |
45 | --patch:: | |
46 | Interactively select hunks in the difference between the | |
47 | restore source and the restore location. See the ``Interactive | |
48 | Mode'' section of linkgit:git-add[1] to learn how to operate | |
49 | the `--patch` mode. | |
50 | + | |
51 | Note that `--patch` can accept no pathspec and will prompt to restore | |
52 | all modified paths. | |
53 | ||
54 | -W:: | |
55 | --worktree:: | |
56 | -S:: | |
57 | --staged:: | |
58 | Specify the restore location. If neither option is specified, | |
59 | by default the working tree is restored. Specifying `--staged` | |
60 | will only restore the index. Specifying both restores both. | |
61 | ||
62 | -q:: | |
63 | --quiet:: | |
64 | Quiet, suppress feedback messages. Implies `--no-progress`. | |
65 | ||
66 | --progress:: | |
67 | --no-progress:: | |
68 | Progress status is reported on the standard error stream | |
69 | by default when it is attached to a terminal, unless `--quiet` | |
70 | is specified. This flag enables progress reporting even if not | |
71 | attached to a terminal, regardless of `--quiet`. | |
72 | ||
73 | --ours:: | |
74 | --theirs:: | |
75 | When restoring files in the working tree from the index, use | |
76 | stage #2 ('ours') or #3 ('theirs') for unmerged paths. | |
77 | + | |
78 | Note that during `git rebase` and `git pull --rebase`, 'ours' and | |
79 | 'theirs' may appear swapped. See the explanation of the same options | |
80 | in linkgit:git-checkout[1] for details. | |
81 | ||
82 | -m:: | |
83 | --merge:: | |
84 | When restoring files on the working tree from the index, | |
85 | recreate the conflicted merge in the unmerged paths. | |
86 | ||
87 | --conflict=<style>:: | |
88 | The same as `--merge` option above, but changes the way the | |
89 | conflicting hunks are presented, overriding the | |
90 | `merge.conflictStyle` configuration variable. Possible values | |
91 | are "merge" (default) and "diff3" (in addition to what is | |
92 | shown by "merge" style, shows the original contents). | |
93 | ||
94 | --ignore-unmerged:: | |
95 | When restoring files on the working tree from the index, do | |
96 | not abort the operation if there are unmerged entries and | |
97 | neither `--ours`, `--theirs`, `--merge` or `--conflict` is | |
98 | specified. Unmerged paths on the working tree are left alone. | |
99 | ||
100 | --ignore-skip-worktree-bits:: | |
101 | In sparse checkout mode, by default is to only update entries | |
102 | matched by `<pathspec>` and sparse patterns in | |
103 | $GIT_DIR/info/sparse-checkout. This option ignores the sparse | |
104 | patterns and unconditionally restores any files in | |
105 | `<pathspec>`. | |
106 | ||
b3cec573 DR |
107 | --recurse-submodules:: |
108 | --no-recurse-submodules:: | |
109 | If `<pathspec>` names an active submodule and the restore location | |
110 | includes the working tree, the submodule will only be updated if | |
111 | this option is given, in which case its working tree will be | |
112 | restored to the commit recorded in the superproject, and any local | |
113 | modifications overwritten. If nothing (or | |
114 | `--no-recurse-submodules`) is used, submodules working trees will | |
115 | not be updated. Just like linkgit:git-checkout[1], this will detach | |
116 | `HEAD` of the submodule. | |
117 | ||
46e91b66 NTND |
118 | --overlay:: |
119 | --no-overlay:: | |
120 | In overlay mode, the command never removes files when | |
121 | restoring. In no-overlay mode, tracked files that do not | |
122 | appear in the `--source` tree are removed, to make them match | |
123 | `<tree>` exactly. The default is no-overlay mode. | |
124 | ||
a9aecc7a AM |
125 | --pathspec-from-file=<file>:: |
126 | Pathspec is passed in `<file>` instead of commandline args. If | |
127 | `<file>` is exactly `-` then standard input is used. Pathspec | |
128 | elements are separated by LF or CR/LF. Pathspec elements can be | |
129 | quoted as explained for the configuration variable `core.quotePath` | |
130 | (see linkgit:git-config[1]). See also `--pathspec-file-nul` and | |
131 | global `--literal-pathspecs`. | |
132 | ||
133 | --pathspec-file-nul:: | |
134 | Only meaningful with `--pathspec-from-file`. Pathspec elements are | |
135 | separated with NUL character and all other characters are taken | |
136 | literally (including newlines and quotes). | |
137 | ||
cfd9376c AM |
138 | \--:: |
139 | Do not interpret any more arguments as options. | |
140 | ||
141 | <pathspec>...:: | |
142 | Limits the paths affected by the operation. | |
143 | + | |
144 | For more details, see the 'pathspec' entry in linkgit:gitglossary[7]. | |
145 | ||
46e91b66 NTND |
146 | EXAMPLES |
147 | -------- | |
148 | ||
149 | The following sequence switches to the `master` branch, reverts the | |
150 | `Makefile` to two revisions back, deletes hello.c by mistake, and gets | |
151 | it back from the index. | |
152 | ||
153 | ------------ | |
154 | $ git switch master | |
155 | $ git restore --source master~2 Makefile <1> | |
156 | $ rm -f hello.c | |
157 | $ git restore hello.c <2> | |
158 | ------------ | |
159 | ||
160 | <1> take a file out of another commit | |
161 | <2> restore hello.c from the index | |
162 | ||
163 | If you want to restore _all_ C source files to match the version in | |
164 | the index, you can say | |
165 | ||
166 | ------------ | |
167 | $ git restore '*.c' | |
168 | ------------ | |
169 | ||
170 | Note the quotes around `*.c`. The file `hello.c` will also be | |
171 | restored, even though it is no longer in the working tree, because the | |
172 | file globbing is used to match entries in the index (not in the | |
173 | working tree by the shell). | |
174 | ||
175 | To restore all files in the current directory | |
176 | ||
177 | ------------ | |
178 | $ git restore . | |
179 | ------------ | |
180 | ||
181 | or to restore all working tree files with 'top' pathspec magic (see | |
182 | linkgit:gitglossary[7]) | |
183 | ||
184 | ------------ | |
185 | $ git restore :/ | |
186 | ------------ | |
187 | ||
188 | To restore a file in the index to match the version in `HEAD` (this is | |
189 | the same as using linkgit:git-reset[1]) | |
190 | ||
191 | ------------ | |
192 | $ git restore --staged hello.c | |
193 | ------------ | |
194 | ||
195 | or you can restore both the index and the working tree (this the same | |
196 | as using linkgit:git-checkout[1]) | |
197 | ||
198 | ------------ | |
199 | $ git restore --source=HEAD --staged --worktree hello.c | |
200 | ------------ | |
201 | ||
202 | or the short form which is more practical but less readable: | |
203 | ||
204 | ------------ | |
205 | $ git restore -s@ -SW hello.c | |
206 | ------------ | |
207 | ||
208 | SEE ALSO | |
209 | -------- | |
210 | linkgit:git-checkout[1], | |
211 | linkgit:git-reset[1] | |
212 | ||
213 | GIT | |
214 | --- | |
215 | Part of the linkgit:git[1] suite |