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.
This commit is contained in:
Ciro Santilli 2015-07-23 06:36:25 -07:00 committed by Joel Brobecker
parent d0d8478068
commit 7b849db4f2
2 changed files with 12 additions and 4 deletions

View File

@ -1,3 +1,11 @@
2015-07-23 Ciro Santilli <ciro.santilli@gmail.com> (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 <derodat@adacore.com> 2015-07-23 Pierre-Marie de Rodat <derodat@adacore.com>
* gdbtypes.c (resolve_dynamic_array): Pass the peeled element * gdbtypes.c (resolve_dynamic_array): Pass the peeled element

View File

@ -227,8 +227,8 @@ ltpy_has_line (PyObject *self, PyObject *args)
Py_RETURN_FALSE; Py_RETURN_FALSE;
} }
/* Implementation of gdb.LineTable.source_lines (self) -> FrozenSet. /* Implementation of gdb.LineTable.source_lines (self) -> List.
Returns a Python FrozenSet that contains source line entries in the Returns a Python List that contains source line entries in the
line table. This function will just return the source lines line table. This function will just return the source lines
without corresponding addresses. */ without corresponding addresses. */
@ -488,8 +488,8 @@ Return executable locations for a given source line." },
"has_line (lineno) -> Boolean\n\ "has_line (lineno) -> Boolean\n\
Return TRUE if this line has executable information, FALSE if not." }, Return TRUE if this line has executable information, FALSE if not." },
{ "source_lines", ltpy_get_all_source_lines, METH_NOARGS, { "source_lines", ltpy_get_all_source_lines, METH_NOARGS,
"source_lines () -> FrozenSet\n\ "source_lines () -> List\n\
Return a frozen set of all executable source lines." }, Return a list of all executable source lines." },
{ "is_valid", ltpy_is_valid, METH_NOARGS, { "is_valid", ltpy_is_valid, METH_NOARGS,
"is_valid () -> Boolean.\n\ "is_valid () -> Boolean.\n\
Return True if this Linetable is valid, False if not." }, Return True if this Linetable is valid, False if not." },