From 763b8efdcc0ab0f94f7af48792eb5c97b6eca41b Mon Sep 17 00:00:00 2001 From: Andrew Burgess Date: Thu, 18 Mar 2021 16:44:14 +0000 Subject: 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. --- gdb/python/py-param.c | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'gdb/python/py-param.c') diff --git a/gdb/python/py-param.c b/gdb/python/py-param.c index 49819ce..ab9e883 100644 --- a/gdb/python/py-param.c +++ b/gdb/python/py-param.c @@ -368,11 +368,10 @@ call_doc_function (PyObject *obj, PyObject *method, PyObject *arg) } /* A callback function that is registered against the respective - add_setshow_* set_doc prototype. This function will either call - the Python function "get_set_string" or extract the Python - attribute "set_doc" and return the contents as a string. If - neither exist, insert a string indicating the Parameter is not - documented. */ + add_setshow_* set_doc prototype. This function calls the Python function + "get_set_string" if it exists, which will return a string. That string + is then printed. If "get_set_string" does not exist, or returns an + empty string, then nothing is printed. */ static void get_set_value (const char *args, int from_tty, struct cmd_list_element *c) -- cgit v1.1