Experimental Physics and
Industrial Control System

Andrew Johnson <[email protected]> · Wed, 18 Aug 2010 13:15:57 -0500

On Wednesday 18 August 2010 10:28:07 Ralph Lange wrote:
>
> I would like to suggest two additions to that guide.

Thanks!

> 1. Prefix the summary line with the area that the commit addresses,
> followed by a colon and a space.
> I would see the area being one out of the directory names below base/src
> - these names are also being used as tags in bug reports. The libcom
> area might need one more identifier to be useful.
>
> Examples
>
> db: Fix off-by-one error in dbGetAddr()
> libcom/timer: Add test for uninit'd user structure

That kind of thing should certainly help with readability so I'm happy to add 
it as a suggestion, although with the proviso that it won't be appropriate for 
all commits.

> 2. The last paragraph of the commit message may be one or more "name:
> value" lines
> Use this to mention any relation to bugs.
>
> Examples
>
> fixes: lp:595240
> related: lp:615916

I would prefer that if possible we use the Bazaar --fixes option for recording 
that a commit fixes a known bug, since Launchpad will pick up on that 
automatically.  I'm not going to object to people adding this kind of 
information as well if they like, but I don't want to make it a rule that we 
have to enforce.

I have added these suggestions to the new Wiki page at
http://www.aps.anl.gov/epics/wiki/index.php/Style_Guide_for_Bazaar_commit_messages

- Andrew
-- 
The best FOSS code is written to be read by other humans -- Harald Welte

Experimental Physics and Industrial Control System

Experimental Physics and
Industrial Control System