This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH] python: fix Linetable case to LineTable in docstrings and comments
- From: Ciro Santilli <ciro dot santilli at gmail dot com>
- To: gdb-patches at sourceware dot org
- Date: Thu, 30 Jul 2015 14:34:14 +0200
- Subject: Re: [PATCH] python: fix Linetable case to LineTable in docstrings and comments
- Authentication-results: sourceware.org; auth=none
- References: <CAFXrp_enMwfrXoakPszHpKpUP8mpE2_sreq5Qc5D5LryjkMawQ at mail dot gmail dot com>
Ping.
On Sat, Jul 25, 2015 at 4:19 PM, Ciro Santilli <ciro.santilli@gmail.com> wrote:
> This annoyed me a bit when doing help(gdb) as searches would fail.
>
> Also profited to fix it the source comments as well to improve grepping.
>
> From 53bb5d1e5c65a361f0165c70cef4ab9f4b5a02f0 Mon Sep 17 00:00:00 2001
> From: Ciro Santilli <ciro.santilli@gmail.com>
> Date: Thu, 23 Jul 2015 20:21:30 +0200
> Subject: [PATCH] python: fix Linetable case to LineTable in docstrings and
> comments
>
> The class is called LineTable, not Linetable, as specified by
> py-linetable.c/gdbpy_initialize_linetable:
>
> if (gdb_pymodule_addobject (gdb_module, "LineTable",
>
> gdb:
>
> 2015-07-24 Ciro Santilli <ciro.santilli@gmail.com>
>
> * python/py-linetable.c: Fix case of Linetable to LineTable
> in docstrings and code comments.
> * python/py-symtab.c: Same.
> ---
> gdb/python/py-linetable.c | 14 +++++++-------
> gdb/python/py-symtab.c | 8 ++++----
> 2 files changed, 11 insertions(+), 11 deletions(-)
>
> diff --git a/gdb/python/py-linetable.c b/gdb/python/py-linetable.c
> index 82b4cfc..ff4414e 100644
> --- a/gdb/python/py-linetable.c
> +++ b/gdb/python/py-linetable.c
> @@ -55,7 +55,7 @@ typedef struct {
> extern PyTypeObject ltpy_iterator_object_type
> CPYCHECKER_TYPE_OBJECT_FOR_TYPEDEF ("ltpy_iterator_object");
>
> -/* Internal helper function to extract gdb.Symtab from a gdb.Linetable
> +/* Internal helper function to extract gdb.Symtab from a gdb.LineTable
> object. */
>
> static PyObject *
> @@ -288,7 +288,7 @@ ltpy_get_all_source_lines (PyObject *self, PyObject *args)
> return source_list;
> }
>
> -/* Implementation of gdb.Linetable.is_valid (self) -> Boolean.
> +/* Implementation of gdb.LineTable.is_valid (self) -> Boolean.
> Returns True if this line table object still exists in GDB. */
>
> static PyObject *
> @@ -349,7 +349,7 @@ gdbpy_initialize_linetable (void)
> return 0;
> }
>
> -/* Linetable entry object get functions. */
> +/* LineTable entry object get functions. */
>
> /* Implementation of gdb.LineTableEntry.line (self) -> Long. Returns
> a long integer associated with the line table entry. */
> @@ -373,7 +373,7 @@ ltpy_entry_get_pc (PyObject *self, void *closure)
> return gdb_py_object_from_longest (obj->pc);
> }
>
> -/* Linetable iterator functions. */
> +/* LineTable iterator functions. */
>
> /* Return a new line table iterator. */
>
> @@ -460,7 +460,7 @@ ltpy_iternext (PyObject *self)
> return NULL;
> }
>
> -/* Implementation of gdb.LinetableIterator.is_valid (self) -> Boolean.
> +/* Implementation of gdb.LineTableIterator.is_valid (self) -> Boolean.
> Returns True if this line table iterator object still exists in
> GDB. */
>
> @@ -492,7 +492,7 @@ Return TRUE if this line has executable
> information, FALSE if not." },
> 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." },
> +Return True if this LineTable is valid, False if not." },
> {NULL} /* Sentinel */
> };
>
> @@ -539,7 +539,7 @@ PyTypeObject linetable_object_type = {
> static PyMethodDef ltpy_iterator_methods[] = {
> { "is_valid", ltpy_iter_is_valid, METH_NOARGS,
> "is_valid () -> Boolean.\n\
> -Return True if this Linetable iterator is valid, False if not." },
> +Return True if this LineTable iterator is valid, False if not." },
> {NULL} /* Sentinel */
> };
>
> diff --git a/gdb/python/py-symtab.c b/gdb/python/py-symtab.c
> index 796a7fc..7c428a4 100644
> --- a/gdb/python/py-symtab.c
> +++ b/gdb/python/py-symtab.c
> @@ -207,8 +207,8 @@ stpy_static_block (PyObject *self, PyObject *args)
> return block_to_block_object (block, SYMTAB_OBJFILE (symtab));
> }
>
> -/* Implementation of gdb.Symtab.linetable (self) -> gdb.Linetable.
> - Returns a gdb.Linetable object corresponding to this symbol
> +/* Implementation of gdb.Symtab.linetable (self) -> gdb.LineTable.
> + Returns a gdb.LineTable object corresponding to this symbol
> table. */
>
> static PyObject *
> @@ -571,8 +571,8 @@ Return the global block of the symbol table." },
> "static_block () -> gdb.Block.\n\
> Return the static block of the symbol table." },
> { "linetable", stpy_get_linetable, METH_NOARGS,
> - "linetable () -> gdb.Linetable.\n\
> -Return the Linetable associated with this symbol table" },
> + "linetable () -> gdb.LineTable.\n\
> +Return the LineTable associated with this symbol table" },
> {NULL} /* Sentinel */
> };
>
> --
> 1.9.1