Doc: make python function/method descriptions look as in Python

Paul_Koning@Dell.com Paul_Koning@Dell.com
Wed Aug 31 20:47:00 GMT 2011


I found the descriptions of the Python methods/functions hard to read because they are not shown in Python syntax.   The attached patch fixes that.  Parentheses now appear wherever they would in the Python code.  Also, multiple optional arguments are shown as [arg1 [, arg2]] since by Python rule you can omit only consecutive arguments from the right end.  (Having them individually bracketed makes it appear that they can be individually omitted.)

        paul

2011-08-31  Paul Koning  <pkoning@equallogic.com>

        * gdb.texinfo: Make style of Python function and method
        descriptions match the syntax of Python.

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.857
diff -u -r1.857 gdb.texinfo
--- gdb.texinfo 25 Aug 2011 17:59:49 -0000      1.857
+++ gdb.texinfo 31 Aug 2011 20:40:16 -0000
@@ -21005,7 +21005,7 @@
 @end defvar

 @findex gdb.execute
-@defun execute command [from_tty] [to_string]
+@defun execute (command @r{[}, from_tty @r{[}, to_string@r{]}@r{]})
 Evaluate @var{command}, a string, as a @value{GDBN} CLI command.
 If a GDB exception happens while @var{command} runs, it is
 translated as described in @ref{Exception Handling,,Exception Handling}.
@@ -21024,13 +21024,13 @@
 @end defun

 @findex gdb.breakpoints
-@defun breakpoints
+@defun breakpoints ()
 Return a sequence holding all of @value{GDBN}'s breakpoints.
 @xref{Breakpoints In Python}, for more information.
 @end defun

 @findex gdb.parameter
-@defun parameter parameter
+@defun parameter (parameter)
 Return the value of a @value{GDBN} parameter.  @var{parameter} is a
 string naming the parameter to look up; @var{parameter} may contain
 spaces if the parameter has a multi-part name.  For example,
@@ -21043,7 +21043,7 @@
 @end defun

 @findex gdb.history
-@defun history number
+@defun history (number)
 Return a value from @value{GDBN}'s value history (@pxref{Value
 History}).  @var{number} indicates which history element to return.
 If @var{number} is negative, then @value{GDBN} will take its absolute value
@@ -21058,7 +21058,7 @@
 @end defun

 @findex gdb.parse_and_eval
-@defun parse_and_eval expression
+@defun parse_and_eval (expression)
 Parse @var{expression} as an expression in the current language,
 evaluate it, and return the result as a @code{gdb.Value}.
 @var{expression} must be a string.
@@ -21070,7 +21070,7 @@
 convenience variable (@pxref{Convenience Vars}) as a @code{gdb.Value}.
 @end defun

-@findex gdb.post_event
+@findex gdb.post_event ()
 @defun post_event event
 Put @var{event}, a callable object taking no arguments, into
 @value{GDBN}'s internal event queue.  This callable will be invoked at
@@ -21110,7 +21110,7 @@
 @end defun

 @findex gdb.write
-@defun write string @r{[}stream{]}
+@defun write (string @r{[}, stream{]})
 Print a string to @value{GDBN}'s paginated output stream.  The
 optional @var{stream} determines the stream to print to.  The default
 stream is @value{GDBN}'s standard output stream.  Possible stream
@@ -21139,7 +21139,7 @@
 @end defun

 @findex gdb.flush
-@defun flush
+@defun flush ()
 Flush the buffer of a @value{GDBN} paginated stream so that the
 contents are displayed immediately.  @value{GDBN} will flush the
 contents of a stream automatically when it encounters a newline in the
@@ -21170,14 +21170,14 @@
 @end defun

 @findex gdb.target_charset
-@defun target_charset
+@defun target_charset ()
 Return the name of the current target character set (@pxref{Character
 Sets}).  This differs from @code{gdb.parameter('target-charset')} in
 that @samp{auto} is never returned.
 @end defun

 @findex gdb.target_wide_charset
