Re: [PATCH] rerere.txt: Document forget subcommand

From: Junio C Hamano <gitster@pobox.com>
Date: Jun 15, 2010, 16:37 UTC
Message-ID: <7vr5k86ylg.fsf@alter.siamese.dyndns.org>
In-Reply-To: <ebd2b2b5bb3352c6204f181416a7a521f8c6abf7.1276582759.git.git@drmicha.warpmail.net>

Michael J Gruber <git@drmicha.warpmail.net> writes:

Show 15 quoted lines

> dea4562 (rerere forget path: forget recorded resolution, 2009-12-25)
> introduced the forget subcommand for rerere.
> ...
> diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt
> index acc220a..a7370d3 100644
> --- a/Documentation/git-rerere.txt
> +++ b/Documentation/git-rerere.txt
> @@ -40,6 +40,10 @@ This resets the metadata used by rerere if a merge resolution is to be
>  aborted.  Calling 'git am [--skip|--abort]' or 'git rebase [--skip|--abort]'
>  will automatically invoke this command.
>  
> +'forget' <pathspec>::
> +
> +This resets the conflict resolutions which rerere has recorded for <pathspec>.
> +

This description is not _incorrect_ per-se, but it does not convey one important aspect of the subcommand; unlike "clear" and "gc", "forget" only works in the context of the _current_ conflict resolution, just like "diff" and "status".

Perhaps s/for <pathspec>/for the current conflict in <pathspec>/ would be a sufficient improvement?