Patchwork [PUSHED] gdb/doc: Remove duplicate description of lookup_global_symbol

login
register
mail settings
Submitter Andrew Burgess
Date Dec. 14, 2019, 11:22 p.m.
Message ID <20191214232229.24801-1-andrew.burgess@embecosm.com>
Download mbox | patch
Permalink /patch/36876/
State New
Headers show

Comments

Andrew Burgess - Dec. 14, 2019, 11:22 p.m.
In this commit:

  commit 086baaf1346f07acfb6708e8c6cb79274241488b
  Date:   Tue Oct 15 16:18:26 2019 +0100

      gdb/python: Introduce gdb.lookup_static_symbols

A duplicate description of gdb.lookup_global_symbol was accidentally
added.  This commit corrects this mistake and removes the duplicate.

gdb/doc/ChangeLog:

	* python.texi (Symbols In Python): Remove duplicate description of
	gdb.lookup_global_symbol.

Change-Id: I4457b42cf05bde39e5c0ff39f168af919cad1255
---
 gdb/doc/ChangeLog   |  5 +++++
 gdb/doc/python.texi | 14 --------------
 2 files changed, 5 insertions(+), 14 deletions(-)
Andrew Burgess - Dec. 14, 2019, 11:32 p.m.
* Andrew Burgess <andrew.burgess@embecosm.com> [2019-12-14 23:22:29 +0000]:

> In this commit:
> 
>   commit 086baaf1346f07acfb6708e8c6cb79274241488b
>   Date:   Tue Oct 15 16:18:26 2019 +0100
> 
>       gdb/python: Introduce gdb.lookup_static_symbols
> 
> A duplicate description of gdb.lookup_global_symbol was accidentally
> added.  This commit corrects this mistake and removes the duplicate.
> 
> gdb/doc/ChangeLog:
> 
> 	* python.texi (Symbols In Python): Remove duplicate description of
> 	gdb.lookup_global_symbol.

I merged this commit into gdb-9-branch too as it seems like an obvious
improvement.

Thanks,
Andrew



> 
> Change-Id: I4457b42cf05bde39e5c0ff39f168af919cad1255
> ---
>  gdb/doc/ChangeLog   |  5 +++++
>  gdb/doc/python.texi | 14 --------------
>  2 files changed, 5 insertions(+), 14 deletions(-)
> 
> diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
> index f807fb248ae..5d762aa612a 100644
> --- a/gdb/doc/python.texi
> +++ b/gdb/doc/python.texi
> @@ -4883,20 +4883,6 @@
>  information.
>  @end defun
>  
> -@findex gdb.lookup_global_symbol
> -@defun gdb.lookup_global_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.
> -
> -The result is a @code{gdb.Symbol} object or @code{None} if the symbol
> -is not found.
> -@end defun
> -
>  @findex gdb.lookup_static_symbols
>  @defun gdb.lookup_static_symbols (name @r{[}, domain@r{]})
>  Similar to @code{gdb.lookup_static_symbol}, this function searches for
> -- 
> 2.14.5
>

Patch

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index f807fb248ae..5d762aa612a 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -4883,20 +4883,6 @@ 
 information.
 @end defun
 
-@findex gdb.lookup_global_symbol
-@defun gdb.lookup_global_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.
-
-The result is a @code{gdb.Symbol} object or @code{None} if the symbol
-is not found.
-@end defun
-
 @findex gdb.lookup_static_symbols
 @defun gdb.lookup_static_symbols (name @r{[}, domain@r{]})
 Similar to @code{gdb.lookup_static_symbol}, this function searches for