Skip to content

Commit bf44142

Browse files
martinvonzgitster
authored andcommitted
reset: update documentation to require only tree-ish with paths
When resetting with paths, we no longer require a commit argument, but only a tree-ish. Update the documentation and synopsis accordingly. Signed-off-by: Martin von Zweigbergk <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 3fde386 commit bf44142

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

Documentation/git-reset.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ git-reset - Reset current HEAD to the specified state
88
SYNOPSIS
99
--------
1010
[verse]
11-
'git reset' [-q] [<commit>] [--] <paths>...
12-
'git reset' (--patch | -p) [<commit>] [--] [<paths>...]
11+
'git reset' [-q] [<tree-ish>] [--] <paths>...
12+
'git reset' (--patch | -p) [<tree-sh>] [--] [<paths>...]
1313
'git reset' [--soft | --mixed | --hard | --merge | --keep] [-q] [<commit>]
1414

1515
DESCRIPTION
1616
-----------
17-
In the first and second form, copy entries from <commit> to the index.
17+
In the first and second form, copy entries from <tree-ish> to the index.
1818
In the third form, set the current branch head (HEAD) to <commit>, optionally
19-
modifying index and working tree to match. The <commit> defaults to HEAD
20-
in all forms.
19+
modifying index and working tree to match. The <tree-ish>/<commit> defaults
20+
to HEAD in all forms.
2121

22-
'git reset' [-q] [<commit>] [--] <paths>...::
22+
'git reset' [-q] [<tree-ish>] [--] <paths>...::
2323
This form resets the index entries for all <paths> to their
24-
state at <commit>. (It does not affect the working tree, nor
24+
state at <tree-ish>. (It does not affect the working tree, nor
2525
the current branch.)
2626
+
2727
This means that `git reset <paths>` is the opposite of `git add
@@ -34,9 +34,9 @@ Alternatively, using linkgit:git-checkout[1] and specifying a commit, you
3434
can copy the contents of a path out of a commit to the index and to the
3535
working tree in one go.
3636

37-
'git reset' (--patch | -p) [<commit>] [--] [<paths>...]::
37+
'git reset' (--patch | -p) [<tree-ish>] [--] [<paths>...]::
3838
Interactively select hunks in the difference between the index
39-
and <commit> (defaults to HEAD). The chosen hunks are applied
39+
and <tree-ish> (defaults to HEAD). The chosen hunks are applied
4040
in reverse to the index.
4141
+
4242
This means that `git reset -p` is the opposite of `git add -p`, i.e.

builtin/reset.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323

2424
static const char * const git_reset_usage[] = {
2525
N_("git reset [--mixed | --soft | --hard | --merge | --keep] [-q] [<commit>]"),
26-
N_("git reset [-q] <commit> [--] <paths>..."),
27-
N_("git reset --patch [<commit>] [--] [<paths>...]"),
26+
N_("git reset [-q] <tree-ish> [--] <paths>..."),
27+
N_("git reset --patch [<tree-ish>] [--] [<paths>...]"),
2828
NULL
2929
};
3030

0 commit comments

Comments
 (0)