doc: git-restore: migrate to new style format
PATCH 1/1 doc: git-restore: migrate to new style format
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
The git-restore manpage was converted to the new documentation format:
- switching the synopsis to a 'synopsis' block which will automatically format placeholders in italics and keywords in monospace
- use _<placeholder>_ instead of <placeholder> in the description
- use backticks for keywords and more complex option descriptions. The new rendering engine will apply synopsis rules to these spans.
---
doc: git-restore: migrate to new style format
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1847%2Fjnavila%2Fdoc-git-restore-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1847/jnavila/doc-git-restore-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1847
Documentation/git-restore.txt | 109 +++++++++++++++++----------------- 1 file changed, 54 insertions(+), 55 deletions(-)
Documentation/git-restore.txt +54 -55
@@ -7,10 +7,10 @@ git-restore - Restore working tree files SYNOPSIS -------- -[verse] -'git restore' [<options>] [--source=<tree>] [--staged] [--worktree] [--] <pathspec>... -'git restore' [<options>] [--source=<tree>] [--staged] [--worktree] --pathspec-from-file=<file> [--pathspec-file-nul] -'git restore' (-p|--patch) [<options>] [--source=<tree>] [--staged] [--worktree] [--] [<pathspec>...] +[synopsis] +git restore [<options>] [--source=<tree>] [--staged] [--worktree] [--] <pathspec>... +git restore [<options>] [--source=<tree>] [--staged] [--worktree] --pathspec-from-file=<file> [--pathspec-file-nul] +git restore (-p|--patch) [<options>] [--source=<tree>] [--staged] [--worktree] [--] [<pathspec>...] DESCRIPTION -----------
@@ -32,8 +32,8 @@ THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE. OPTIONS ------- --s <tree>:: ---source=<tree>:: +`-s <tree>`:: +`--source=<tree>`:: 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.
@@ -41,79 +41,79 @@ OPTIONS If not specified, the contents are restored from `HEAD` if `--staged` is given, otherwise from the index. + -As a special case, you may use `"A...B"` as a shortcut for the -merge base of `A` and `B` if there is exactly one merge base. You can -leave out at most one of `A` and `B`, in which case it defaults to `HEAD`. +As a special case, you may use `"<refA>...<refB>"` as a shortcut for the +merge base of _<refA>_ and _<refB>_ if there is exactly one merge base. You can +leave out at most one of _<refA>__ and _<refB>_, in which case it defaults to `HEAD`. --p:: ---patch:: +`-p`:: +`--patch`:: Interactively select hunks in the difference between the - restore source and the restore location. See the ``Interactive - Mode'' section of linkgit:git-add[1] to learn how to operate + restore source and the restore location. See the "Interactive + Mode" section of linkgit:git-add[1] to learn how to operate the `--patch` mode. + Note that `--patch` can accept no pathspec and will prompt to restore all modified paths. --W:: ---worktree:: --S:: ---staged:: +`-W`:: +`--worktree`:: +`-S`:: +`--staged`:: Specify the restore location. If neither option is specified, by default the working tree is restored. Specifying `--staged` will only restore the index. Specifying both restores both. --q:: ---quiet:: +`-q`:: +`--quiet`:: Quiet, suppress feedback messages. Implies `--no-progress`. ---progress:: ---no-progress:: +`--progress`:: +`--no-progress`:: Progress status is reported on the standard error stream by default when it is attached to a terminal, unless `--quiet` is specified. This flag enables progress reporting even if not attached to a terminal, regardless of `--quiet`. ---ours:: ---theirs:: +`--ours`:: +`--theirs`:: When restoring files in the working tree from the index, use - stage #2 ('ours') or #3 ('theirs') for unmerged paths. + stage #2 (`ours`) or #3 (`theirs`) for unmerged paths. This option cannot be used when checking out paths from a tree-ish (i.e. with the `--source` option). + -Note that during `git rebase` and `git pull --rebase`, 'ours' and -'theirs' may appear swapped. See the explanation of the same options +Note that during `git rebase` and `git pull --rebase`, `ours` and +`theirs` may appear swapped. See the explanation of the same options in linkgit:git-checkout[1] for details. --m:: ---merge:: +`-m`:: +`--merge`:: 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 `--source` option). ---conflict=<style>:: +`--conflict=<style>`:: The same as `--merge` option above, but changes the way the conflicting hunks are presented, overriding the `merge.conflictStyle` configuration variable. Possible values - are "merge" (default), "diff3", and "zdiff3". + are `merge` (default), `diff3`, and `zdiff3`. ---ignore-unmerged:: +`--ignore-unmerged`:: When restoring files on the working tree from the index, do not abort the operation if there are unmerged entries and neither `--ours`, `--theirs`, `--merge` or `--conflict` is specified. Unmerged paths on the working tree are left alone. ---ignore-skip-worktree-bits:: +`--ignore-skip-worktree-bits`:: In sparse checkout mode, the default is to only update entries - matched by `<pathspec>` and sparse patterns in - $GIT_DIR/info/sparse-checkout. This option ignores the sparse + matched by _<pathspec>_ and sparse patterns in + `$GIT_DIR/info/sparse-checkout`. This option ignores the sparse patterns and unconditionally restores any files in - `<pathspec>`. + _<pathspec>_. ---recurse-submodules:: ---no-recurse-submodules:: - If `<pathspec>` names an active submodule and the restore location +`--recurse-submodules`:: +`--no-recurse-submodules`:: + If _<pathspec>_ 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
@@ -122,30 +122,29 @@ in linkgit:git-checkout[1] for details. not be updated. Just like linkgit:git-checkout[1], this will detach `HEAD` of the submodule. ---overlay:: ---no-overlay:: - In overlay mode, the command never removes files when - restoring. In no-overlay mode, tracked files that do not - appear in the `--source` tree are removed, to make them match - `<tree>` exactly. The default is no-overlay mode. - ---pathspec-from-file=<file>:: - Pathspec is passed in `<file>` instead of commandline args. If - `<file>` is exactly `-` then standard input is used. Pathspec - elements are separated by LF or CR/LF. Pathspec elements can be +`--overlay`:: +`--no-overlay`:: + In overlay mode, never remove files when restoring. In no-overlay mode, + remove tracked files that do not appear in the `--source` tree, to make + them match _<tree>_ exactly. The default is no-overlay mode. + +`--pathspec-from-file=<file>`:: + Pathspec is passed in _<file>_ instead of commandline args. If + _<file>_ is exactly `-` 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 `core.quotePath` (see linkgit:git-config[1]). See also `--pathspec-file-nul` and global `--literal-pathspecs`. ---pathspec-file-nul:: +`--pathspec-file-nul`:: Only meaningful with `--pathspec-from-file`. Pathspec elements are - separated with NUL character and all other characters are taken + separated with _NUL_ character and all other characters are taken literally (including newlines and quotes). -\--:: +`--`:: Do not interpret any more arguments as options. -<pathspec>...:: +`<pathspec>...`:: Limits the paths affected by the operation. + For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
@@ -154,7 +153,7 @@ EXAMPLES -------- The following sequence switches to the `master` branch, reverts the -`Makefile` to two revisions back, deletes hello.c by mistake, and gets +`Makefile` to two revisions back, deletes `hello.c` by mistake, and gets it back from the index. ------------
@@ -165,7 +164,7 @@ $ git restore hello.c <2> ------------ <1> take a file out of another commit -<2> restore hello.c from the index +<2> restore `hello.c` from the index If you want to restore _all_ C source files to match the version in the index, you can say
base-commit: 1b4e9a5f8b5f048972c21fe8acafe0404096f694
Signature · 1 line
gitgitgadget
Quoted 4 lines · Jean-Noël Avila via GitGitGadget
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
The git-restore manpage was converted to the new documentation format:
Commit messages should typically use imperative style, as if asking the code to change. For example:
Convert the git-restore(1) man page to our new documentation format. This includes the following conversions:
- Switch the synopsis to a 'synopsis' block, which will automatically format placeholders in italics and keywords in monospace.
- Use _<placeholder>_ instead of <placeholder> in the description.
- Use backticks for keywords and more complex option descriptions. The new rendering engine will apply synopsis rules to these spans.
Quoted 5 lines
Documentation/git-restore.txt +0
-0
Documentation/git-restore.txt OPTIONS · line 46
Quoted 9 lines
Documentation/git-restore.txt +3
-3@@ -41,79 +41,79 @@ OPTIONS If not specified, the contents are restored from `HEAD` if `--staged` is given, otherwise from the index. + -As a special case, you may use `"A...B"` as a shortcut for the -merge base of `A` and `B` if there is exactly one merge base. You can -leave out at most one of `A` and `B`, in which case it defaults to `HEAD`. +As a special case, you may use `"<refA>...<refB>"` as a shortcut for the +merge base of _<refA>_ and _<refB>_ if there is exactly one merge base. You can +leave out at most one of _<refA>__ and _<refB>_, in which case it defaults to `HEAD`.
This change is a bit surprising to me though. Why was this renamed from A and B to refA and refB, respectively? It should be possible for these to be object IDs and not refs.
Quoted 15 lines
Documentation/git-restore.txt +0
-11@@ -122,30 +122,29 @@ in linkgit:git-checkout[1] for details. not be updated. Just like linkgit:git-checkout[1], this will detach `HEAD` of the submodule. ---overlay:: ---no-overlay:: - In overlay mode, the command never removes files when - restoring. In no-overlay mode, tracked files that do not - appear in the `--source` tree are removed, to make them match - `<tree>` exactly. The default is no-overlay mode. - ---pathspec-from-file=<file>:: - Pathspec is passed in `<file>` instead of commandline args. If - `<file>` is exactly `-` then standard input is used. Pathspec - elements are separated by LF or CR/LF. Pathspec elements can be
Documentation/git-restore.txt in linkgit:git-checkout[1] for details. · line 134
Quoted 10 lines
Documentation/git-restore.txt +10
-0+`--overlay`:: +`--no-overlay`:: + In overlay mode, never remove files when restoring. In no-overlay mode, + remove tracked files that do not appear in the `--source` tree, to make + them match _<tree>_ exactly. The default is no-overlay mode. + +`--pathspec-from-file=<file>`:: + Pathspec is passed in _<file>_ instead of commandline args. If + _<file>_ is exactly `-` then standard input is used. Pathspec + elements are separated by _LF_ or _CR_/_LF_. Pathspec elements can be
The reflowing of these paragraphs makes it a bit hard to see what exactly is changing.
Thanks!
Patrick
Quoted 1 line · On Monday, 6 January 2025 07:48:27 CET Patrick Steinhardt wrote:
On Sat, Jan 04, 2025 at 01:16:40PM +0000, Jean-Noël Avila via GitGitGadget
Quoted 15 lines · wrote:
Quoted 4 lines
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
The git-restore manpage was converted to the new documentation format:
Commit messages should typically use imperative style, as if asking the code to change. For example:
Convert the git-restore(1) man page to our new documentation format. This includes the following conversions:
- Switch the synopsis to a 'synopsis' block, which will automatically format placeholders in italics and keywords in monospace.
Quoted 6 lines
- Use
_<placeholder>_instead of<placeholder>in the description.- Use backticks for keywords and more complex option descriptions. The new rendering engine will apply synopsis rules to these spans.
Will do.
Quoted 11 lines
Documentation/git-restore.txt OPTIONS · line 46
Quoted 11 lines
Documentation/git-restore.txt +0
-3@@ -41,79 +41,79 @@ OPTIONS If not specified, the contents are restored from `HEAD` if `--staged` is given, otherwise from the index. + -As a special case, you may use `"A...B"` as a shortcut for the -merge base of `A` and `B` if there is exactly one merge base. You can -leave out at most one of `A` and `B`, in which case it defaults to
HEAD.
Quoted 2 lines
Documentation/git-restore.txt OPTIONS · line 45
Quoted 2 lines
Documentation/git-restore.txt +2
-0+As a special case, you may use `"<refA>...<refB>"` as a shortcut for the +merge base of _<refA>_ and _<refB>_ if there is exactly one merge base.
You can
Quoted 1 line
Documentation/git-restore.txt OPTIONS · line 46
Quoted 1 line
Documentation/git-restore.txt +1
-0+leave out at most one of _<refA>__ and _<refB>_, in which case it
defaults to HEAD.
Quoted 4 lines
This change is a bit surprising to me though. Why was this renamed from A and B to refA and refB, respectively? It should be possible for these to be object IDs and not refs.
Sorry for mixing things up revs with refs. The "A" and "B" are just placeholders for revisions, and their names need to be more informative.
So, it should be <rev-A> and <rev-B> all along.
Quoted 3 lines
Documentation/git-restore.txt in linkgit:git-checkout[1] for details. · line 122
Quoted 3 lines
Documentation/git-restore.txt +0
-0@@ -122,30 +122,29 @@ in linkgit:git-checkout[1] for details. not be updated. Just like linkgit:git-checkout[1], this will
detach
Quoted 16 lines
Quoted 6 lines
Documentation/git-restore.txt +0
-4`HEAD` of the submodule. ---overlay:: ---no-overlay:: - In overlay mode, the command never removes files when - restoring. In no-overlay mode, tracked files that do notDocumentation/git-restore.txt in linkgit:git-checkout[1] for details.
Quoted 10 lines
Documentation/git-restore.txt +3
-7- appear in the `--source` tree are removed, to make them match - `<tree>` exactly. The default is no-overlay mode. - ---pathspec-from-file=<file>:: - Pathspec is passed in `<file>` instead of commandline args. If - `<file>` is exactly `-` then standard input is used. Pathspec - elements are separated by LF or CR/LF. Pathspec elements can be +`--overlay`:: +`--no-overlay`:: + In overlay mode, never remove files when restoring. In no-overlay
mode,
Quoted 1 line
Documentation/git-restore.txt in linkgit:git-checkout[1] for details. · line 128
Quoted 1 line
Documentation/git-restore.txt +1
-0+ remove tracked files that do not appear in the `--source` tree, to
make
Quoted 6 lines
Documentation/git-restore.txt in linkgit:git-checkout[1] for details.
Quoted 6 lines
Documentation/git-restore.txt +6
-0+ them match _<tree>_ exactly. The default is no-overlay mode. + +`--pathspec-from-file=<file>`:: + Pathspec is passed in _<file>_ instead of commandline args. If + _<file>_ is exactly `-` then standard input is used. Pathspec + elements are separated by _LF_ or _CR_/_LF_. Pathspec elements can
be
Quoted 4 lines
The reflowing of these paragraphs makes it a bit hard to see what exactly is changing.
For the first set of options, there is a conversion to imperative mood, and I triggered a reflow.
For the second one, it just appears that all lines are slightly changed by
the new formatting.
More generally, I kept reflowing the paragraphs to maintain the width, because this was done everywhere before, but I would strongly prefer having each sentence on separate line, regardless of its length. For asciidoc texts, this policy has some advantages:
* keep a lexical entity as a single line, and get rid messed up diffs due to
reflowing.
* unfortunate automatic reflows can create errors, for instance when a part of
text is sent to the beginning of line and is interpreted as a list item.
JN
PATCH v2 1/1 doc: convert git-restore to new style format
In reply to Jean-Noël Avila via GitGitGadgetFrom: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
- Switch the synopsis to a 'synopsis' block which will automatically format placeholders in italics and keywords in monospace
- Use _<placeholder>_ instead of <placeholder> in the description
- Use backticks for keywords and more complex option descriptions. The new rendering engine will apply synopsis rules to these spans.
While at it, also convert an option description to imperative mood.
---
doc: git-restore: migrate to new style format
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1847%2Fjnavila%2Fdoc-git-restore-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1847/jnavila/doc-git-restore-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/1847
Range-diff vs v1:
1: 424ddb959ff ! 1: 69c01f08852 doc: git-restore: migrate to new style format
@@ Metadata
Author: Jean-Noël Avila <[email protected]>
## Commit message ##
- doc: git-restore: migrate to new style format
+ doc: convert git-restore to new style format
- The git-restore manpage was converted to the new documentation
- format:
-
- - switching the synopsis to a 'synopsis' block which will
+ - Switch the synopsis to a 'synopsis' block which will
automatically format placeholders in italics and keywords in monospace
- - use _<placeholder>_ instead of <placeholder> in the description
- - use `backticks for keywords and more complex option
- descriptions`. The new rendering engine will apply synopsis rules to
+
+ - Use _<placeholder>_ instead of <placeholder> in the description
+
+ - Use backticks for keywords and more complex option
+ descriptions. The new rendering engine will apply synopsis rules to
these spans.
+ While at it, also convert an option description to imperative mood.
+
## Documentation/git-restore.txt ##
@@ Documentation/git-restore.txt: OPTIONS
-As a special case, you may use "A...B" as a shortcut for the
-merge base of A and B if there is exactly one merge base. You can -leave out at most one of A and B, in which case it defaults to HEAD.
-+As a special case, you may use "<refA>...<refB>" as a shortcut for the -+merge base of _<refA>_ and _<refB>_ if there is exactly one merge base. You can -+leave out at most one of _<refA>__ and _<refB>_, in which case it defaults to HEAD. ++As a special case, you may use "<rev-A>...<rev-B>" as a shortcut for the ++merge base of _<rev-A>_ and _<rev-B>_ if there is exactly one merge base. You can ++leave out at most one of _<rev-A>__ and _<rev-B>_, in which case it defaults to HEAD.
--p::
---patch::
@@ Documentation/git-restore.txt: in linkgit:git-checkout[1] for details.
+--overlay::
+--no-overlay::
+ In overlay mode, never remove files when restoring. In no-overlay mode,
-+ remove tracked files that do not appear in the --source tree, to make
-+ them match _<tree>_ exactly. The default is no-overlay mode.
++ remove tracked files that do not appear in the _<tree>_ of
++ --source=<tree>, to make them match _<tree>_ exactly. The default
++ is no-overlay mode.
+
+--pathspec-from-file=<file>::
+ Pathspec is passed in _<file>_ instead of commandline args. If
Documentation/git-restore.txt | 110 +++++++++++++++++----------------- 1 file changed, 55 insertions(+), 55 deletions(-)
Documentation/git-restore.txt +55 -55
@@ -7,10 +7,10 @@ git-restore - Restore working tree files SYNOPSIS -------- -[verse] -'git restore' [<options>] [--source=<tree>] [--staged] [--worktree] [--] <pathspec>... -'git restore' [<options>] [--source=<tree>] [--staged] [--worktree] --pathspec-from-file=<file> [--pathspec-file-nul] -'git restore' (-p|--patch) [<options>] [--source=<tree>] [--staged] [--worktree] [--] [<pathspec>...] +[synopsis] +git restore [<options>] [--source=<tree>] [--staged] [--worktree] [--] <pathspec>... +git restore [<options>] [--source=<tree>] [--staged] [--worktree] --pathspec-from-file=<file> [--pathspec-file-nul] +git restore (-p|--patch) [<options>] [--source=<tree>] [--staged] [--worktree] [--] [<pathspec>...] DESCRIPTION -----------
@@ -32,8 +32,8 @@ THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE. OPTIONS ------- --s <tree>:: ---source=<tree>:: +`-s <tree>`:: +`--source=<tree>`:: 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.
@@ -41,79 +41,79 @@ OPTIONS If not specified, the contents are restored from `HEAD` if `--staged` is given, otherwise from the index. + -As a special case, you may use `"A...B"` as a shortcut for the -merge base of `A` and `B` if there is exactly one merge base. You can -leave out at most one of `A` and `B`, in which case it defaults to `HEAD`. +As a special case, you may use `"<rev-A>...<rev-B>"` as a shortcut for the +merge base of _<rev-A>_ and _<rev-B>_ if there is exactly one merge base. You can +leave out at most one of _<rev-A>__ and _<rev-B>_, in which case it defaults to `HEAD`. --p:: ---patch:: +`-p`:: +`--patch`:: Interactively select hunks in the difference between the - restore source and the restore location. See the ``Interactive - Mode'' section of linkgit:git-add[1] to learn how to operate + restore source and the restore location. See the "Interactive + Mode" section of linkgit:git-add[1] to learn how to operate the `--patch` mode. + Note that `--patch` can accept no pathspec and will prompt to restore all modified paths. --W:: ---worktree:: --S:: ---staged:: +`-W`:: +`--worktree`:: +`-S`:: +`--staged`:: Specify the restore location. If neither option is specified, by default the working tree is restored. Specifying `--staged` will only restore the index. Specifying both restores both. --q:: ---quiet:: +`-q`:: +`--quiet`:: Quiet, suppress feedback messages. Implies `--no-progress`. ---progress:: ---no-progress:: +`--progress`:: +`--no-progress`:: Progress status is reported on the standard error stream by default when it is attached to a terminal, unless `--quiet` is specified. This flag enables progress reporting even if not attached to a terminal, regardless of `--quiet`. ---ours:: ---theirs:: +`--ours`:: +`--theirs`:: When restoring files in the working tree from the index, use - stage #2 ('ours') or #3 ('theirs') for unmerged paths. + stage #2 (`ours`) or #3 (`theirs`) for unmerged paths. This option cannot be used when checking out paths from a tree-ish (i.e. with the `--source` option). + -Note that during `git rebase` and `git pull --rebase`, 'ours' and -'theirs' may appear swapped. See the explanation of the same options +Note that during `git rebase` and `git pull --rebase`, `ours` and +`theirs` may appear swapped. See the explanation of the same options in linkgit:git-checkout[1] for details. --m:: ---merge:: +`-m`:: +`--merge`:: 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 `--source` option). ---conflict=<style>:: +`--conflict=<style>`:: The same as `--merge` option above, but changes the way the conflicting hunks are presented, overriding the `merge.conflictStyle` configuration variable. Possible values - are "merge" (default), "diff3", and "zdiff3". + are `merge` (default), `diff3`, and `zdiff3`. ---ignore-unmerged:: +`--ignore-unmerged`:: When restoring files on the working tree from the index, do not abort the operation if there are unmerged entries and neither `--ours`, `--theirs`, `--merge` or `--conflict` is specified. Unmerged paths on the working tree are left alone. ---ignore-skip-worktree-bits:: +`--ignore-skip-worktree-bits`:: In sparse checkout mode, the default is to only update entries - matched by `<pathspec>` and sparse patterns in - $GIT_DIR/info/sparse-checkout. This option ignores the sparse + matched by _<pathspec>_ and sparse patterns in + `$GIT_DIR/info/sparse-checkout`. This option ignores the sparse patterns and unconditionally restores any files in - `<pathspec>`. + _<pathspec>_. ---recurse-submodules:: ---no-recurse-submodules:: - If `<pathspec>` names an active submodule and the restore location +`--recurse-submodules`:: +`--no-recurse-submodules`:: + If _<pathspec>_ 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
@@ -122,30 +122,30 @@ in linkgit:git-checkout[1] for details. not be updated. Just like linkgit:git-checkout[1], this will detach `HEAD` of the submodule. ---overlay:: ---no-overlay:: - In overlay mode, the command never removes files when - restoring. In no-overlay mode, tracked files that do not - appear in the `--source` tree are removed, to make them match - `<tree>` exactly. The default is no-overlay mode. - ---pathspec-from-file=<file>:: - Pathspec is passed in `<file>` instead of commandline args. If - `<file>` is exactly `-` then standard input is used. Pathspec - elements are separated by LF or CR/LF. Pathspec elements can be +`--overlay`:: +`--no-overlay`:: + In overlay mode, never remove files when restoring. In no-overlay mode, + remove tracked files that do not appear in the _<tree>_ of + `--source=<tree>`, to make them match _<tree>_ exactly. The default + is no-overlay mode. + +`--pathspec-from-file=<file>`:: + Pathspec is passed in _<file>_ instead of commandline args. If + _<file>_ is exactly `-` 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 `core.quotePath` (see linkgit:git-config[1]). See also `--pathspec-file-nul` and global `--literal-pathspecs`. ---pathspec-file-nul:: +`--pathspec-file-nul`:: Only meaningful with `--pathspec-from-file`. Pathspec elements are - separated with NUL character and all other characters are taken + separated with _NUL_ character and all other characters are taken literally (including newlines and quotes). -\--:: +`--`:: Do not interpret any more arguments as options. -<pathspec>...:: +`<pathspec>...`:: Limits the paths affected by the operation. + For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
@@ -154,7 +154,7 @@ EXAMPLES -------- The following sequence switches to the `master` branch, reverts the -`Makefile` to two revisions back, deletes hello.c by mistake, and gets +`Makefile` to two revisions back, deletes `hello.c` by mistake, and gets it back from the index. ------------
@@ -165,7 +165,7 @@ $ git restore hello.c <2> ------------ <1> take a file out of another commit -<2> restore hello.c from the index +<2> restore `hello.c` from the index If you want to restore _all_ C source files to match the version in the index, you can say
base-commit: 1b4e9a5f8b5f048972c21fe8acafe0404096f694
Signature · 1 line
gitgitgadget