bug-parted
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: ChangeLog entry format


From: Harley D. Eades III
Subject: Re: ChangeLog entry format
Date: Sun, 22 Jan 2006 09:14:24 -0600

On Sun, 2006-01-22 at 11:23 +0100, Patrick Leslie Polzer wrote:
> Hello coders,
> 
> I'd like to suggest converting ChangeLog to the format advertised by the
> GNU project.  Relevant passages:
> 
> "Separate unrelated change log entries with blank lines. When two
> entries represent parts of the same change, so that they work together,
> then don't put blank lines between them. Then you can omit the file
> name and the asterisk when successive entries are in the same file." 
> 
> "Break long lists of function names by closing continued lines with `)',
> rather than `,', and opening the continuation with `(' as in this
> example:
> 
>  * keyboard.c (menu_bar_items, tool_bar_items)
> (Fexecute_extended_command): Deal with `keymap' property."
> 
> "When you install someone else's changes, put the contributor's name in
> the change log entry rather than in the text of the entry. In other
> words, write this: 
> 
>  2002-07-14  John Doe  <address@hidden>
> 
>         * sewing.c: Make it sew.
> 
> 
> 
> rather than this: 
> 
>  2002-07-14  Usual Maintainer  <address@hidden>
> 
>         * sewing.c: Make it sew.  Patch by address@hidden"
> 
> 
> 
> Note the format:
> 
> 2002-07-14  Usual Maintainer  <address@hidden>
> 
> <TAB/8spaces>* sewing.c: Make it sew.  Patch by address@hidden"
>              (line continued below asterisk)
> 
> 
> Any objections?
Nope, seems fine to me.

Cheers
Harley




reply via email to

[Prev in Thread] Current Thread [Next in Thread]