Mail Archives: djgpp/1998/02/05/05:29:02
On Thu, 5 Feb 1998, S. M. Halloran wrote:
> In truth, the
> author of the function/library must write the documentation since he
> is the one who wrote the source and is familiar with it.
The author (DJ Delorie) *did* write the docs. I'm sure he will welcome
any improvements that you will submit to him.
> and the documentation of gettimeofday() tells
> more without looking at its source, which I could not find anyway
> since the function is not defined in any source file in the same
> directory where time() is found
It's on src/libc/dos/dos/gettimeo.c.
> (if someone can tell me how to use
> 'grep' to recursively search through a tree, I would be grateful).
fgrep gettimeofday .../*.c
The DJGPP FAQ explains the "..." wildcard in section 16.1.
Another (better, IMHO) solution to search for tokens in C sources is to
download and install the GNU ID-utils (v2gnu/idu32b.zip). They search
much faster than `grep', and they know about the syntax of the source
language.
> Although I present it
> in the Unix man page style (which is probably a standard for
> documentation that those who develop the djgpp library might consider
> or re-consider as a style to use),
DJGPP documentation is written in Texinfo. Texinfo is more powerful than
the man pages because it supports hypertext links.
> its elements are easily re-edited
> to fit presentation style you prefer.
Please try to submit patches in Texinfo. The best way is to edit the
file ctime.txh in the library and submit context diffs against the
original version, like this:
diff -c src/libc/ansi/time/ctime.old src/libc/ansi/time/ctime.txh > ctime.dif
> I am not sure how any such effort is organized now.
Look at the *.txh files inside djlsr201.zip: these are the sources of the
docs. The template of the docs is very clear there. You will need to
read the description of the Texinfo language as well (from the DOS
prompt, type "info texinfo" and read there).
When you have the diffs, submit them to DJ Delorie <dj AT delorie DOT com>.
> submit the doc to a review panel for commenting &c., going back and
> forth between author and review panel until everybody thinks things
> are satisfactory.
You can cc: your diffs to djgpp-workers AT delorie DOT com, which is reflected
to people who work on DJGPP development. But this is not a requirement,
since your changes will be reviewed anyway when they get into the next
alpha or beta release. It is up to you.
- Raw text -