[PATCH 2/5] gdb/python: new gdb.architecture_names function
Eli Zaretskii
eliz@gnu.org
Thu Oct 14 06:52:18 GMT 2021
> From: Andrew Burgess <andrew.burgess@embecosm.com>
> Date: Wed, 13 Oct 2021 22:59:07 +0100
>
> Add a new function to the Python API, gdb.architecture_names(). This
> function returns a list containing all of the supported architecture
> names within the current build of GDB.
>
> The values returned in this list are all of the possible values that
> can be returned from gdb.Architecture.name().
> ---
> gdb/NEWS | 4 +++
> gdb/doc/python.texi | 9 +++++
> gdb/python/py-arch.c | 23 +++++++++++++
> gdb/python/python-internal.h | 1 +
> gdb/python/python.c | 4 +++
> gdb/testsuite/gdb.python/py-arch.exp | 51 ++++++++++++++++++++++++++++
> 6 files changed, 92 insertions(+)
The documentation parts are OK, with a single comment:
> +string. The names returned in this list are the same names as are
> +returned from @code{gdb.Architecture.name ()}
> +(@pxref{gdbpy_architecture_name,,Architecture.name ()}).
Please remove "()" from the references to functions and methods. This
usage of "()" to indicate a function is misleading, because it looks
like a call to a function with no arguments, and that's not what you
mean here. Texinfo's markup @code already indicates this is a symbol
and not just a word, so using the parentheses is unnecessary (and
IMNSHO ugly).
Thanks.
More information about the Gdb-patches
mailing list