On commit messages... again

IOhannes m zmölnig zmoelnig at iem.at
Sat Jan 8 14:33:13 UTC 2011


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 01/08/2011 03:19 PM, Jonas Smedegaard wrote:
> On Sat, Jan 08, 2011 at 03:04:55PM +0100, IOhannes m zmölnig wrote:
>> On 01/08/2011 01:05 AM, Felipe Sateler wrote:
>>> Please, be descriptive in the commit messages. A commit message
>>> saying "add libblah-dev as build-depends" is not really useful, as we
>>> can see that from the patch. The point of commit messages is to
>>> explain why the changes are necessary (eg, "Enable support for doing
>>> something, needs libblah").
>>
>> hmm, 2 remarks on that:
>> - - given that git-dch _could_ be used to generate the changelog i would
>> recommend to put the description you want to see in debian/changelog as
>> the "title" (1st line) of the patch
>>
>> - - everything else (e.g why you think it is good and necessary to do
>> what
>> you have done, what you think might be done once there is time and why
>> and everything) ought to be in the "body" (line3-EOF (with line2 being
>> empty)) of the commit message
> 
> As a minimum, I agree.
> 
> Preferrably, though, even the first line (i.e. the changelog entry)
> include tiny explanation too IMO.


right

i did not try to say that one shouldn't include a tiny explanation in
the first line. i was more trying to stress, that the 1st line should be
useable as a changelog entry.

i also think that changelog entries should contain interesting information.

dfsgmt
IOhannes
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.10 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk0odakACgkQkX2Xpv6ydvQVFQCfYYi/k+xNEoiwR/L65E0k2rxn
Ao4AnRvlaoK7V/0GPSDlWn9DyL1f3Xkz
=mnx/
-----END PGP SIGNATURE-----



More information about the pkg-multimedia-maintainers mailing list