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.
This commit is contained in:
parent
538c15fc2a
commit
763b8efdcc
@ -1,3 +1,7 @@
|
|||||||
|
2021-03-18 Andrew Burgess <andrew.burgess@embecosm.com>
|
||||||
|
|
||||||
|
* python/py-param.c (get_set_value): Update header comment.
|
||||||
|
|
||||||
2021-03-17 Simon Marchi <simon.marchi@polymtl.ca>
|
2021-03-17 Simon Marchi <simon.marchi@polymtl.ca>
|
||||||
|
|
||||||
* infrun.c (check_multi_target_resumption): Remove argument to
|
* infrun.c (check_multi_target_resumption): Remove argument to
|
||||||
|
@ -1,3 +1,8 @@
|
|||||||
|
2021-03-18 Andrew Burgess <andrew.burgess@embecosm.com>
|
||||||
|
|
||||||
|
* python.texinfo (Parameters In Python): Return empty string in
|
||||||
|
small example code.
|
||||||
|
|
||||||
2021-02-24 Andrew Burgess <andrew.burgess@embecosm.com>
|
2021-02-24 Andrew Burgess <andrew.burgess@embecosm.com>
|
||||||
|
|
||||||
* gdb.texinfo (Files): Document new 'maint info target-sections'
|
* gdb.texinfo (Files): Document new 'maint info target-sections'
|
||||||
|
@ -4041,6 +4041,7 @@ class ExampleParam (gdb.Parameter):
|
|||||||
self.value = self.saved_value
|
self.value = self.saved_value
|
||||||
raise gdb.GdbError('Failed to validate')
|
raise gdb.GdbError('Failed to validate')
|
||||||
self.saved_value = self.value
|
self.saved_value = self.value
|
||||||
|
return ""
|
||||||
@end smallexample
|
@end smallexample
|
||||||
@end defun
|
@end defun
|
||||||
|
|
||||||
|
@ -368,11 +368,10 @@ call_doc_function (PyObject *obj, PyObject *method, PyObject *arg)
|
|||||||
}
|
}
|
||||||
|
|
||||||
/* A callback function that is registered against the respective
|
/* A callback function that is registered against the respective
|
||||||
add_setshow_* set_doc prototype. This function will either call
|
add_setshow_* set_doc prototype. This function calls the Python function
|
||||||
the Python function "get_set_string" or extract the Python
|
"get_set_string" if it exists, which will return a string. That string
|
||||||
attribute "set_doc" and return the contents as a string. If
|
is then printed. If "get_set_string" does not exist, or returns an
|
||||||
neither exist, insert a string indicating the Parameter is not
|
empty string, then nothing is printed. */
|
||||||
documented. */
|
|
||||||
static void
|
static void
|
||||||
get_set_value (const char *args, int from_tty,
|
get_set_value (const char *args, int from_tty,
|
||||||
struct cmd_list_element *c)
|
struct cmd_list_element *c)
|
||||||
|
Loading…
Reference in New Issue
Block a user