Re: [task #6537] Implement ddb/db_elf.c

[Samuel Thibault]

Andrei Barbu, le Tue 27 May 2008 19:02:18 +0000, a écrit :
> Additional Item Attachment, task #6537 (project hurd):
> 
> File name: changelog-elf-1.patch          Size:1 KB

Ok, you make the same mistake as I did some time ago when I started
working on GNU projects :)

GNU style changelog are not about why you make changes, but about what
changes you make.  Putting a "Add ELF symbol lookup" header is useful,
but no need for more.  The rest should just be e.g.

        * ddb/db_elf.c: New file.
        ...
        * ddb/db_sym.h (SYMTAB_ELF): New macro
        (SYMTAB_MACHDEP): Update macro value
        (symtab_type): Return SYMTAB_ELF instead of SYMTAB_AOUT.
        * i386/i386at/model_dep.c: Include <ddb/elf.h> and
        * <machine/vm_param.h>.
        (c_boot_entry): If ELF debugging information is available, call
        elf_db_sym_init. Call aout_db_sym_init only when AOUT debugging
        information is available.
        ...

I.e. yes, writing a GNU ChangeLog is not about justifications, but just
stupidly summing up the effect of the patch: the goal is to tell what
the patch does, and in particular the name of the things that have
changed (functions, macros, etc).  It helps when looking for things that
happened with a function for instance.  Please really read the ChangeLog
part of the GNU Coding Style, and the existing ChangeLog for examples.

Samuel