public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Philippe Waroquiers <philippe.waroquiers@skynet.be>
Cc: gdb-patches@sourceware.org
Subject: Re: [RFC 4/5] Document changes to info [args|functions|locals|variables]
Date: Wed, 04 Jul 2018 16:44:00 -0000	[thread overview]
Message-ID: <83efgjne6l.fsf@gnu.org> (raw)
In-Reply-To: <1530564328.29413.8.camel@skynet.be> (message from Philippe	Waroquiers on Mon, 02 Jul 2018 22:45:28 +0200)

> From: Philippe Waroquiers <philippe.waroquiers@skynet.be>
> Cc: gdb-patches@sourceware.org
> Date: Mon, 02 Jul 2018 22:45:28 +0200
> 
> If both @var{regexp} and @var{type_regexp} are provided, a local variable
> is printed only if it respects the two regexps.

I'd use "matches", not "respects".

> The command @kbd{info locals -q -t @var{type_regexp}} can usefully be
> combined with the commands @kbd{frame apply} and @kbd{thread apply}.
> For example, your program might use Resource Acquisition Is
> Initialization types (RAII) such as @code{lock_something_t} : each
> local variable of type @code{lock_something_t} automatically places a
> lock that is destroyed when the variable goes out of scope.  You can
> then list all acquired locks in your program by doing
> @smallexample
> thread apply all -s frame apply all -s info locals -q -t lock_something_t
> @end smallexample
> or the equivalent shorter form

You want @noindent on a separate line before the "or the equivalent",
otherwise the printed manual will have that indented as if it were a
new paragraph (which it isn't).

> I have tried to explain RAII in the doc above, but wondering if that
> is clear enough.

I think it's enough, they can google it if they want to know more.

Thanks, I have no more comments to the new text except the above few
nits.

  reply	other threads:[~2018-07-04 16:44 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-07-01 21:07 [RFC 0/5] info [args|functions|locals|variables] [-q] [-t TYPEREGEXP] [NAMEREGEXP] Philippe Waroquiers
2018-07-01 21:07 ` [RFC 1/5] New cli-utils.h/.c function extract_info_print_args Philippe Waroquiers
2018-07-01 21:07 ` [RFC 5/5] Announce changes in NEWS to info [args|functions|locals|variables] Philippe Waroquiers
2018-07-02 14:51   ` Eli Zaretskii
2018-07-01 21:07 ` [RFC 4/5] Document changes " Philippe Waroquiers
2018-07-02 15:02   ` Eli Zaretskii
2018-07-02 20:46     ` Philippe Waroquiers
2018-07-04 16:44       ` Eli Zaretskii [this message]
2018-07-01 21:07 ` [RFC 3/5] Add [-q] [-t TYPEREGEXP] [NAMEREGEXP] args " Philippe Waroquiers
2018-07-02 15:06   ` Eli Zaretskii
2018-07-01 21:07 ` [RFC 2/5] Make struct type_print_options default_ptype_flags non static Philippe Waroquiers

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83efgjne6l.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=philippe.waroquiers@skynet.be \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).