]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: reset: synchronize <pathspec> description
authorAlexandr Miloslavskiy <alexandr.miloslavskiy@syntevo.com>
Tue, 19 Nov 2019 16:48:52 +0000 (16:48 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 20 Nov 2019 04:01:53 +0000 (13:01 +0900)
`git add` shows an example of good writing, follow it.

Signed-off-by: Alexandr Miloslavskiy <alexandr.miloslavskiy@syntevo.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-reset.txt
builtin/reset.c

index 97e0544d9e1e171d60a4d413b60df88884ed233f..d517a43e738bb98f7db4e926d9e53443a71a35c9 100644 (file)
@@ -8,8 +8,8 @@ git-reset - Reset current HEAD to the specified state
 SYNOPSIS
 --------
 [verse]
-'git reset' [-q] [<tree-ish>] [--] <paths>...
-'git reset' (--patch | -p) [<tree-ish>] [--] [<paths>...]
+'git reset' [-q] [<tree-ish>] [--] <pathspec>...
+'git reset' (--patch | -p) [<tree-ish>] [--] [<pathspec>...]
 'git reset' [--soft | --mixed [-N] | --hard | --merge | --keep] [-q] [<commit>]
 
 DESCRIPTION
@@ -19,23 +19,23 @@ In the third form, set the current branch head (`HEAD`) to `<commit>`,
 optionally modifying index and working tree to match.
 The `<tree-ish>`/`<commit>` defaults to `HEAD` in all forms.
 
-'git reset' [-q] [<tree-ish>] [--] <paths>...::
-       This form resets the index entries for all `<paths>` to their
-       state at `<tree-ish>`.  (It does not affect the working tree or
-       the current branch.)
+'git reset' [-q] [<tree-ish>] [--] <pathspec>...::
+       This form resets the index entries for all paths that match the
+       `<pathspec>` to their state at `<tree-ish>`.  (It does not affect
+       the working tree or the current branch.)
 +
-This means that `git reset <paths>` is the opposite of `git add
-<paths>`. This command is equivalent to
-`git restore [--source=<tree-ish>] --staged <paths>...`.
+This means that `git reset <pathspec>` is the opposite of `git add
+<pathspec>`. This command is equivalent to
+`git restore [--source=<tree-ish>] --staged <pathspec>...`.
 +
-After running `git reset <paths>` to update the index entry, you can
+After running `git reset <pathspec>` to update the index entry, you can
 use linkgit:git-restore[1] to check the contents out of the index to
 the working tree. Alternatively, using linkgit:git-restore[1]
 and specifying a commit with `--source`, you
 can copy the contents of a path out of a commit to the index and to the
 working tree in one go.
 
-'git reset' (--patch | -p) [<tree-ish>] [--] [<paths>...]::
+'git reset' (--patch | -p) [<tree-ish>] [--] [<pathspec>...]::
        Interactively select hunks in the difference between the index
        and `<tree-ish>` (defaults to `HEAD`).  The chosen hunks are applied
        in reverse to the index.
@@ -101,6 +101,13 @@ OPTIONS
        `reset.quiet` config option. `--quiet` and `--no-quiet` will
        override the default behavior.
 
+\--::
+       Do not interpret any more arguments as options.
+
+<pathspec>...::
+       Limits the paths affected by the operation.
++
+For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
 
 EXAMPLES
 --------
index fdd572168b51cc388a098008c3636ffa60856233..9291c0fd726c540ed5643d1e408beffc44165824 100644 (file)
@@ -30,8 +30,8 @@
 
 static const char * const git_reset_usage[] = {
        N_("git reset [--mixed | --soft | --hard | --merge | --keep] [-q] [<commit>]"),
-       N_("git reset [-q] [<tree-ish>] [--] <paths>..."),
-       N_("git reset --patch [<tree-ish>] [--] [<paths>...]"),
+       N_("git reset [-q] [<tree-ish>] [--] <pathspec>..."),
+       N_("git reset --patch [<tree-ish>] [--] [<pathspec>...]"),
        NULL
 };