Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: dje@google.com (Doug Evans)
Cc: gdb-patches@sourceware.org
Subject: Re: [patch, doc RFA]: New python function lookup_global_symbol
Date: Sat, 19 Feb 2011 10:37:00 -0000	[thread overview]
Message-ID: <83zkpstoxn.fsf@gnu.org> (raw)
In-Reply-To: <20110218235945.997602461AA@ruffy.mtv.corp.google.com>

> Date: Fri, 18 Feb 2011 15:59:45 -0800 (PST)
> From: dje@google.com (Doug Evans)
> 
> --- NEWS	15 Feb 2011 21:17:52 -0000	1.426
> +++ NEWS	18 Feb 2011 23:48:45 -0000
> @@ -38,6 +38,8 @@
>  
>  * Python scripting
>  
> +  ** New function gdb.lookup_global_symbol looks up a global symbol.
> +

This part is okay.

> -@code{gdb.Block} object.  The optional @var{domain} argument restricts
> +@code{gdb.Block} object.  If elided, the block for the current frame
                                ^^^^^^
Please use "omitted" instead, it will be understood by more readers
whose first language is not English.  We use "omitted" in this context
elsewhere in the manual.

> +@defun lookup_symbol name [domain]

@defun renders its arguments in @code and @var, but you want the
brackets in the normal roman typeface.  So this should be

  @defun lookup_symbol name @r{[}domain@r{]}

> +This function searches for a global symbol by name.
> +The search scope can be restricted to by the domain argument.
> +
> +@var{name} is the name of the symbol.  It must be a string.
> +The optional @var{domain} argument restricts the search to the domain type.
> +The @var{domain} argument must be a domain constant defined in the @code{gdb}
> +module and described later in this chapter.

Should we tell what happens if the symbol is not found?

Okay with those changes.

Thanks.


  reply	other threads:[~2011-02-19  8:21 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-02-19  1:04 Doug Evans
2011-02-19 10:37 ` Eli Zaretskii [this message]
2011-02-22 23:04   ` Doug Evans
2011-02-23  4:17     ` Eli Zaretskii
2011-02-24  3:51       ` Doug Evans
2011-02-24  4:14         ` Eli Zaretskii
2011-02-22 22:50 ` Tom Tromey

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=83zkpstoxn.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=dje@google.com \
    --cc=gdb-patches@sourceware.org \
    /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