This is the mail archive of the archer@sourceware.org mailing list for the Archer project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[patch] [python] gdb.parameter fixlet


Greetings,

I believe documentation for gdb.parameter() is somewhat confusing,
or at least doesn't match the way other functions in gdb module
are described.

Compare:

 -- Function: objfiles
     Return a sequence of all the objfiles current known to GDB.
...

 -- Function: parameter
     Return the value of a GDB parameter.  PARAMETER is a string
...

 -- Function: history number
     NUMBER indicates which history element to return.


It's clear that gdb.history() takes a NUMBER as input.

But it appears that gdb.parameter() takes no arguments (just like
gdb.objfiles()), which isn't actually the case.

OK to commit?
-- 
Paul Pluzhnikov

2008-12-15  Paul Pluzhnikov  <ppluzhnikov@google.com>

	* gdb.texinfo (Basic Python): Clarify gdb.parameter argument.
	


diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 8d9009c..cf90925 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -18095,9 +18095,9 @@ Return a sequence of all the objfiles current
known to @value{GDBN}.
 @end defun

 @findex gdb.parameter
-@defun parameter
-Return the value of a @value{GDBN} parameter.  @var{parameter} is a
-string naming the parameter to look up; @var{parameter} may contain
+@defun parameter name
+Return the value of the named @value{GDBN} parameter.  @var{name} is a
+string naming the parameter to look up; @var{name} may contain
 spaces if the parameter has a multi-part name.  For example,
 @samp{print object} is a valid parameter name.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]