X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-revert.txt;h=98cfa3c0d0f27e0cb603f07c76285f85ef07a771;hb=04bb50f45dda9aeb755e943cbc9df264cfc8cbc5;hp=13ceabbcc8851344e54e13773a2a553360f931c4;hpb=1fe82d609f9a6ec146fa39880a04e11eb5275810;p=git.git diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index 13ceabbcc..98cfa3c0d 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -7,7 +7,7 @@ git-revert - Revert an existing commit SYNOPSIS -------- -'git-revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] +'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] DESCRIPTION ----------- @@ -22,12 +22,14 @@ OPTIONS For a more complete list of ways to spell commit names, see "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. --e|--edit:: - With this option, `git-revert` will let you edit the commit +-e:: +--edit:: + With this option, 'git-revert' will let you edit the commit message prior to committing the revert. This is the default if you run the command from a terminal. --m parent-number|--mainline parent-number:: +-m parent-number:: +--mainline parent-number:: Usually you cannot revert a merge because you do not know which side of the merge should be considered the mainline. This option specifies the parent number (starting from 1) of @@ -35,29 +37,31 @@ OPTIONS relative to the specified parent. --no-edit:: - With this option, `git-revert` will not start the commit + With this option, 'git-revert' will not start the commit message editor. --n|--no-commit:: +-n:: +--no-commit:: Usually the command automatically creates a commit with - a commit log message stating which commit was reverted. - This flag applies the change necessary to revert the - named commit to your working tree, but does not make the - commit. In addition, when this option is used, your - working tree does not have to match the HEAD commit. - The revert is done against the beginning state of your - working tree. + a commit log message stating which commit was + reverted. This flag applies the change necessary + to revert the named commit to your working tree + and the index, but does not make the commit. In addition, + when this option is used, your index does not have to match + the HEAD commit. The revert is done against the + beginning state of your index. + This is useful when reverting more than one commits' -effect to your working tree in a row. +effect to your index in a row. --s|--signoff:: +-s:: +--signoff:: Add Signed-off-by line at the end of the commit message. Author ------ -Written by Junio C Hamano +Written by Junio C Hamano Documentation -------------- @@ -65,4 +69,4 @@ Documentation by Junio C Hamano and the git-list . GIT --- -Part of the linkgit:git[7] suite +Part of the linkgit:git[1] suite