Mail Archives: djgpp-workers/2000/08/15/08:16:23
> Date: Tue, 15 Aug 2000 12:14:45 +0200
> From: Laurynas Biveinis <lauras AT softhome DOT net>
>
> Maybe rewriting the whole thing like follows would be better?
>
> @cindex Symlink support AT r{, new functions}
> @findex __solve_symlinks AT r{, added to library}
> @findex lstat AT r{, added to library}
> @findex readlink AT r{, added to library}
> ...
>
> @cindex Symlink support AT r{, adjusted functions}
> @findex symlink AT r{, changed behaviour}
> ...
Yes, this is also okay, but: the common "Symlink support" entry will
require you to put all functions in that category together; if you, or
someone else, forgets, the users lose.
If you think that index entries such as "Symlink support..." are
useful on their own right, perhaps it would be better to add a
paragraph that talks only about the fact that symlinks are supported,
and have this @cindex entry point to that paragraph. You may put
@xref's there to the docs of the relevant functions in libc.info.
One other comment: index entries should be in lower case (unless you
are indexing an acronym, such as ASCII). Recall how the index is
printed in a book: the entries usually begin with a lower-case letter.
> > Unless you have a good reason for this lack of a newline, please add
> > one.
>
> OK I'll add it there. Note that testsuite data files intentionally do not
> contain ending newlines and I add them to CVS as binary files.
Sure, I saw that. My comment was only about the source of the test
program.
- Raw text -