From 7b849db4f213d6734b4121ca5e5cab3341a5140c Mon Sep 17 00:00:00 2001 From: Ciro Santilli Date: Thu, 23 Jul 2015 06:36:25 -0700 Subject: [PATCH] py-linetable.c: Fix doc of LineTable.source_lines' return type The ltpy_get_all_source_lines function, use to implement the gdb.LineTable.source_lines method, returns a list: source_list = PyDict_Keys (source_dict); return source_list; This patch fixes the function's documentation as well as its docstring to say that it returns a list rather than a FrozenSet. gdb/ChangeLog: * py-linetable.c (ltpy_get_all_source_lines): Adjust function documentation to say that it returns a list rather than a FrozenSet. (linetable_object_methods): Update the docstring of the "source_line" entry. Tested on x86_64-linux. --- gdb/ChangeLog | 8 ++++++++ gdb/python/py-linetable.c | 8 ++++---- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/gdb/ChangeLog b/gdb/ChangeLog index 78096ab..ecc7f55 100644 --- a/gdb/ChangeLog +++ b/gdb/ChangeLog @@ -1,3 +1,11 @@ +2015-07-23 Ciro Santilli (tiny patch) + + * py-linetable.c (ltpy_get_all_source_lines): Adjust function + documentation to say that it returns a list rather than + a FrozenSet. + (linetable_object_methods): Update the docstring of the + "source_line" entry. + 2015-07-23 Pierre-Marie de Rodat * gdbtypes.c (resolve_dynamic_array): Pass the peeled element diff --git a/gdb/python/py-linetable.c b/gdb/python/py-linetable.c index 195a8b3..82b4cfc 100644 --- a/gdb/python/py-linetable.c +++ b/gdb/python/py-linetable.c @@ -227,8 +227,8 @@ ltpy_has_line (PyObject *self, PyObject *args) Py_RETURN_FALSE; } -/* Implementation of gdb.LineTable.source_lines (self) -> FrozenSet. - Returns a Python FrozenSet that contains source line entries in the +/* Implementation of gdb.LineTable.source_lines (self) -> List. + Returns a Python List that contains source line entries in the line table. This function will just return the source lines without corresponding addresses. */ @@ -488,8 +488,8 @@ Return executable locations for a given source line." }, "has_line (lineno) -> Boolean\n\ Return TRUE if this line has executable information, FALSE if not." }, { "source_lines", ltpy_get_all_source_lines, METH_NOARGS, - "source_lines () -> FrozenSet\n\ -Return a frozen set of all executable source lines." }, + "source_lines () -> List\n\ +Return a list of all executable source lines." }, { "is_valid", ltpy_is_valid, METH_NOARGS, "is_valid () -> Boolean.\n\ Return True if this Linetable is valid, False if not." }, -- 2.7.4