Re: [PATCH v3 5/8] gdbserver: Transmit target description ID in thread list and stop reply

[Eli Zaretskii <eliz@gnu.org>]

> Cc: Thiago Jung Bauermann <thiago.bauermann@linaro.org>, Simon Marchi
>  <simon.marchi@efficios.com>
> Date: Wed, 01 Feb 2023 12:07:20 +0000
> From: Andrew Burgess via Gdb-patches <gdb-patches@sourceware.org>
> 
> Finally, I wonder if it might make sense to add something like:
> 
>   @cindex Target Description IDs
> 
> to every place where we discuss these ID's, then there will be an index
> entry that links all the places together?

Adding index entries is always welcome, as those help finding subjects
quickly and efficiently.  However:

  . we prefer index entries to use only lower-case letters, to avoid
    having their sorting order (which eventually affects whet you see
    in the Info reader when you use completion) depend on the locale
    where the manual is produced from Texinfo;
  . more importantly, it is not a good idea to have multiple
    identical index entries, since makeinfo then disambiguates them as
    foo<1>, foo<2>, etc., and when you see those in the list of
    completions, you have no idea which one is the one you want.  So
    it is preferable to qualify each such index entry in a way that
    will convey enough information to the reader to know which one
    he/she wants.  For example:

     @cindex target description id, and remote packets
     @cindex target description id, in python programs

    etc., you get the idea.