Re: [obv] add kindex for set remote hardware-{watchpoint,breakpoint}-limit

Eli Zaretskii
2012-08-06T16:19:11Z

> Date: Mon, 6 Aug 2012 23:29:13 +0800
>
> On Friday, August 03, 2012 06:09:59 PM Eli Zaretskii wrote:
> > Sorry, but it isn't obvious. You will see that this whole node has
> > only one kindex entry: "@kindex set remote". There are other "set
> > remote SOMETHING" commands described there, but none of them has a
> > @kindex entry.
> >
> > The reason for that is simple: it is not useful to have several index
> > entries that all begin with the same string and all point to the same
> > page.
>
> The reason I post this patch is that I was unable to find 'set remote
> hardware-breakpoint-limit' in 'Command and Variable Index'.

But "set remote" is there, isn't it?

When you cannot find a subcommand in the index, you should go for its
parent command.

> I thought we need
> kindex for *every* command in documentation, and that is why we need "index".
> Otherwise, the criteria of using kindex is not clear, IMO.

The criteria for kindex is to index every command, but not necessarily
every subcommand. So "set remote" is indexed.

Another example of a command with lots of subcommands which are not
indexed is "set print" (although I see that a couple of subcommands
sneaked in).

Again, having lots of index entries with identical beginning pointing
to the same page is not useful. Think how this looks in the printed
manual, for example.

OK?