X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=Documentation%2Fgit-revert-script.txt;h=9609dcd325062d88871bf91b9642bef61f8f9224;hb=2ab141a26f93c4d97e243a6be8a38a7dd4eb35a3;hp=8a532e6d09306974fb2b8bb32e31e00ed10c0a43;hpb=58eaf287f1b25f6427b06bd72d8e555615828aeb;p=git.git diff --git a/Documentation/git-revert-script.txt b/Documentation/git-revert-script.txt index 8a532e6d..9609dcd3 100644 --- a/Documentation/git-revert-script.txt +++ b/Documentation/git-revert-script.txt @@ -3,25 +3,35 @@ git-revert-script(1) NAME ---- -git-revert-script - Some git command not yet documented. - +git-revert-script - Revert an existing commit. SYNOPSIS -------- -'git-revert-script' [ --option ] ... +'git-revert-script' [-n] DESCRIPTION ----------- -Does something not yet documented. - +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). OPTIONS ------- ---option:: - Some option not yet documented. - -...:: - Some argument not yet documented. +:: + Commit to revert. + +-n:: + 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. + + This is useful when reverting more than one commits' + effect to your working tree in a row. Author