This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH] Fix PR14371: doc on =breakpoint-deleted
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Yao Qi <yao at codesourcery dot com>
- Cc: gdb-patches at sourceware dot org
- Date: Sat, 04 Aug 2012 10:03:58 +0300
- Subject: Re: [PATCH] Fix PR14371: doc on =breakpoint-deleted
- References: <1344053058-19490-1-git-send-email-yao@codesourcery.com>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> 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.