-@defun target_wide_charset
+@defun target_wide_charset ()
 Return the name of the current target wide character set
 (@pxref{Character Sets}).  This differs from
 @code{gdb.parameter('target-wide-charset')} in that @samp{auto} is
@@ -21185,7 +21185,7 @@
 @end defun

 @findex gdb.solib_name
-@defun solib_name address
+@defun solib_name (address)
 Return the name of the shared library holding the given @var{address}
 as a string, or @code{None}.
 @end defun
@@ -21204,7 +21204,7 @@
 @code{break} or @code{edit} commands do (@pxref{Specify Location}).
 @end defun

-@defop Operation {@value{GDBN}} prompt_hook current_prompt
+@defop Operation {@value{GDBN}} prompt_hook (current_prompt)
 @anchor{prompt_hook}

 If @var{prompt_hook} is callable, @value{GDBN} will call the method
@@ -21383,7 +21383,7 @@
 The following methods are provided:

 @table @code
-@defmethod Value __init__ @var{val}
+@defmethod Value __init__ (@var{val})
 Many Python values can be converted directly to a @code{gdb.Value} via
 this object initializer.  Specifically:

@@ -21418,14 +21418,14 @@
 @end table
 @end defmethod

-@defmethod Value cast type
+@defmethod Value cast (type)
 Return a new instance of @code{gdb.Value} that is the result of
 casting this instance to the type described by @var{type}, which must
 be a @code{gdb.Type} object.  If the cast cannot be performed for some
 reason, this method throws an exception.
 @end defmethod

-@defmethod Value dereference
+@defmethod Value dereference ()
 For pointer data types, this method returns a new @code{gdb.Value} object
 whose contents is the object pointed to by the pointer.  For example, if
 @code{foo} is a C pointer to an @code{int}, declared in your C program as
@@ -21446,17 +21446,17 @@
 value pointed to by @code{foo}.
 @end defmethod

-@defmethod Value dynamic_cast type
+@defmethod Value dynamic_cast (type)
 Like @code{Value.cast}, but works as if the C@t{++} @code{dynamic_cast}
 operator were used.  Consult a C@t{++} reference for details.
 @end defmethod

-@defmethod Value reinterpret_cast type
+@defmethod Value reinterpret_cast (type)
 Like @code{Value.cast}, but works as if the C@t{++} @code{reinterpret_cast}
 operator were used.  Consult a C@t{++} reference for details.
 @end defmethod

-@defmethod Value string @r{[}encoding@r{]} @r{[}errors@r{]} @r{[}length@r{]}
+@defmethod Value string (@r{[}encoding@r{[}, errors@r{[}, length@r{]}@r{]}@r{]})
 If this @code{gdb.Value} represents a string, then this method
 converts the contents to a Python string.  Otherwise, this method will
 throw an exception.
@@ -21488,7 +21488,7 @@
 fetched and converted to the given length.
 @end defmethod

-@defmethod Value lazy_string @r{[}encoding@r{]} @r{[}length@r{]}
+@defmethod Value lazy_string (@r{[}encoding@r{[}, length@r{]}@r{]})
 If this @code{gdb.Value} represents a string, then this method
 converts the contents to a @code{gdb.LazyString} (@pxref{Lazy Strings
 In Python}).  Otherwise, this method will throw an exception.
@@ -21526,7 +21526,7 @@
 module:

 @findex gdb.lookup_type
-@defun lookup_type name [block]
+@defun lookup_type (name @r{[}, block@r{]})
 This function looks up a type by name.  @var{name} is the name of the
 type to look up.  It must be a string.

@@ -21562,7 +21562,7 @@
 The following methods are provided:

 @table @code
-@defmethod Type fields
+@defmethod Type fields ()
 For structure and union types, this method returns the fields.  Range
 types have two fields, the minimum and maximum values.  Enum types
 have one field per enum constant.  Function and method types have one
