patch for binutils include/ansidecl.h.
Doug Evans
dje@transmeta.com
Mon Sep 23 04:45:00 GMT 2002
David O'Brien writes:
> > The ChangeLog entry should say what changed, not why.
>
> That is a real limitation and annoying rule. It is often impossible to
> find out *WHY* a change was done. Which is a Bad Thing. I can read the
> "cvs diff -r X -r X+1" to see the what. I really wish GNU ChangeLog
> entries would grow the *WHY*, or the culture be changed to tell the *WHY*
> rather than just repleat the ChangeLog entry in the CVS commit log.
fwiw, from http://www.gnu.org/software/guile/changelogs/guile-changelogs_3.html
One should never need the ChangeLog to understand the current
code. If you find yourself writing a significant explanation in the
ChangeLog, you should consider carefully whether your text doesn't
actually belong in a comment, alongside the code it explains. Here's an
example of doing it right:
1999-02-23 Tom Tromey address@removed
* cplus-dem.c (consume_count): If `count' is unreasonable,
return 0 and don't advance input pointer.
And then, in `consume_count' in `cplus-dem.c':
while (isdigit ((unsigned char)**type))
{
count *= 10;
count += **type - '0';
/* A sanity check. Otherwise a symbol like
`_Utf390_1__1_9223372036854775807__9223372036854775'
can cause this function to return a negative value.
In this case we just consume until the end of the string. */
if (count > strlen (*type))
{
*type = save;
return 0;
}
More information about the Binutils
mailing list