Re: [PATCH] Fix MI output for multi-location breakpoints

[Eli Zaretskii <eliz@gnu.org>]

> From: Simon Marchi <simon.marchi@ericsson.com>
> CC: "palves@redhat.com" <palves@redhat.com>, Simon Marchi	<simon.marchi@ericsson.com>
> Date: Fri, 11 Jan 2019 00:15:34 +0000

The documentation changes are approved with these comments:

> gdb/doc/ChangeLog:
> 
> 	* gdb.texinfo (Choosing Modes): Mention mi3.
> 	(Command Interpreters): Likewise.

You seem to be using the chapter/section names in the parentheses.
You should be using node names instead (or use Emacs, which will do
that for you ;-).

> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
> index 4a00834d0bf..a422a395c47 100644
> --- a/gdb/doc/gdb.texinfo
> +++ b/gdb/doc/gdb.texinfo
> @@ -1268,12 +1268,11 @@ program or device.  This option is meant to be set by programs which
>  communicate with @value{GDBN} using it as a back end.
>  @xref{Interpreters, , Command Interpreters}.
>  
> -@samp{--interpreter=mi} (or @samp{--interpreter=mi2}) causes
> +@samp{--interpreter=mi} (or @samp{--interpreter=mi3}) causes
>  @value{GDBN} to use the @dfn{@sc{gdb/mi} interface} (@pxref{GDB/MI, ,
> -The @sc{gdb/mi} Interface}) included since @value{GDBN} version 6.0.  The
> -previous @sc{gdb/mi} interface, included in @value{GDBN} version 5.3 and
> -selected with @samp{--interpreter=mi1}, is deprecated.  Earlier
> -@sc{gdb/mi} interfaces are no longer supported.
> +The @sc{gdb/mi} Interface}).  The @sc{gdb/mi} interfaces 1 and 2 are
> +available, but deprecated.  Earlier @sc{gdb/mi} interfaces are no
> +longer available.

Please don't remove the version information from this text.  At the
very least, we should tell what GDB version introduced the latest mi3
syntax.  We should tell this here, and not only in the "Interpreters"
node, because this section is a concise list of invocation options,
and should include the important information without sending the
reader to read the more detailed parts.

> +@item mi3
> +@cindex mi3 interpreter
> +The @sc{gdb/mi} interface introduced in @value{GDBN} 9.  It is the latest
                                           ^^^^^^^^^^^^^^
GDB 9.1, presumably?

>  @item mi1
>  @cindex mi1 interpreter
> -The @sc{gdb/mi} interface included in @value{GDBN} 5.1, 5.2, and 5.3.
> +The @sc{gdb/mi} interface introduced in @value{GDBN} 5.1.

I think the old text is better.

Thanks.

P.S. I wonder how did we let this problem slip through the cracks when
multiple-location breakpoints were introduced?  Maybe we should do
something to avoid such mistakes in the future.  We really shouldn't
be changing the MI syntax in incompatible ways so late into GDB
development cycle.