[PATCH] Fix PR14371: doc on =breakpoint-deleted

[PATCH] Fix PR14371: doc on =breakpoint-deleted

[Yao Qi]

Hi,
We have an inconsistency between GDB and doc on '=breakpoint-deleted'.
The doc says "=breakpoint-deleted,bpkt={}", while the actual behavior
is "=breakpoint-deleted,id=".  I treat it as an error in doc, so fix
it in doc side.

gdb/doc:

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

	Fix PR14371.

	* gdb.texinfo (GDB/MI Async Records): Fix the doc for
	'=breakpoint-deleted'.
---
 gdb/doc/gdb.texinfo |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index b7b15ec..96fa5e2 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -27609,13 +27609,14 @@ thread groups.
 
 @item =breakpoint-created,bkpt=@{...@}
 @itemx =breakpoint-modified,bkpt=@{...@}
-@itemx =breakpoint-deleted,bkpt=@{...@}
+@itemx =breakpoint-deleted,id=@var{number}
 Reports that a breakpoint was created, modified, or deleted,
 respectively.  Only user-visible breakpoints are reported to the MI
 user.
 
 The @var{bkpt} argument is of the same form as returned by the various
-breakpoint commands; @xref{GDB/MI Breakpoint Commands}.
+breakpoint commands; @xref{GDB/MI Breakpoint Commands}.  The @var{id}
+argument is the id of the breakpoint.
 
 Note that if a breakpoint is emitted in the result record of a
 command, then it will not also be emitted in an async record.
-- 
1.7.7.6

Re: [PATCH] Fix PR14371: doc on =breakpoint-deleted

[Eli Zaretskii]

> From: Yao Qi <yao@codesourcery.com>
> Date: Sat, 4 Aug 2012 12:04:18 +0800
> 
> We have an inconsistency between GDB and doc on '=breakpoint-deleted'.
> The doc says "=breakpoint-deleted,bpkt={}", while the actual behavior
> is "=breakpoint-deleted,id=".  I treat it as an error in doc, so fix
> it in doc side.

Thanks.

> 
> gdb/doc:
> 
> 2012-08-04  Yao Qi  <yao@codesourcery.com>
> 
> 	Fix PR14371.
> 
> 	* gdb.texinfo (GDB/MI Async Records): Fix the doc for
> 	'=breakpoint-deleted'.
> ---
>  gdb/doc/gdb.texinfo |    5 +++--
>  1 files changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
> index b7b15ec..96fa5e2 100644
> --- a/gdb/doc/gdb.texinfo
> +++ b/gdb/doc/gdb.texinfo
> @@ -27609,13 +27609,14 @@ thread groups.
>  
>  @item =breakpoint-created,bkpt=@{...@}
>  @itemx =breakpoint-modified,bkpt=@{...@}
> -@itemx =breakpoint-deleted,bkpt=@{...@}
> +@itemx =breakpoint-deleted,id=@var{number}
>  Reports that a breakpoint was created, modified, or deleted,
>  respectively.  Only user-visible breakpoints are reported to the MI
>  user.
>  
>  The @var{bkpt} argument is of the same form as returned by the various
> -breakpoint commands; @xref{GDB/MI Breakpoint Commands}.
> +breakpoint commands; @xref{GDB/MI Breakpoint Commands}.  The @var{id}
> +argument is the id of the breakpoint.                        ^^^^^^^^
               ^^^^^^^^^^^^^^^^^^^^^^^^
Not "@var{id}", but "@var{number}", for consistency with the
description above.  Also, I'd prefer "the ordinal number of the
breakpoint" instead of the end of the last sentence, because "id of
the breakpoint" doesn't really say what it is.

OK with those changes.

Re: [PATCH] Fix PR14371: doc on =breakpoint-deleted

[Yao Qi]

On Saturday, August 04, 2012 10:03:58 AM Eli Zaretskii wrote:
> > -breakpoint commands; @xref{GDB/MI Breakpoint Commands}.
> > +breakpoint commands; @xref{GDB/MI Breakpoint Commands}.  The @var{id}
> > +argument is the id of the breakpoint.                        ^^^^^^^^
> 
>                ^^^^^^^^^^^^^^^^^^^^^^^^
> Not "@var{id}", but "@var{number}", for consistency with the
> description above.  Also, I'd prefer "the ordinal number of the
> breakpoint" instead of the end of the last sentence, because "id of
> the breakpoint" doesn't really say what it is.
> 

"number" of breakpoint is used other places in doc.  Fixed as you suggested.

> OK with those changes.

Applied.

-- 
Yao (齐尧)

gdb/doc:

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

	Fix PR14371.

	* gdb.texinfo (GDB/MI Async Records): Fix the doc for
	'=breakpoint-deleted'.
---
 gdb/doc/gdb.texinfo |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index b7b15ec..9f9fe40 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -27609,13 +27609,14 @@ thread groups.
 
 @item =breakpoint-created,bkpt=@{...@}
 @itemx =breakpoint-modified,bkpt=@{...@}
-@itemx =breakpoint-deleted,bkpt=@{...@}
+@itemx =breakpoint-deleted,id=@var{number}
 Reports that a breakpoint was created, modified, or deleted,
 respectively.  Only user-visible breakpoints are reported to the MI
 user.
 
 The @var{bkpt} argument is of the same form as returned by the various
-breakpoint commands; @xref{GDB/MI Breakpoint Commands}.
+breakpoint commands; @xref{GDB/MI Breakpoint Commands}.  The
+@var{number} is the ordinal number of the breakpoint.
 
 Note that if a breakpoint is emitted in the result record of a
 command, then it will not also be emitted in an async record.
-- 
1.7.7.6