[RFA] alloca coding standard

Eli Zaretskii eliz@delorie.com
Wed Nov 15 03:20:00 GMT 2000


> Date: Mon, 13 Nov 2000 15:36:40 -0500
> From: Nick Duffek <nsd@redhat.com>
>
> On 13-Nov-2000, Eli Zaretskii wrote:
> 
> >I suggest an index entry here, e.g. "@findex alloca usage".
> 
> Agreed.  I also added a @cindex entry.

Thanks.  However, having a "@cindex alloca" in addition to
"@findex alloca" is not a good idea: it generates identical index
entries (albeit typeset in different fonts) in the printed version.

Even in the on-line version, and even if the various indices are in
separate nodes (which is not at all certain for a small document such
as gdbint.texi, where it is customary to use @syncodeindex to get all
indices together), it is not very useful, because index-searching
commands will find an entry in any index.  The situation you probably
had in mind, where a user searches for an entry by manually browsing
the Index node, should not be the norm, but an exception: one should
search the index by using the index-searching commands.

Other than that, the changes for the docs can go in, once there's an
agreement on the subject matter.


More information about the Gdb mailing list