(find-maint.info.gz) Documentation
Info Catalog
(find-maint.info.gz) Using the GNU Portability Library
(find-maint.info.gz) Top
(find-maint.info.gz) Testing
7 Documentation
***************
The findutils git tree includes several different types of
documentation.
7.1 User Documentation
======================
User-oriented documentation is provided as manual pages and in Texinfo.
See Introduction (find)Introduction.
Please make sure both sets of documentation are updated if you make a
change to the code. The GNU coding standards do not normally call for
maintaining manual pages on the grounds of effort duplication.
However, the manual page format is more convenient for quick reference,
and so it's worth maintaining both types of documentation. However,
the manual pages are normally rather more terse than the Texinfo
documentation. The manual pages are suitable for reference use, but
the Texinfo manual should also include introductory and tutorial
material.
7.2 Build Guidance
==================
`ABOUT-NLS'
Describes the Free Translation Project, the translation status of
various GNU projects, and how to participate by translating an
application.
`AUTHORS'
Lists the authors of findutils.
`COPYING'
The copyright license covering findutils; currently, the GNU GPL,
version 3.
`INSTALL'
Generic installation instructions for installing GNU programs.
`README'
Information about how to compile findutils in particular
`README-alpha'
A README file which is included with testing releases of findutils.
`README-hacking'
Describes how to build findutils from the code in git.
`THANKS'
Thanks for people who contributed to findutils. Generally, if
someone's contribution was significant enough to need a copyright
assignment, their name should go in here.
`TODO'
Mainly obsolete.
7.3 Release Information
=======================
`NEWS'
Enumerates the user-visible change in each release. Typical
changes are fixed bugs, functionality changes and documentation
changes. Include the date when a release is made.
`ChangeLog'
This file enumerates all changes to the findutils source code (with
the possible exception of `.cvsignore' and `.gitignore' changes).
The level of detail used for this file should be sufficient to
answer the questions "what changed?" and "why was it changed?".
If a change fixes a bug, always give the bug reference number in
both the `ChangeLog' and `NEWS' files and of course also in the
checkin message. In general, it should be possible to enumerate
all material changes to a function by searching for its name in
`ChangeLog'. Mention when each release is made.
Info Catalog
(find-maint.info.gz) Using the GNU Portability Library
(find-maint.info.gz) Top
(find-maint.info.gz) Testing
automatically generated by
info2html