This is the mail archive of the
mailing list for the GCC project.
Re: ChangeLog (was: Debugging patch)
- To: law at cygnus dot com
- Subject: Re: ChangeLog (was: Debugging patch)
- From: Gerald Pfeifer <pfeifer at dbai dot tuwien dot ac dot at>
- Date: Tue, 24 Mar 1998 20:11:16 +0100 (MET)
- cc: egcs-bugs at cygnus dot com
On Tue, 24 Mar 1998, Jeffrey A Law wrote:
> I was given the impression (multiple times over the years) that
> the GNU standards mandate that .texi changes not be noted in the
> ChangeLog. I never went and verified this myself...
I just had a look today and the version "last updated 18 February 1998"
There's no need to make change log entries for documentation files.
This is because documentation is not susceptible to bugs that are hard
to fix. Documentation does not consist of parts that must interact in a
precisely engineered fashion. To correct an error, you need not know
the history of the erroneous passage; it is enough to compare what the
documentation says with the way the program actually works.
> If the GNU standards only say that such changes are "optional", then
> my preference would be to include them in the ChangeLog.
I'm not a native speaker, so I leave the final interpretation to others,
but IMHO this does not disallow ChangeLog entries for .texi patches.
Personally I'd argue for including those entries (and do not really agree
with the arguments in the coding standards, at least not with regard to
software like egcs).
Gerald Pfeifer (Jerry) Vienna University of Technology