@@ -21603,7 +21603,7 @@
 @end table
 @end defmethod

-@defmethod Type array @var{n1} @r{[}@var{n2}@r{]}
+@defmethod Type array (@var{n1} @r{[}, @var{n2}@r{]})
 Return a new @code{gdb.Type} object which represents an array of this
 type.  If one argument is given, it is the inclusive upper bound of
 the array; in this case the lower bound is zero.  If two arguments are
@@ -21612,45 +21612,45 @@
 must not be negative, but the bounds can be.
 @end defmethod

-@defmethod Type const
+@defmethod Type const ()
 Return a new @code{gdb.Type} object which represents a
 @code{const}-qualified variant of this type.
 @end defmethod

-@defmethod Type volatile
+@defmethod Type volatile ()
 Return a new @code{gdb.Type} object which represents a
 @code{volatile}-qualified variant of this type.
 @end defmethod

-@defmethod Type unqualified
+@defmethod Type unqualified ()
 Return a new @code{gdb.Type} object which represents an unqualified
 variant of this type.  That is, the result is neither @code{const} nor
 @code{volatile}.
 @end defmethod

-@defmethod Type range
+@defmethod Type range ()
 Return a Python @code{Tuple} object that contains two elements: the
 low bound of the argument type and the high bound of that type.  If
 the type does not have a range, @value{GDBN} will raise a
 @code{gdb.error} exception (@pxref{Exception Handling}).
 @end defmethod

-@defmethod Type reference
+@defmethod Type reference ()
 Return a new @code{gdb.Type} object which represents a reference to this
 type.
 @end defmethod

-@defmethod Type pointer
+@defmethod Type pointer ()
 Return a new @code{gdb.Type} object which represents a pointer to this
 type.
 @end defmethod

-@defmethod Type strip_typedefs
+@defmethod Type strip_typedefs ()
 Return a new @code{gdb.Type} that represents the real type,
 after removing all layers of typedefs.
 @end defmethod

-@defmethod Type target
+@defmethod Type target ()
 Return a new @code{gdb.Type} object which represents the target type
 of this type.

@@ -21665,7 +21665,7 @@
 exception.
 @end defmethod

-@defmethod Type template_argument n [block]
+@defmethod Type template_argument (n @r{[}, block@r{]})
 If this @code{gdb.Type} is an instantiation of a template, this will
 return a new @code{gdb.Type} which represents the type of the
 @var{n}th template argument.
@@ -21908,7 +21908,7 @@
 default pretty-printer for a @code{gdb.Value}:

 @findex gdb.default_visualizer
-@defun default_visualizer value
+@defun default_visualizer (value)
 This function takes a @code{gdb.Value} object as an argument.  If a
 pretty-printer for this value exists, then it is returned.  If no such
 printer exists, then this returns @code{None}.
@@ -22142,7 +22142,7 @@
 The following inferior-related functions are available in the @code{gdb}
 module:

-@defun inferiors
+@defun inferiors ()
 Return a tuple containing all inferior objects.
 @end defun

@@ -22167,7 +22167,7 @@
 A @code{gdb.Inferior} object has the following methods:

 @table @code
-@defmethod Inferior is_valid
+@defmethod Inferior is_valid ()
 Returns @code{True} if the @code{gdb.Inferior} object is valid,
 @code{False} if not.  A @code{gdb.Inferior} object will become invalid
 if the inferior no longer exists within @value{GDBN}.  All other
@@ -22175,14 +22175,14 @@
 at the time the method is called.
 @end defmethod

-@defmethod Inferior threads
+@defmethod Inferior threads ()
 This method returns a tuple holding all the threads which are valid
 when it is called.  If there are no valid threads, the method will
 return an empty tuple.
 @end defmethod

 @findex gdb.read_memory
