RE: [PATCH v4 06/10] python: Add clear() to gdb.Record.

["Willgerodt, Felix" <felix.willgerodt@intel.com>]

> -----Original Message-----
> From: Eli Zaretskii <eliz@gnu.org>
> Sent: Dienstag, 10. Mai 2022 16:05
> To: Willgerodt, Felix <felix.willgerodt@intel.com>
> Cc: Metzger, Markus T <markus.t.metzger@intel.com>; gdb-
> patches@sourceware.org
> Subject: Re: [PATCH v4 06/10] python: Add clear() to gdb.Record.
> 
> > From: "Willgerodt, Felix" <felix.willgerodt@intel.com>
> > CC: "Metzger, Markus T" <markus.t.metzger@intel.com>,
> > 	"gdb-patches@sourceware.org" <gdb-patches@sourceware.org>
> > Date: Tue, 10 May 2022 13:42:49 +0000
> >
> > > > +@defun Record.clear ()
> > > > +Clear the trace data of the current recording.  This forces re-decoding
> of
> > > the
> > > > +trace for successive commands.
> > > > +@end defun
> > >
> > > What does "force re-decoding" mean here?
> >
> > The recorded instructions and pt packets will be discarded. "Re-decoding"
> > means that the pt buffer will be re-read and re-decoded by GDB/libipt
> > into a new instruction history.
> 
> Does saying that help users in any way?  If not, maybe just remove
> that part?
> 

It tells the user the actual use case of this command. You will only really use
it if you want GDB to re-decode the trace for your next commands.
Otherwise you would just stop recording.

> > > If this is described in
> > > another place in the manual, could you add a cross-reference to that
> > > place?
> > >
> >
> > I don't think it has been described yet, as clear() hasn't directly been
> exposed
> > before, only indirectly e.g. via "record stop". The "trace" is however
> > mentioned e.g. here for "record btrace pt":
> > https://sourceware.org/gdb/onlinedocs/gdb/Process-Record-and-
> Replay.html
> >
> > Should I link that?
> 
> Yes, I think so.

I added it locally. Then I saw that this chapter at the top, a couple of
lines above already links it. In my eyes this makes the extra link here
redundant. Should I still add it?

Thanks,
Felix
Intel Deutschland GmbH
Registered Address: Am Campeon 10, 85579 Neubiberg, Germany
Tel: +49 89 99 8853-0, www.intel.de <http://www.intel.de>
Managing Directors: Christin Eisenschmid, Sharon Heck, Tiffany Doon Silva  
Chairperson of the Supervisory Board: Nicole Lau
Registered Office: Munich
Commercial Register: Amtsgericht Muenchen HRB 186928