[PATCH] commit: explain basics in help text

Adrian Buehlmann adrian at cadifra.com
Fri Jul 20 04:15:24 CDT 2012


On 2012-07-19 01:06, Matt Mackall wrote:
>> diff --git a/mercurial/commands.py b/mercurial/commands.py
>> --- a/mercurial/commands.py
>> +++ b/mercurial/commands.py
>> @@ -1221,6 +1221,23 @@
>>      centralized SCM, this operation is a local operation. See
>>      :hg:`push` for a way to actively distribute your changes.
>>  
>> +    Commit creates a new changeset which gets the parent revision of
>> +    the working directory as its parent changeset, or two parent
>> +    revisions, if the working directory contains an uncommitted merge
>> +    (use :hg:`parents` to see the parent revisions).
> 
> This probably wants to be the first paragraph and can probably be
> simplified by using "parent revision(s)" or similar. [..]

Would you be able to make a proposal for your preferred wording of this
part?

I feel it isn't effective if we continue to try to tackle this in
another of our try and error loops (me sending a N patches, you writing
N patch comments).

The comment you wrote above is almost the length of the help text it
comments itself. Wouldn't it be more effective if you would write the
preferred help text directly?

(I propose we leave away the reference to "hg parents" or "hg summary"
for a first patch.)




More information about the Mercurial-devel mailing list