-@defmethod Inferior read_memory address length
+@defmethod Inferior read_memory (address, length)
 Read @var{length} bytes of memory from the inferior, starting at
 @var{address}.  Returns a buffer object, which behaves much like an array
 or a string.  It can be modified and given to the @code{gdb.write_memory}
@@ -22190,7 +22190,7 @@
 @end defmethod

 @findex gdb.write_memory
-@defmethod Inferior write_memory address buffer @r{[}length@r{]}
+@defmethod Inferior write_memory (address, buffer @r{[}, length@r{]})
 Write the contents of @var{buffer} to the inferior, starting at
 @var{address}.  The @var{buffer} parameter must be a Python object
 which supports the buffer protocol, i.e., a string, an array or the
@@ -22199,7 +22199,7 @@
 @end defmethod

 @findex gdb.search_memory
-@defmethod Inferior search_memory address length pattern
+@defmethod Inferior search_memory (address, length, pattern)
 Search a region of the inferior memory starting at @var{address} with
 the given @var{length} using the search pattern supplied in
 @var{pattern}.  The @var{pattern} parameter must be a Python object
@@ -22228,12 +22228,12 @@
 provides methods to register and unregister event handlers:

 @table @code
-@defmethod EventRegistry connect object
+@defmethod EventRegistry connect (object)
 Add the given callable @var{object} to the registry.  This object will be
 called when an event corresponding to this registry occurs.
 @end defmethod

-@defmethod EventRegistry disconnect object
+@defmethod EventRegistry disconnect (object)
 Remove the given @var{object} from the registry.  Once removed, the object
 will no longer receive notifications of events.
 @end defmethod
@@ -22341,7 +22341,7 @@
 module:

 @findex gdb.selected_thread
-@defun selected_thread
+@defun selected_thread ()
 This function returns the thread object for the selected thread.  If there
 is no selected thread, this will return @code{None}.
 @end defun
@@ -22376,7 +22376,7 @@
 A @code{gdb.InferiorThread} object has the following methods:

 @table @code
-@defmethod InferiorThread is_valid
+@defmethod InferiorThread is_valid ()
 Returns @code{True} if the @code{gdb.InferiorThread} object is valid,
 @code{False} if not.  A @code{gdb.InferiorThread} object will become
 invalid if the thread exits, or the inferior that the thread belongs
@@ -22384,20 +22384,20 @@
 exception if it is invalid at the time the method is called.
 @end defmethod

-@defmethod InferiorThread switch
+@defmethod InferiorThread switch ()
 This changes @value{GDBN}'s currently selected thread to the one represented
 by this object.
 @end defmethod

-@defmethod InferiorThread is_stopped
+@defmethod InferiorThread is_stopped ()
 Return a Boolean indicating whether the thread is stopped.
 @end defmethod

-@defmethod InferiorThread is_running
+@defmethod InferiorThread is_running ()
 Return a Boolean indicating whether the thread is running.
 @end defmethod

-@defmethod InferiorThread is_exited
+@defmethod InferiorThread is_exited ()
 Return a Boolean indicating whether the thread is exited.
 @end defmethod
 @end table
@@ -22411,7 +22411,7 @@
 command is implemented using an instance of the @code{gdb.Command}
 class, most commonly using a subclass.

-@defmethod Command __init__ name @var{command_class} @r{[}@var{completer_class}@r{]} @r{[}@var{prefix}@r{]}
+@defmethod Command __init__ (name, @var{command_class} @r{[}@, var{completer_class}@r{[}, var{prefix}@r{]}@r{]})
 The object initializer for @code{Command} registers the new command
 with @value{GDBN}.  This initializer is normally invoked from the
 subclass' own @code{__init__} method.
@@ -22445,14 +22445,14 @@
 @end defmethod

 @cindex don't repeat Python command
-@defmethod Command dont_repeat
+@defmethod Command dont_repeat ()
 By default, a @value{GDBN} command is repeated when the user enters a
 blank line at the command prompt.  A command can suppress this
 behavior by invoking the @code{dont_repeat} method.  This is similar
 to the user command @code{dont-repeat}, see @ref{Define, dont-repeat}.
 @end defmethod

