This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [patch, doc RFA]: New python function lookup_global_symbol
- From: Eli Zaretskii <eliz at gnu dot org>
- To: dje at google dot com (Doug Evans)
- Cc: gdb-patches at sourceware dot org
- Date: Sat, 19 Feb 2011 10:21:24 +0200
- Subject: Re: [patch, doc RFA]: New python function lookup_global_symbol
- References: <20110218235945.997602461AA@ruffy.mtv.corp.google.com>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> 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.