This is the mail archive of the
archer@sourceware.org
mailing list for the Archer project.
[python] Mention Python help command and keyword argumentsconvention.
- From: Thiago Jung Bauermann <bauerman at br dot ibm dot com>
- To: archer ml <archer at sourceware dot org>
- Date: Fri, 27 Feb 2009 17:00:18 -0300
- Subject: [python] Mention Python help command and keyword argumentsconvention.
Hi,
Just pushed this.
gdb/doc/
* gdb.texinfo (Python API): Mention python help command and
convention for accepting keyword arguments.
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 67c0ae3..d055353 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -18114,6 +18114,14 @@ auto-loading is disabled.
@cindex python api
@cindex programming in python
+You can get quick online help for @value{GDBN}'s Python API by issuing
+the command @w{@kbd{python help (gdb)}}.
+
+Functions and methods which have two or more optional arguments allow
+them to be specified using keyword syntax. This allows passing some
+optional arguments while skipping others. Example:
+@w{@code{gdb.some_function ('foo', bar = 1, baz = 2)}}.
+
@cindex python stdout
@cindex python pagination
At startup, @value{GDBN} overrides Python's @code{sys.stdout} and