RE: [OB PATCH] Fix doc for -add-inferior

[Marc Khouzam <marc dot khouzam at ericsson dot com>]

> -----Original Message-----
> From: Pedro Alves [mailto:palves@redhat.com] 
> Sent: Wednesday, June 05, 2013 7:37 AM
> To: Marc Khouzam
> Cc: 'Yao Qi'; Simon Marchi; 'GDB Patches'
> Subject: Re: [OB PATCH] Fix doc for -add-inferior
> 
> On 06/04/2013 06:29 PM, Marc Khouzam wrote:
> > 
> >> -----Original Message-----
> >> From: gdb-patches-owner@sourceware.org 
> >> [mailto:gdb-patches-owner@sourceware.org] On Behalf Of Pedro Alves
> >> Sent: Tuesday, June 04, 2013 10:37 AM
> >> To: Yao Qi
> >> Cc: Simon Marchi; GDB Patches
> >> Subject: Re: [OB PATCH] Fix doc for -add-inferior
> >>
> >> On 06/04/2013 02:58 PM, Yao Qi wrote:
> >>> On 06/04/2013 09:31 PM, Simon Marchi wrote:
> >>>> I like "thread-group" better also. Since changing an existing MI
> >>>> interface could break applications that use it, what is 
> >> the policy in
> >>>> GDB about changing things like this?
> >>>
> >>> In general, we can't change the existing interface.  
> >>
> >> Agreed.
> >>
> >>> However, this change fixes the inconsistency between code 
> >> and doc, and it should be fine to change the code to comply 
> >> with the doc, IMO.
> >>
> >> That's unfortunately not really a valid justification, so I 
> >> can't agree with that.
> >> Valid justifications would be "we don't need to care that 
> >> frontends break
> >> because ..." (e.g., "this never worked as is"), or
> >> "frontends won't break because ...".
> >> Any existing frontend that is using -add-inferior will be 
> expecting to
> >> see "inferior" there in order to extract the inferior id.  
> >> It's quite natural
> >> that other frontends authors hadn't even noticed the 'reality 
> >> vs documentation'
> >> divergence, as -add-inferior resulting in "inferior" borders on
> >> so-obvious-who-needs-to-check-docs-anyway output.  IMNSHO, 
> >> it's better to
> >> just document the over-3-year-old current behavior.
> > 
> > Pedro's right, Eclipse expects 'inferior'.  I think that changing
> > that would just be asking for trouble.
> 
> Thanks for confirming.  Could you check it in?  It has
> about zero copyrightable content (anyone writing a doc fix for this
> would end up with the same exact patch), so there's really no need
> to wait for paperwork for this one.

I've committed the below for Simon (who does not have his account yet).

If Eli has any concerns, I will revert.

Thanks

Marc

2013-06-05  Simon Marchi  <simon.marchi@ericsson.com>

	* gdb.texinfo (Miscellaneous gdb/mi Commands): Fix -add-inferior
	response field name (thread-group to inferior).

### Eclipse Workspace Patch 1.0
#P src
Index: gdb/doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.1094
diff -u -r1.1094 gdb.texinfo
--- gdb/doc/gdb.texinfo 4 Jun 2013 13:07:45 -0000       1.1094
+++ gdb/doc/gdb.texinfo 5 Jun 2013 14:10:38 -0000
@@ -34642,7 +34642,7 @@
 inferior is not associated with any executable.  Such association may
 be established with the @samp{-file-exec-and-symbols} command
 (@pxref{GDB/MI File Commands}).  The command response has a single
-field, @samp{thread-group}, whose value is the identifier of the
+field, @samp{inferior}, whose value is the identifier of the
 thread group corresponding to the new inferior.
 
 @subheading Example
@@ -34650,7 +34650,7 @@
 @smallexample
 @value{GDBP}
 -add-inferior
-^done,thread-group="i3"
+^done,inferior="i3"
 @end smallexample
 
 @subheading The @code{-interpreter-exec} Command