From: Antriksh Pany <antriksh.pany@gmail.com>
Date: Tue, 01 Jun 2010 13:28:57 GMT
Subject: Re: [PATCH 8/8] Documentation/revert: describe passing more than one commit
Message-ID: <AANLkTilu8C68FlLkNg_3wEjRRX25TaydZCve_P4r4_X7@mail.gmail.com>
In-Reply-To: <20100531194240.28729.15284.chriscool@tuxfamily.org>

On Mon, May 31, 2010 at 8:42 PM, Christian Couder
<chriscool@tuxfamily.org> wrote:
> And while at it, add an "Examples" section.
>
> Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
> ---
>  Documentation/git-revert.txt |   52 ++++++++++++++++++++++++++++-------------
>  1 files changed, 35 insertions(+), 17 deletions(-)
>
> diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
> index c66bf80..5740f37 100644
> --- a/Documentation/git-revert.txt
> +++ b/Documentation/git-revert.txt
> @@ -3,20 +3,22 @@ git-revert(1)
>
>  NAME
>  ----
> -git-revert - Revert an existing commit
> +git-revert - Revert some existing commits
>
>  SYNOPSIS
>  --------
> -'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] <commit>
> +'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] <commit>...
>
>  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
> -effect of an earlier commit (often a faulty one).  If you want to
> +Given one or more existing commits, revert the changes that the
> +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
>  should see linkgit:git-reset[1], particularly the '--hard' option.  If
>  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
>  -------
> -<commit>::
> -       Commit to revert.
> +<commit>...::
> +       Commits to revert.
>        For a more complete list of ways to spell commit names, see
>        "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::
>  --edit::
> @@ -59,14 +64,13 @@ more details.
>
>  -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
> -       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.
> +       Usually the command automatically creates some commits with
> +       commit log messages stating which commits were reverted.  This
> +       flag applies the changes necessary to revert the named commits
> +       to your working tree and the index, but does not make the
> +       commits.  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 index in a row.
> @@ -75,6 +79,20 @@ effect to your index in a row.
>  --signoff::
>        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::

Is the backslash correct?

> +
> +       Revert the changes done by commits from the fiveth last commit

'fifth' instead of 'fiveth' may be more appropriate :)

> +       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
>  ------
> --
> 1.7.1.361.g42de.dirty
>
> --
> To unsubscribe from this list: send the line "unsubscribe git" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
>