[Frugalware-devel] about multiline long comments

[Krisztian VASAS]

On Tue Jun 05, 2007 at 16:27:46 +0100, Alex Smith wrote:
>VMiklos wrote:
>>hi,
>>almost every dev has its own style regarding multiline long comments
>>Alex:
>>Sun Jun  3 16:19:13 CEST 2007  AlexExtreme <alex at alex-smith.me.uk>
>>  * gedit-2.18.1-2-i686
>>   * Removed unnecessary eel depend (closes #2109)
>>(prefix: ' * ')
>>krix:
>>Sun Jun  3 15:30:02 CEST 2007  Christian Hamar alias krix <krics at linuxforum.hu>
>>  * imagemagick-6.3.4_5-1-x86_64
>>    * Version bump
>>(prefix: '  * ')
>>crazy:
>>Sun Jun  3 13:45:51 CEST 2007  crazy <crazy at frugalware.org>
>>  * php-5.2.3-2-i686
>>  * fixes for SMP builds , make is fine with SMP just make install is
>>  * broken
>>  * fixed php-cgi , reported by janny
>>(prefix: '* ')
>>ironiq:
>>Tue May 29 16:00:28 CEST 2007  Krisztian VASAS <iron at frugalware.org>
>>  * rrdtool-1.2.23-1-i686
>>  - version bump
>>(prefix: '- ')
>>myself:
>>Sun Jun  3 13:33:07 CEST 2007  VMiklos <vmiklos at frugalware.org>
>>  * glibc-2.6-3-i686
>>  rebuilt using --enable-kernel=2.6.0
>>  closes #2104
>>(no prefix)
>>what should we do with these? is this mess ok? ;) or do we want to force
>>some standard? opinions? :)
>>i would wote for standardization, maybe krix's or ironiq's version, but
>>i'm not sure
>
>Personally I think it's a good idea, since (AFAIK) the changelog is generated from the darcs changes, so having a standard prefix would make the ChangeLog 
>more consistent. *IMO* my one is good because I don't think having no prefix makes sense since darcs automatically prepends a * to the short comment, and 
>an indented * fits with the style from darcs.

IMHO only the first line should contain '*', the others should contain any
other char, just for the better reading.


IroNiQ
-- 
Member of Frugalware Developer Team
Web: http://www.ironiq.hu
LinuxCounter: #331532
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
Url : /pipermail/attachments/20070605/ebe2f859/attachment.bin