Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Paul Koning <paulkoning@comcast.net>
Cc: gdb-patches@sourceware.org, tromey@redhat.com
Subject: Re: [RFA] Python: PR/13327: expose laziness to Python
Date: Tue, 25 Oct 2011 18:24:00 -0000	[thread overview]
Message-ID: <83fwihc4xw.fsf@gnu.org> (raw)
In-Reply-To: <B920A763-3B1E-426E-9054-E1C6F020626D@comcast.net>

> From: Paul Koning <paulkoning@comcast.net>
> Date: Tue, 25 Oct 2011 13:38:20 -0400
> Cc: Tom Tromey <tromey@redhat.com>
> 
> The documentation briefly touches on how lazy fetching works in the discussion of the is_lazy attribute, but it doesn't more fully discuss it as a topic of its own.  I could try to do so, in the introductory material for gdb.Value.  Should I do that?

No, I think what you wrote is good enough.

> Ok to commit?

A few comments to the documentation part:

> +@defvar Value.is_lazy
> +This read-only boolean attribute is true if the value has not yet

"The attribute is true" sounds weird, doesn't it?  How about

 The value of this read-only attribute is @code{True} if @code{Value}
 has not yet been fetched ...

> +been fetched from the inferior.  GDB does not fetch values until
                                    ^^^
@value{GDBN}

> +necessary, for efficiency.  For example:
> +
> +@smallexample
> +myval = gdb.parse_and_eval ('somevar')
> +@end smallexample
> +
> +The value of @var{somevar} is not fetched at this time.  It will be 

@code{somevar}, not @var.  "somevar" does not stand for some symbol,
it's the symbol itself.

> +fetched when the value is needed, or when the @code{fetch_lazy ()}
> +method is invoked.  

@code{fetch_lazy}, please, without the parens.  "fetch_lazy()" looks
like a call to the method with no arguments, which is not what you
want.

> +@defun Value.fetch_lazy ()
> +If the @code{gdb.Value} object is currently a lazy value 
> +(@code{gdb.Value.is_lazy} is @code{True}) then the value is
                                            ^
Comma after the right parenthesis.

Okay with these changes.


  reply	other threads:[~2011-10-25 18:16 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-10-25 17:43 Paul Koning
2011-10-25 18:24 ` Eli Zaretskii [this message]
2011-10-25 18:54   ` Paul Koning

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=83fwihc4xw.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=paulkoning@comcast.net \
    --cc=tromey@redhat.com \
    /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