From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 72166 invoked by alias); 6 May 2018 19:40:07 -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 71589 invoked by uid 89); 6 May 2018 19:40:06 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-2.4 required=5.0 tests=AWL,BAYES_00,SPF_PASS autolearn=ham version=3.3.2 spammy= 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; Sun, 06 May 2018 19:40:05 +0000 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fFPVn-0003wD-Ge for gdb-patches@sourceware.org; Sun, 06 May 2018 15:40:03 -0400 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:58830) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fFPVn-0003w9-Cg; Sun, 06 May 2018 15:39:59 -0400 Received: from [176.228.60.248] (port=1796 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1fFPVm-0005VL-3N; Sun, 06 May 2018 15:39:59 -0400 Date: Sun, 06 May 2018 19:40:00 -0000 Message-Id: <83r2mor2t0.fsf@gnu.org> From: Eli Zaretskii To: Philippe Waroquiers CC: gdb-patches@sourceware.org In-reply-to: <20180505192804.12731-5-philippe.waroquiers@skynet.be> (message from Philippe Waroquiers on Sat, 5 May 2018 21:28:03 +0200) Subject: Re: [RFC 4/5] Documentation changes for 'frame apply' and 'thread apply' Reply-to: Eli Zaretskii References: <20180505192804.12731-1-philippe.waroquiers@skynet.be> <20180505192804.12731-5-philippe.waroquiers@skynet.be> 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: 2018-05/txt/msg00162.txt.bz2 > From: Philippe Waroquiers > Cc: Philippe Waroquiers > Date: Sat, 5 May 2018 21:28:03 +0200 > > +@table @asis Since all the @item's in this table use @code, it is better to say @table @code > +@item Flags @code{c} and @code{s} : error handling when applying @var{command}. This is not a good way of formatting a table. I suggest to use this instead: By default, @value{GDBN} displays some thread information before the output produced by @var{command}, and an error raised during the execution of a @var{command} will abort @code{thread apply}. The following flags can be used to fine-tune this behavior: @table @code @item c The flag @code{c}, which stands for @samp{continue}, causes any errors in @var{command} to be displayed, and the execution of @vode{thread apply} then continues. @item s The flag @code{s}, which stands for @samp{silent}, causes any errors or empty output produced by a @var{command} to be silently ignored. That is, the execution continues, but the errors are not printed. @item v The flag @code{v} increases the verbosity of the info displayed for each thread. @item q The flag @code{q} (@samp{quiet}) decreases the verbosity. @end @table Flags @code{c} and @code{s} cannot be used together. The default value of verbosity, 1, prints the per-inferior thread number and the target system's thread ID. Under verbosity 0, no thread info is printed. > +@item tfaas @var{command} > +Shortcut for @code{thread apply all -s frame apply all -s @var{COMMAND}}. Any reason why -s should be specified twice? > +The @var{flags} control what output to produce and how to handle > +errors raised when applying @var{command} to a frame. @var{flags} > +must start with a @code{-} directly followed by one or more letters in > +@code{vqcs}. I suggest to use here the same paradigm as shown above for "thread apply". > +Some frame information is printed before the output or error produced > +by applying @var{command} to a frame. The printed frame information > +@footnote{Note that the way the frame information is printed can be changed > +using the @code{set backtrace} settings such as @code{set > +filename-display}. @ref{Backtrace,,Backtraces}} Please use @xref here, and leave 2 spaces between sentences. (And I'm not sure it's a good idea to have cross-references in footnotes. Did you make sure this produces reasonable results in the printed manual?) > +Note that the command @code{tfaas @var{command}} applies @var{command} > +on all frames of all threads. @ref{Threads,,Threads} Ditto. Thanks.