Buglet in your ChangeLog entry

Mark Mitchell mark@codesourcery.com
Tue Oct 5 16:32:00 GMT 1999


Michael --

  There's a minor problem with a couple of your recent ChangeLog
entries:

Tue Oct  5 16:14:40 1999  Michael Meissner  <meissner@cygnus.com>

	* libgcc1-test.c (toplevel): Include stddef.h to get size_t.
	({,d}discard): Add forward declarations.  Declare parameter as

Tue Oct  5 11:34:52 1999  Michael Meissner  <meissner@cygnus.com>

	* ggc-{common,callbacks,none,page,simple}.c (toplevel): Reorder
	includes, so that ggc.h comes after other includes that define the
	appropriate types.  Include tm_p.h for getting user prototypes.

  These entries do not follow the GNU Coding Standards, quoted here:

    It's important to name the changed function or variable in full.
    Don't abbreviate function or variable names, and don't combine
    them.  Subsequent maintainers will often search for a function name
    to find all the change log entries that pertain to it; if you
    abbreviate the name, they won't find it when they search.

    For example, some people are tempted to abbreviate groups of function
    names by writing `* register.el ({insert,jump-to}-register)'; this is
    not a good idea, since searching for `jump-to-register' or
    `insert-register' would not find that entry.

Would you mind fixing these up?  Thanks!

--
Mark Mitchell                   mark@codesourcery.com
CodeSourcery, LLC               http://www.codesourcery.com


More information about the Gcc-patches mailing list