4.5. Documentation and ChangeLogs
As with any software project, it is important to maintain documentation as the project evolves. The documentation must reflect the current state of the software, but it must also accurately record the changes that have been made in the past. The GNU coding standard rigorously enforces the maintenance of documentation. Automake, in fact, implements some of the standard by checking for the presence of a 'ChangeLog' file when automake is run!
A number of files exist, with standardized filenames, for storing documentation in GNU packages. The complete GNU coding standard, which offers some useful insights, can be found at http://www.gnu.org/prep/standards.html.
Other projects, including in-house projects, can use ...
Get GNU Autoconf, Automake, and Libtool now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
