Merge branch 'ja/shorthelp'
[git/git.git] / Documentation / git-revert.txt
1 git-revert(1)
2 =============
3
4 NAME
5 ----
6 git-revert - Revert an existing commit
7
8 SYNOPSIS
9 --------
10 'git-revert' [--edit | --no-edit] [-n] <commit>
11
12 DESCRIPTION
13 -----------
14 Given one existing commit, revert the change the patch introduces, and record a
15 new commit that records it. This requires your working tree to be clean (no
16 modifications from the HEAD commit).
17
18 OPTIONS
19 -------
20 <commit>::
21 Commit to revert.
22 For a more complete list of ways to spell commit names, see
23 "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
24
25 -e|--edit::
26 With this option, `git-revert` will let you edit the commit
27 message prior committing the revert. This is the default if
28 you run the command from a terminal.
29
30 --no-edit::
31 With this option, `git-revert` will not start the commit
32 message editor.
33
34 -n|--no-commit::
35 Usually the command automatically creates a commit with
36 a commit log message stating which commit was reverted.
37 This flag applies the change necessary to revert the
38 named commit to your working tree, but does not make the
39 commit. In addition, when this option is used, your
40 working tree does not have to match the HEAD commit.
41 The revert is done against the beginning state of your
42 working tree.
43 +
44 This is useful when reverting more than one commits'
45 effect to your working tree in a row.
46
47
48 Author
49 ------
50 Written by Junio C Hamano <junkio@cox.net>
51
52 Documentation
53 --------------
54 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
55
56 GIT
57 ---
58 Part of the gitlink:git[7] suite