-@defmethod Command invoke argument from_tty
+@defmethod Command invoke (argument, from_tty)
 This method is called by @value{GDBN} when this command is invoked.

 @var{argument} is a string.  It is the argument to the command, after
@@ -22481,7 +22481,7 @@
 @end defmethod

 @cindex completion of Python commands
-@defmethod Command complete text word
+@defmethod Command complete (text, word)
 This method is called by @value{GDBN} when the user attempts
 completion on this command.  All forms of completion are handled by
 this method, that is, the @key{TAB} and @key{M-?} key bindings
@@ -22688,7 +22688,7 @@
 behavior in @value{GDBN}.  Similarly, you can define parameters that
 can be used to influence behavior in custom Python scripts and commands.

-@defmethod Parameter __init__ name @var{command-class} @var{parameter-class} @r{[}@var{enum-sequence}@r{]}
+@defmethod Parameter __init__ (name, @var{command-class}, @var{parameter-class} @r{[}, @var{enum-sequence}@r{]})
 The object initializer for @code{Parameter} registers the new
 parameter with @value{GDBN}.  This initializer is normally invoked
 from the subclass' own @code{__init__} method.
@@ -22748,14 +22748,14 @@
 There are two methods that should be implemented in any
 @code{Parameter} class.  These are:

-@defop Operation {parameter} get_set_string self
+@defop Operation {parameter} get_set_string (self)
 @value{GDBN} will call this method when a @var{parameter}'s value has
 been changed via the @code{set} API (for example, @kbd{set foo off}).
 The @code{value} attribute has already been populated with the new
 value and may be used in output.  This method must return a string.
 @end defop

-@defop Operation {parameter} get_show_string self svalue
+@defop Operation {parameter} get_show_string (self, svalue)
 @value{GDBN} will call this method when a @var{parameter}'s
 @code{show} API has been invoked (for example, @kbd{show foo}).  The
 argument @code{svalue} receives the string representation of the
@@ -22842,7 +22842,7 @@
 in Python.  A convenience function is an instance of a subclass of the
 class @code{gdb.Function}.

-@defmethod Function __init__ name
+@defmethod Function __init__ (name)
 The initializer for @code{Function} registers the new function with
 @value{GDBN}.  The argument @var{name} is the name of the function,
 a string.  The function will be visible to the user as a convenience
@@ -22853,7 +22853,7 @@
 string for the new class.
 @end defmethod

-@defmethod Function invoke @var{*args}
+@defmethod Function invoke (@var{*args})
 When a convenience function is evaluated, its arguments are converted
 to instances of @code{gdb.Value}, and then the function's
 @code{invoke} method is called.  Note that @value{GDBN} does not
@@ -22906,13 +22906,13 @@
 @code{gdb} module:

 @findex gdb.current_progspace
-@defun current_progspace
+@defun current_progspace ()
 This function returns the program space of the currently selected inferior.
 @xref{Inferiors and Programs}.
 @end defun

 @findex gdb.progspaces
-@defun progspaces
+@defun progspaces ()
 Return a sequence of all the progspaces currently known to @value{GDBN}.
 @end defun

@@ -22948,7 +22948,7 @@
 @code{gdb} module:

 @findex gdb.current_objfile
-@defun current_objfile
+@defun current_objfile ()
 When auto-loading a Python script (@pxref{Auto-loading}), @value{GDBN}
 sets the ``current objfile'' to the corresponding objfile.  This
 function returns the current objfile.  If there is no current objfile,
@@ -22956,7 +22956,7 @@
 @end defun

 @findex gdb.objfiles
-@defun objfiles
+@defun objfiles ()
 Return a sequence of all the objfiles current known to @value{GDBN}.
 @xref{Objfiles In Python}.
 @end defun
