Re: [PATCH] Documentation/git-commit: rewrite to make it more end-user friendly.

From: Jakub Narebski <jnareb@gmail.com>
Date: Dec 9, 2006, 22:05 UTC
Message-ID: <elfbq4$tka$1@sea.gmane.org>
In-Reply-To: <7vpsas91e5.fsf@assigned-by-dhcp.cox.net>

Junio C Hamano wrote:

> Nicolas Pitre <nico@cam.org> writes:

Show 15 quoted lines

>>>  -o|--only::
>>> -   Commit only the files specified on the command line.
>>> -   This format cannot be used during a merge, nor when the
>>> -   index and the latest commit does not match on the
>>> -   specified paths to avoid confusion.
>>> +   Commit only the files specified on the command line;
>>> +   this is the default when pathnames are given on the
>>> +   command line, so you usually do not have to give this
>>> +   option.  This format cannot be used during a merge.
>>
>> Is there some value in keeping this option documented?  What about 
>> removing it (the documentation not the option)?
> 
> True, although the description of <files>... need to be
> clarified if we do this.

I'm a bit uncomfortable about removing documentation to existing (if no-op) option. I'd rather it stay.

-- 
Jakub Narebski
Warsaw, Poland
ShadeHawk on #git