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         This option cannot be used when checking out paths from a
  82         tree-ish (i.e. with the `--source` option).
  83 +
  84 Note that during `git rebase` and `git pull --rebase`, 'ours' and
  85 'theirs' may appear swapped. See the explanation of the same options
  86 in linkgit:git-checkout[1] for details.
  87
  88 -m::
  89 --merge::
  90         When restoring files on the working tree from the index,
  91         recreate the conflicted merge in the unmerged paths.
  92         This option cannot be used when checking out paths from a
  93         tree-ish (i.e. with the `--source` option).
  94
  95 --conflict=<style>::
  96         The same as `--merge` option above, but changes the way the
  97         conflicting hunks are presented, overriding the
  98         `merge.conflictStyle` configuration variable.  Possible values
  99         are "merge" (default), "diff3", and "zdiff3".
 100
 101 --ignore-unmerged::
 102         When restoring files on the working tree from the index, do
 103         not abort the operation if there are unmerged entries and
 104         neither `--ours`, `--theirs`, `--merge` or `--conflict` is
 105         specified. Unmerged paths on the working tree are left alone.
 106
 107 --ignore-skip-worktree-bits::
 108         In sparse checkout mode, the default is to only update entries
 109         matched by `<pathspec>` and sparse patterns in
 110         $GIT_DIR/info/sparse-checkout. This option ignores the sparse
 111         patterns and unconditionally restores any files in
 112         `<pathspec>`.
 113
 114 --recurse-submodules::
 115 --no-recurse-submodules::
 116         If `<pathspec>` names an active submodule and the restore location
 117         includes the working tree, the submodule will only be updated if
 118         this option is given, in which case its working tree will be
 119         restored to the commit recorded in the superproject, and any local
 120         modifications overwritten. If nothing (or
 121         `--no-recurse-submodules`) is used, submodules working trees will
 122         not be updated. Just like linkgit:git-checkout[1], this will detach
 123         `HEAD` of the submodule.
 124
 125 --overlay::
 126 --no-overlay::
 127         In overlay mode, the command never removes files when
 128         restoring. In no-overlay mode, tracked files that do not
 129         appear in the `--source` tree are removed, to make them match
 130         `<tree>` exactly. The default is no-overlay mode.
 131
 132 --pathspec-from-file=<file>::
 133         Pathspec is passed in `<file>` instead of commandline args. If
 134         `<file>` is exactly `-` then standard input is used. Pathspec
 135         elements are separated by LF or CR/LF. Pathspec elements can be
 136         quoted as explained for the configuration variable `core.quotePath`
 137         (see linkgit:git-config[1]). See also `--pathspec-file-nul` and
 138         global `--literal-pathspecs`.
 139
 140 --pathspec-file-nul::
 141         Only meaningful with `--pathspec-from-file`. Pathspec elements are
 142         separated with NUL character and all other characters are taken
 143         literally (including newlines and quotes).
 144
 145 \--::
 146         Do not interpret any more arguments as options.
 147
 148 <pathspec>...::
 149         Limits the paths affected by the operation.
 150 +
 151 For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
 152
 153 EXAMPLES
 154 --------
 155
 156 The following sequence switches to the `master` branch, reverts the
 157 `Makefile` to two revisions back, deletes hello.c by mistake, and gets
 158 it back from the index.
 159
 160 ------------
 161 $ git switch master
 162 $ git restore --source master~2 Makefile  <1>
 163 $ rm -f hello.c
 164 $ git restore hello.c                     <2>
 165 ------------
 166
 167 <1> take a file out of another commit
 168 <2> restore hello.c from the index
 169
 170 If you want to restore _all_ C source files to match the version in
 171 the index, you can say
 172
 173 ------------
 174 $ git restore '*.c'
 175 ------------
 176
 177 Note the quotes around `*.c`.  The file `hello.c` will also be
 178 restored, even though it is no longer in the working tree, because the
 179 file globbing is used to match entries in the index (not in the
 180 working tree by the shell).
 181
 182 To restore all files in the current directory
 183
 184 ------------
 185 $ git restore .
 186 ------------
 187
 188 or to restore all working tree files with 'top' pathspec magic (see
 189 linkgit:gitglossary[7])
 190
 191 ------------
 192 $ git restore :/
 193 ------------
 194
 195 To restore a file in the index to match the version in `HEAD` (this is
 196 the same as using linkgit:git-reset[1])
 197
 198 ------------
 199 $ git restore --staged hello.c
 200 ------------
 201
 202 or you can restore both the index and the working tree (this is the same
 203 as using linkgit:git-checkout[1])
 204
 205 ------------
 206 $ git restore --source=HEAD --staged --worktree hello.c
 207 ------------
 208
 209 or the short form which is more practical but less readable:
 210
 211 ------------
 212 $ git restore -s@ -SW hello.c
 213 ------------
 214
 215 SEE ALSO
 216 --------
 217 linkgit:git-checkout[1],
 218 linkgit:git-reset[1]
 219
 220 GIT
 221 ---
 222 Part of the linkgit:git[1] suite