This is the mail archive of the
archer@sourceware.org
mailing list for the Archer project.
[patch] [python] gdb.parameter fixlet
- From: Paul Pluzhnikov <ppluzhnikov at google dot com>
- To: Project Archer <archer at sourceware dot org>
- Date: Mon, 15 Dec 2008 17:57:35 -0800
- Subject: [patch] [python] gdb.parameter fixlet
- Dkim-signature: v=1; a=rsa-sha1; c=relaxed/relaxed; d=google.com; s=beta;t=1229392658; bh=ja3dndAtik2gmOubP803D72qJ4M=;h=DomainKey-Signature:MIME-Version:Date:Message-ID:Subject:From:To: Content-Type:Content-Transfer-Encoding; b=WmhnIGuivh/KCMkJFhP9zppsb8veyQBpU/QMR7gI9RPOKAv0P2N9wlZy7vHSw5/1iDfY0B+GbOUx+pHAvAzfLA==
- Domainkey-signature: a=rsa-sha1; s=beta; d=google.com; c=nofws; q=dns;h=mime-version:date:message-id:subject:from:to:content-type:content-transfer-encoding;b=mDDs53zNge2uuftVEFY7/KQ+azsVHi18oW5xsobtJq9a2zpXrXgWPC0Gmdt85wW6g1h16BJr85NyB46lwfU47Q==
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.