diff options
| author | Andrew Burgess <andrew.burgess@embecosm.com> | 2021-03-18 16:44:14 +0000 |
|---|---|---|
| committer | Andrew Burgess <andrew.burgess@embecosm.com> | 2021-03-18 16:55:37 +0000 |
| commit | 763b8efdcc0ab0f94f7af48792eb5c97b6eca41b (patch) | |
| tree | 631b2bcb2bab98165d8824a971bb798c291a8a98 /gdb/doc/python.texi | |
| parent | 538c15fc2a29ff142f2ec71d253d4027946ece09 (diff) | |
| download | gdb-763b8efdcc0ab0f94f7af48792eb5c97b6eca41b.zip gdb-763b8efdcc0ab0f94f7af48792eb5c97b6eca41b.tar.gz gdb-763b8efdcc0ab0f94f7af48792eb5c97b6eca41b.tar.bz2 | |
gdb/doc: fix the example for get_set_string in Python API docs
The small example for gdb.Parameter.get_set_string does not return a
string. The documentation is very clear that this method must return
a string, and indeed, inspecting the code in gdb/python/py-param.c
shows that a string return value is required (if an exception is not
thrown).
While inspecting the code in gdb/python/py-param.c I noticed that the
comment for the C++ code that invokes the Python get_set_string method
is wrong, so I updated that too.
gdb/ChangeLog:
* python/py-param.c (get_set_value): Update header comment.
gdb/doc/ChangeLog:
* python.texinfo (Parameters In Python): Return empty string in
small example code.
Diffstat (limited to 'gdb/doc/python.texi')
| -rw-r--r-- | gdb/doc/python.texi | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index ba3d2f9..9135d41 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -4041,6 +4041,7 @@ class ExampleParam (gdb.Parameter): self.value = self.saved_value raise gdb.GdbError('Failed to validate') self.saved_value = self.value + return "" @end smallexample @end defun |