[PATCH 1 of 2] Abstract the functionality of calling an editor into the 'edit' function to prevent

[Steve Borho]

On Sat, Apr 3, 2010 at 4:33 PM, Benoit Boissinot <bboissin at gmail.com> wrote:
> On Sun, Apr 4, 2010 at 12:03 AM, Mads Kiilerich <mads at kiilerich.com> wrote:
>> Itamar Ravid wrote, On 04/03/2010 05:17 PM:
>>>
>>> # HG changeset patch
>>> # User Itamar Ravid<iravid at iravid.com>
>>> # Date 1270307531 -10800
>>> # Node ID 2272a05026eb11f2d52067606729df6d86f18627
>>> # Parent  cd0c49bdbfd9edab18c3656d8a8a0bd27a9aa82a
>>> Abstract the functionality of calling an editor into the 'edit' function
>>> to prevent
>>> users from having to mess with the code responsible for generating the
>>> temporary
>>> commit message and diff files.
>>>
>>
>> I don't know where it is documented, but the first line of the commit
>> message is special by convention supported by Mercurial. IIRC it should be a
>> summary of the change, no more than 80 characters, and preferable prefixed
>> with (in this case) "hgeditor:".
>>
>> [crew: Should the exact guideline (whatever it is) be added to
>> ContributingChanges? (Perhaps together with some advice of content and
>> language)]
>
> I remember reading very good guidelines from Matt at some point,
> explaining how to write a commit message in a meaningful way. Sadly I
> can't find it (maybe it was on IRC?).

The TortoiseHg developer wiki [1] has a nice link back to the
Mercurial Wiki [2].

1 - http://bitbucket.org/tortoisehg/stable/wiki/developers/contributing
2 - http://www.selenic.com/mercurial/wiki/index.cgi/SuccessfulPatch

Though the hg wiki page doesn't describe the commit message conventions.

--
Steve Borho