@@ -22979,7 +22979,7 @@

 A @code{gdb.Objfile} object has the following methods:

-@defmethod Objfile is_valid
+@defmethod Objfile is_valid ()
 Returns @code{True} if the @code{gdb.Objfile} object is valid,
 @code{False} if not.  A @code{gdb.Objfile} object can become invalid
 if the object file it refers to is not loaded in @value{GDBN} any
@@ -23009,16 +23009,16 @@
 The following frame-related functions are available in the @code{gdb} module:

 @findex gdb.selected_frame
-@defun selected_frame
+@defun selected_frame ()
 Return the selected frame object.  (@pxref{Selection,,Selecting a Frame}).
 @end defun

 @findex gdb.newest_frame
-@defun newest_frame
+@defun newest_frame ()
 Return the newest frame object for the selected thread.
 @end defun

-@defun frame_stop_reason_string reason
+@defun frame_stop_reason_string (reason)
 Return a string explaining the reason why @value{GDBN} stopped unwinding
 frames, as expressed by the given @var{reason} code (an integer, see the
 @code{unwind_stop_reason} method further down in this section).
@@ -23027,19 +23027,19 @@
 A @code{gdb.Frame} object has the following methods:

 @table @code
-@defmethod Frame is_valid
+@defmethod Frame is_valid ()
 Returns true if the @code{gdb.Frame} object is valid, false if not.
 A frame object can become invalid if the frame it refers to doesn't
 exist anymore in the inferior.  All @code{gdb.Frame} methods will throw
 an exception if it is invalid at the time the method is called.
 @end defmethod

-@defmethod Frame name
+@defmethod Frame name ()
 Returns the function name of the frame, or @code{None} if it can't be
 obtained.
 @end defmethod

-@defmethod Frame type
+@defmethod Frame type ()
 Returns the type of the frame.  The value can be one of:
 @table @code
 @item gdb.NORMAL_FRAME
@@ -23066,40 +23066,40 @@
 @end table
 @end defmethod

-@defmethod Frame unwind_stop_reason
+@defmethod Frame unwind_stop_reason ()
 Return an integer representing the reason why it's not possible to find
 more frames toward the outermost frame.  Use
 @code{gdb.frame_stop_reason_string} to convert the value returned by this
 function to a string.
 @end defmethod

-@defmethod Frame pc
+@defmethod Frame pc ()
 Returns the frame's resume address.
 @end defmethod

-@defmethod Frame block
+@defmethod Frame block ()
 Return the frame's code block.  @xref{Blocks In Python}.
 @end defmethod

-@defmethod Frame function
+@defmethod Frame function ()
 Return the symbol for the function corresponding to this frame.
 @xref{Symbols In Python}.
 @end defmethod

-@defmethod Frame older
+@defmethod Frame older ()
 Return the frame that called this frame.
 @end defmethod

-@defmethod Frame newer
+@defmethod Frame newer ()
 Return the frame called by this frame.
 @end defmethod

-@defmethod Frame find_sal
+@defmethod Frame find_sal ()
 Return the frame's symtab and line object.
 @xref{Symbol Tables In Python}.
 @end defmethod

-@defmethod Frame read_var variable @r{[}block@r{]}
+@defmethod Frame read_var (variable @r{[}, block@r{]})
 Return the value of @var{variable} in this frame.  If the optional
 argument @var{block} is provided, search for the variable from that
 block; otherwise start at the frame's current block (which is
@@ -23108,7 +23108,7 @@
 @code{gdb.Block} object.
 @end defmethod

-@defmethod Frame select
+@defmethod Frame select ()
 Set this frame to be the selected frame.  @xref{Stack, ,Examining the
 Stack}.
 @end defmethod
@@ -23132,7 +23132,7 @@
 module:

 @findex gdb.block_for_pc
-@defun block_for_pc pc
+@defun block_for_pc (pc)
 Return the @code{gdb.Block} containing the given @var{pc} value.  If the
 block cannot be found for the @var{pc} value specified, the function
 will return @code{None}.
