RE: [PATCH 1/2] gdb: add maintenance set/show gcore xml-target-description command

["Schimpe, Christina" <christina.schimpe@intel.com>]

> -----Original Message-----
> From: Eli Zaretskii <eliz@gnu.org>
> Sent: Mittwoch, 10. Juni 2026 13:43
> To: Schimpe, Christina <christina.schimpe@intel.com>
> Cc: gdb-patches@sourceware.org; hjl.tools@gmail.com; keiths@redhat.com;
> aburgess@redhat.com
> Subject: Re: [PATCH 1/2] gdb: add maintenance set/show gcore xml-target-
> description command
> 
> > From: "Schimpe, Christina" <christina.schimpe@intel.com>
> > CC: "gdb-patches@sourceware.org" <gdb-patches@sourceware.org>,
> > 	"hjl.tools@gmail.com" <hjl.tools@gmail.com>, "keiths@redhat.com"
> > 	<keiths@redhat.com>, Andrew Burgess <aburgess@redhat.com>
> > Date: Tue, 9 Jun 2026 21:02:12 +0000
> >
> > > If this command controls the emission of NT_GDB_TDESC note, then why
> > > its name mentions a more general XML target description?  Am I right
> > > in assuming that NT_GDB_TDESC is just part of the target description?
> > > If so, perhaps the xml-target-description part should be renamed, or
> > > maybe the NEWS text should be modified to say that the entire target
> > > description is emitted as XML?
> >
> > You're right. I should have been more specific.
> > With the NT_GDB_TDESC note the core file contains a copy of GDB's
> > target description XML.  Without this note the corefile does not
> > contain the target description (see commit "gdb: write target description
> into core file").
> >
> > Should we better write:
> >
> > "With this command you can control whether or not the
> > generate-core-file command emits the NT_GDB_TDESC note including a
> copy of GDB's target description XML."
> 
> Yes, this would be much more clear.
> 
> > > > +  add_setshow_boolean_cmd ("xml-target-description", class_obscure,
> > > > +			    &maint_gcore_emit_xml_tdesc, _("\ Set whether
> > > gcore emits a
> > > > +xml-target-description."), _("\ Show whether gore emits a
> > > > +xml-target-description."), _("\ By default, gcore emits the note
> > > > +NT_GDB_TDESC.\n\ Disabling this setting will cause gcore to no
> > > > +longer emit this note."),
> > >
> > > This doc string has the same issue: it say GDB will emit the XML
> > > target description, but then goes on to say that NT_GDB_TDESC note is
> emitted.
> >
> > Is it better as follows:
> > "... gcore emits the NT_GDB_TDESC note including GDB's target description
> XML"
> 
> Yes, thanks.

Thanks for the quick feedback. 
I'll wait a couple of days, if someone has further comments, then I'll post the v2
with your comments fixed.

Christina
Intel Deutschland GmbH

Registered Address: Dornacher Strasse 1, 85622 Feldkirchen, Germany
Tel: +49 89 991 430, www.intel.de
Managing Directors: Harry Demas, Jeffrey Schneiderman, Yin Chong Sorrell
Chairperson of the Supervisory Board: Nicole Lau
Registered Seat: Munich
Commercial Register: Amtsgericht Muenchen HRB 186928