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

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

[Yao Qi]

Hi,
This patch adds kindex for set remote hardware-{watchpoint,breakpoint}-limit.
Applied as obvious.

gdb/doc:

2012-08-03  Yao Qi  <yao@codesourcery.com>

	* gdb.texinfo (Remote Configuration): Add kindex for 'set
	remote hardware-watchpoint-limit' and 'set
	remote hardware-breakpoint-limit'.
---
 gdb/doc/gdb.texinfo |    2 ++
 1 files changed, 2 insertions(+), 0 deletions(-)

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 15a9efd..b7b15ec 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -17838,7 +17838,9 @@ responses.
 @anchor{set remote hardware-watchpoint-limit}
 @anchor{set remote hardware-breakpoint-limit}
 @item set remote hardware-watchpoint-limit @var{limit}
+@kindex set remote hardware-watchpoint-limit
 @itemx set remote hardware-breakpoint-limit @var{limit}
+@kindex set remote hardware-breakpoint-limit
 Restrict @value{GDBN} to using @var{limit} remote hardware breakpoint or
 watchpoints.  A limit of -1, the default, is treated as unlimited.
 
-- 
1.7.7.6

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

[Eli Zaretskii]

> From: Yao Qi <yao@codesourcery.com>
> Date: Fri, 3 Aug 2012 22:59:56 +0800
> 
> This patch adds kindex for set remote hardware-{watchpoint,breakpoint}-limit.
> Applied as obvious.

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.

So please revert that commit.

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

[Yao Qi]

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.

Hi, Eli,
The reason I post this patch is that I was unable to find 'set remote 
hardware-breakpoint-limit' in 'Command and Variable Index'.  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.

-- 
Yao (齐尧)

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

[Eli Zaretskii]

> From: Yao Qi <yao@codesourcery.com>
> 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?

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

[Yao Qi]

On Monday, August 06, 2012 07:18:53 PM Eli Zaretskii wrote:
> 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.
> 

OK, the criteria is fine with me.

> 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?

The following is to revert my patch.

-- 
Yao (齐尧)

gdb/doc:

2012-08-07  Yao Qi  <yao@codesourcery.com>

	Revert the folloing patch:
	2012-08-06  Yao Qi  <yao@codesourcery.com>
	* gdb.texinfo (Remote Configuration): Add kindex for 'set
	remote hardware-watchpoint-limit' and 'set
	remote hardware-breakpoint-limit'.

Index: doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.997
diff -u -r1.997 gdb.texinfo
--- doc/gdb.texinfo	6 Aug 2012 17:13:27 -0000	1.997
+++ doc/gdb.texinfo	7 Aug 2012 01:08:58 -0000
@@ -17839,9 +17839,7 @@
 @anchor{set remote hardware-watchpoint-limit}
 @anchor{set remote hardware-breakpoint-limit}
 @item set remote hardware-watchpoint-limit @var{limit}
-@kindex set remote hardware-watchpoint-limit
 @itemx set remote hardware-breakpoint-limit @var{limit}
-@kindex set remote hardware-breakpoint-limit
 Restrict @value{GDBN} to using @var{limit} remote hardware breakpoint or
 watchpoints.  A limit of -1, the default, is treated as unlimited.

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

[Eli Zaretskii]

> From: Yao Qi <yao@codesourcery.com>
> Date: Tue, 7 Aug 2012 09:09:52 +0800
> 
> > 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?
> 
> The following is to revert my patch.

Thanks.