@@ -23141,7 +23141,7 @@
 A @code{gdb.Block} object has the following methods:

 @table @code
-@defmethod Block is_valid
+@defmethod Block is_valid ()
 Returns @code{True} if the @code{gdb.Block} object is valid,
 @code{False} if not.  A block object can become invalid if the block it
 refers to doesn't exist anymore in the inferior.  All other
@@ -23190,7 +23190,7 @@
 module:

 @findex gdb.lookup_symbol
-@defun lookup_symbol name @r{[}block@r{]} @r{[}domain@r{]}
+@defun lookup_symbol (name @r{[}, block @r{[}, domain@r{]}@r{]})
 This function searches for a symbol by name.  The search scope can be
 restricted to the parameters defined in the optional domain and block
 arguments.
@@ -23214,7 +23214,7 @@
 @end defun

 @findex gdb.lookup_global_symbol
-@defun lookup_global_symbol name @r{[}domain@r{]}
+@defun 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.

@@ -23283,7 +23283,7 @@
 A @code{gdb.Symbol} object has the following methods:

 @table @code
-@defmethod Symbol is_valid
+@defmethod Symbol is_valid ()
 Returns @code{True} if the @code{gdb.Symbol} object is valid,
 @code{False} if not.  A @code{gdb.Symbol} object can become invalid if
 the symbol it refers to does not exist in @value{GDBN} any longer.
@@ -23439,7 +23439,7 @@
 A @code{gdb.Symtab_and_line} object has the following methods:

 @table @code
-@defmethod Symtab_and_line is_valid
+@defmethod Symtab_and_line is_valid ()
 Returns @code{True} if the @code{gdb.Symtab_and_line} object is valid,
 @code{False} if not.  A @code{gdb.Symtab_and_line} object can become
 invalid if the Symbol table and line object it refers to does not
@@ -23465,7 +23465,7 @@
 A @code{gdb.Symtab} object has the following methods:

 @table @code
-@defmethod Symtab is_valid
+@defmethod Symtab is_valid ()
 Returns @code{True} if the @code{gdb.Symtab} object is valid,
 @code{False} if not.  A @code{gdb.Symtab} object can become invalid if
 the symbol table it refers to does not exist in @value{GDBN} any
@@ -23473,7 +23473,7 @@
 if it is invalid at the time the method is called.
 @end defmethod

-@defmethod Symtab fullname
+@defmethod Symtab fullname ()
 Return the symbol table's source absolute file name.
 @end defmethod
 @end table
@@ -23487,7 +23487,7 @@
 Python code can manipulate breakpoints via the @code{gdb.Breakpoint}
 class.

-@defmethod Breakpoint __init__ spec @r{[}type@r{]} @r{[}wp_class@r{]} @r{[}internal@r{]}
+@defmethod Breakpoint __init__ (spec @r{[}, type @r{[}, wp_class @r{[},internal@r{]}@r{]}@r{]})
 Create a new breakpoint.  @var{spec} is a string naming the
 location of the breakpoint, or an expression that defines a
 watchpoint.  The contents can be any location recognized by the
@@ -23553,7 +23553,7 @@
 Read/Write watchpoint.
 @end table

-@defmethod Breakpoint is_valid
+@defmethod Breakpoint is_valid ()
 Return @code{True} if this @code{Breakpoint} object is valid,
 @code{False} otherwise.  A @code{Breakpoint} object can become invalid
 if the user deletes the breakpoint.  In this case, the object still
@@ -23700,7 +23700,7 @@

 A @code{gdb.LazyString} object has the following functions:

-@defmethod LazyString value
+@defmethod LazyString value ()
 Convert the @code{gdb.LazyString} to a @code{gdb.Value}.  This value
 will point to the string in memory, but will lose all the delayed
 retrieval, encoding and handling that @value{GDBN} applies to a



More information about the Gdb mailing list