Documentation/revert: describe passing more than one commit
And while at it, add an "EXAMPLES" section. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>maint
parent
89d32d33ae
commit
86c7bb47c7
|
@ -3,20 +3,22 @@ git-revert(1)
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
git-revert - Revert an existing commit
|
git-revert - Revert some existing commits
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] <commit>
|
'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] <commit>...
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Given one existing commit, revert the change the patch introduces, and record a
|
|
||||||
new commit that records it. This requires your working tree to be clean (no
|
|
||||||
modifications from the HEAD commit).
|
|
||||||
|
|
||||||
Note: 'git revert' is used to record a new commit to reverse the
|
Given one or more existing commits, revert the changes that the
|
||||||
effect of an earlier commit (often a faulty one). If you want to
|
related patches introduce, and record some new commits that record
|
||||||
|
them. This requires your working tree to be clean (no modifications
|
||||||
|
from the HEAD commit).
|
||||||
|
|
||||||
|
Note: 'git revert' is used to record some new commits to reverse the
|
||||||
|
effect of some earlier commits (often only a faulty one). If you want to
|
||||||
throw away all uncommitted changes in your working directory, you
|
throw away all uncommitted changes in your working directory, you
|
||||||
should see linkgit:git-reset[1], particularly the '--hard' option. If
|
should see linkgit:git-reset[1], particularly the '--hard' option. If
|
||||||
you want to extract specific files as they were in another commit, you
|
you want to extract specific files as they were in another commit, you
|
||||||
|
@ -26,10 +28,13 @@ both will discard uncommitted changes in your working directory.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
<commit>::
|
<commit>...::
|
||||||
Commit to revert.
|
Commits to revert.
|
||||||
For a more complete list of ways to spell commit names, see
|
For a more complete list of ways to spell commit names, see
|
||||||
"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
|
"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
|
||||||
|
Sets of commits can also be given but no traversal is done by
|
||||||
|
default, see linkgit:git-rev-list[1] and its '--no-walk'
|
||||||
|
option.
|
||||||
|
|
||||||
-e::
|
-e::
|
||||||
--edit::
|
--edit::
|
||||||
|
@ -59,11 +64,11 @@ more details.
|
||||||
|
|
||||||
-n::
|
-n::
|
||||||
--no-commit::
|
--no-commit::
|
||||||
Usually the command automatically creates a commit with
|
Usually the command automatically creates some commits with
|
||||||
a commit log message stating which commit was
|
commit log messages stating which commits were
|
||||||
reverted. This flag applies the change necessary
|
reverted. This flag applies the changes necessary
|
||||||
to revert the named commit to your working tree
|
to revert the named commits to your working tree
|
||||||
and the index, but does not make the commit. In addition,
|
and the index, but does not make the commits. In addition,
|
||||||
when this option is used, your index does not have to match
|
when this option is used, your index does not have to match
|
||||||
the HEAD commit. The revert is done against the
|
the HEAD commit. The revert is done against the
|
||||||
beginning state of your index.
|
beginning state of your index.
|
||||||
|
@ -75,6 +80,20 @@ effect to your index in a row.
|
||||||
--signoff::
|
--signoff::
|
||||||
Add Signed-off-by line at the end of the commit message.
|
Add Signed-off-by line at the end of the commit message.
|
||||||
|
|
||||||
|
EXAMPLES
|
||||||
|
--------
|
||||||
|
git revert HEAD~3::
|
||||||
|
|
||||||
|
Revert the changes specified by the fourth last commit in HEAD
|
||||||
|
and create a new commit with the reverted changes.
|
||||||
|
|
||||||
|
git revert -n master\~5..master~2::
|
||||||
|
|
||||||
|
Revert the changes done by commits from the fifth last commit
|
||||||
|
in master (included) to the third last commit in master
|
||||||
|
(included), but do not create any commit with the reverted
|
||||||
|
changes. The revert only modifies the working tree and the
|
||||||
|
index.
|
||||||
|
|
||||||
Author
|
Author
|
||||||
------
|
------
|
||||||
|
@ -84,6 +103,10 @@ Documentation
|
||||||
--------------
|
--------------
|
||||||
Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
|
Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
linkgit:git-cherry-pick[1]
|
||||||
|
|
||||||
GIT
|
GIT
|
||||||
---
|
---
|
||||||
Part of the linkgit:git[1] suite
|
Part of the linkgit:git[1] suite
|
||||||
|
|
Loading…
Reference in New Issue