Commit Messages

[Karolin Seeger]

Hi Matthieu,

On Tue, Oct 16, 2012 at 09:10:26PM -0700, Matthieu Patou wrote:
> On 10/15/2012 03:32 AM, Karolin Seeger wrote:
> >Hey folks,
> >
> >please try to write descriptive commit messages, that can be used for
> >release notes. Non-developers should understand what your patch fixes.
> >Additionally, please do include the bug id if possible.
> Do you want the bug id in the short description or anywhere in the 
> commit message ?

that is up to you.

> Any favorite format ?

I think it's perfectly fine to
- include the bug number (I am going to add the url in future),
- describe what exactly does not work for admins without your patch (not
  too technical),
- all your technical details you would like to add.
No certain format requested up to now.

If you are very, very nice to your release manager, you can provide one
line that can be used for the release notes directly.

Example:
-----8<------------------snip--------------8<--------------	
* BUG 8966: Fix 'net rpc share allowedusers' to work with 2008r2.
----->8------------------snap-------------->8--------------

Another example for a good commit message from my point of view:
-----8<------------------snip--------------8<--------------
commit 42d2af97e1a106fc07ed65168652b533bacb9059
Author: Jeremy Allison <jra at samba.org>
Date:   Thu Oct 4 10:56:12 2012 +0200

    Fix net rpc share allowedusers to work with 2008r2
    
    The RAP NetShareEnum command was removed in 2008r2, so use the RPC
equivalent
    instead.
    
    Bug: https://bugzilla.samba.org/show_bug.cgi?id=8966
    Author: Jeremy Allison <jra at samba.org>
    
    Autobuild-User(v4-0-test): Karolin Seeger <kseeger at samba.org>
    Autobuild-Date(v4-0-test): Thu Oct  4 12:41:16 CEST 2012 on
sn-devel-104
----->8------------------snap-------------->8--------------

Thanks!

Cheers,
Karolin

-- 
Samba			http://www.samba.org
SerNet			http://www.sernet.de
sambaXP			http://www.sambaxp.org