Re: [PATCH] Documentation/git-rerere: document 'remaining' command

[Phil Hord <phil.hord@gmail.com>]

On Tue, Mar 6, 2012 at 2:24 PM, Junio C Hamano <gitster@pobox.com> wrote:
> Vincent van Ravesteijn <vfr@lyx.org> writes:
>
>> From: Vincent van Ravesteijn <vfr@lyx.org>
>>
>> This adds the 'remaining' command to the documentation of
>> 'git rerere'. This command was added in ac49f5ca (Feb 16 2011;
>> Martin von Zweigbergk <martin.von.zweigbergk@gmail.com>) but
>> it was never documented.
>>
>> Signed-off-by: Vincent van Ravesteijn <vfr@lyx.org>
>> ---
>>  Documentation/git-rerere.txt |   10 +++++++++-
>>  1 files changed, 9 insertions(+), 1 deletions(-)
>>
>> diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt
>> index a6253ba..b75d34b 100644
>> --- a/Documentation/git-rerere.txt
>> +++ b/Documentation/git-rerere.txt
>> @@ -8,7 +8,7 @@ git-rerere - Reuse recorded resolution of conflicted merges
>>  SYNOPSIS
>>  --------
>>  [verse]
>> -'git rerere' ['clear'|'forget' <pathspec>|'diff'|'status'|'gc']
>> +'git rerere' ['clear'|'forget' <pathspec>|'diff'|'remaining'|'status'|'gc']
>>
>>  DESCRIPTION
>>  -----------
>> @@ -53,6 +53,14 @@ useful for tracking what has changed while the user is resolving
>>  conflicts.  Additional arguments are passed directly to the system
>>  'diff' command installed in PATH.
>>
>> +'remaining'::
>> +
>> +Like 'diff', but this only prints the unresolved filenames. This
>
[...]
>
>        'remaining'::
>
>        Print paths with conflicts that are not resolved.
>
> Should be sufficient, I think.
>
> In fact, wouldn't this be more or less equivalent to "ls-files -u"
> without anything other than name part?

No.  When using  --no-rerere-autoupdate, git does not add autoresolved
files to the index; it fixes them only in your working directory.
'ls-files -u' still lists them as unresolved.  'rerere remaining' does
not list these autoresolved files.  'mergetool' uses this command to
avoid asking the user to resolve files which git rerere already
resolved for her.

ac49f5ca8 has a pretty complete description, though it may be a bit
too wordy for the the up-front synopsis.
2f59c9470 has a more complete justification.

Phil