From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 14178 invoked by alias); 27 Oct 2016 15:02:42 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 14159 invoked by uid 89); 27 Oct 2016 15:02:42 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-3.2 required=5.0 tests=AWL,BAYES_00,RP_MATCHES_RCVD,SPF_PASS autolearn=ham version=3.3.2 spammy=D*r, reader X-HELO: eggs.gnu.org Received: from eggs.gnu.org (HELO eggs.gnu.org) (208.118.235.92) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Thu, 27 Oct 2016 15:02:31 +0000 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bzmCD-00028h-OZ for gdb-patches@sourceware.org; Thu, 27 Oct 2016 11:02:27 -0400 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:57280) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bzmBv-00021c-II; Thu, 27 Oct 2016 11:02:03 -0400 Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:3110 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1bzmBu-0002ep-M4; Thu, 27 Oct 2016 11:02:03 -0400 Date: Thu, 27 Oct 2016 15:02:00 -0000 Message-Id: <83insdu975.fsf@gnu.org> From: Eli Zaretskii To: Tim Wiederhake CC: gdb-patches@sourceware.org, palves@redhat.com, markus.t.metzger@intel.com In-reply-to: <1477549711-2603-8-git-send-email-tim.wiederhake@intel.com> (message from Tim Wiederhake on Thu, 27 Oct 2016 08:28:31 +0200) Subject: Re: [PATCH 7/7] Add documentation for new instruction record Python bindings. Reply-to: Eli Zaretskii References: <1477549711-2603-1-git-send-email-tim.wiederhake@intel.com> <1477549711-2603-8-git-send-email-tim.wiederhake@intel.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-IsSubscribed: yes X-SW-Source: 2016-10/txt/msg00763.txt.bz2 > From: Tim Wiederhake > Cc: palves@redhat.com, markus.t.metzger@intel.com > Date: Thu, 27 Oct 2016 08:28:31 +0200 > > 2016-10-26 Tim Wiederhake > > gdb/ChangeLog: > > * NEWS: Add record Python bindings entry. > > gdb/doc/ChangeLog: > > * python.texi: Add record Python bindings entry. Thanks, I have a few comments on this part of the patch. > +@node Recordings In Python > +@subsubsection Recordings In Python > +@cindex recordings in python > + > +The following recordings-related functions are available in the > +@code{gdb} module: Please add here a sentence that references the place in the manual where recording and replaying facilities are described. > +@defun gdb.start_recording ([method]) Please use "@r{[}method@r{]}" instead of "[method]", so that the brackets are typeset in the roman typeface. > +Starts a recording using the given @var{method}. If no @var{method} is Elsewhere in the manual we say "Start", not "Starts". Please use that form for consistency (here and elsewhere in your documentation patch). > +@itemize @bullet > +@item > +@code{"full"} I suggest to lose the quotes, they don't look good inside @code, and also might mislead the reader to think that these are strings, which I don't think is true. You could use @samp instead of @code if you want to have quotes in the printed/PDF manual (in the Info output this will be quoted with @code as well). > +@defvar BtraceInstruction.number > +An integer identifying this instruction. @var{number} corresponds to > +the numbers seen in @code{record instruction-history}. A cross-reference to the place which describes that command would be good here. This part is okay with the above issues fixed.