Mail Archives: djgpp-workers/2000/06/11/05:00:21
On Sat, 10 Jun 2000, Martin Str|mberg wrote:
> Ok-dokey! I think I have fixed all Eli's comments, including adding
> some more text to the description of _get_fat_size() and
> _get_fs_type().
Thanks. I have a few more comments (if these problems were in the
original patches you posted, I'm sorry I missed them):
> uid_t getuid(void);
> int isatty(int _fildes);
> int link(const char *_existing, const char *_new);
> + offset_t llseek(int _fildes, offset_t _offset, int _whence);
llseek should go into the non-Posix part of unistd.h, below the
#ifndef _POSIX_SOURCE directive.
> + This function tries to determine the number bits used to enumerate the
This should have said "...the number of bits...", ``of'' is missing.
> + If you are interested in which kind of FAT file system that is in use
> + try the function @xref{_get_fat_size} which will reliably detect the
This use of @xref might seem like a clever trick, but in fact it is a
bad idea. It looks awkward in Info:
...try the function *Note _get_fat_size:: which will...
and downright unreadable in the printed version:
...try the function See Section 123.4 [_get_fat_size], page 1234
which will...
It is much better, if less ``sexy'', to use the following paradigm:
...try the function @code{_get_fat_size} (@pxref{_get_fat_size})
which will...
In any case, @xref should only be used at the beginning of a
sentence, since it generates capitalized Note and See. In the middle
of a sentence, use @ref instead.
- Raw text -