[Savannah-hackers] Inadequate documentation for commit_prep script

[Richard Stallman]

This documentation in commit_prep is woefully inadequate:

# Perl filter to handle pre-commit checking of files.  This program
# records the last directory where commits will be taking place for
# use by the log_accum.pl script.  For new files, it forces the
# existence of a RCS "Id" keyword in the first ten lines of the file.
# For existing files, it checks version number in the "Id" line to
# prevent losing changes because an old version of a file was copied
# into the direcory.

It should say

* Where the input comes from

* What the input looks like

* What the input means

* Where the output is stored

* What the output looks like

* What the output means.

If some of this information is clearly documented elsewhere,
it is sufficient to say exactly where to find that documentation.


The inadequate documentation of such scripts makes work on
the Savannah code much harder, so please improve it.