Documentation/git-restore.txt

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