[PATCH] [doc] Update gdb-add-index manpage

Eli Zaretskii eliz@gnu.org
Mon Dec 16 20:07:28 GMT 2024


> From: Keith Seitz <keiths@redhat.com>
> Date: Mon, 16 Dec 2024 11:39:53 -0800
> 
> The current gdb-add-index manual page is a bit out-of-date.  This
> commit fixes a few deficiencies:
> 
> - gdb-add-index does not use objdump; it uses objcopy and readelf
> - missing info on environment variables (in appropriate ENVIRONMENT section).
> - missing mention of -dwarf-5 option
> - adds important notice about FILENAME being writable
> - explains exit status
> ---
>  gdb/doc/gdb.texinfo | 41 ++++++++++++++++++++++++++++++++++++-----
>  1 file changed, 36 insertions(+), 5 deletions(-)

Thanks for doing this.

> +@command{gdb-add-index} uses @value{GDBN}, @command{objcopy}, and
> +@command{readelf} found in the @env{PATH} environment variable.  If
> +you uwant to use different versions of these programs, you can specify
       ^^^^^
Typo.

> +@table @env
> +@item -dwarf-5
> +Output files for a DWARF 5 @code{.debug_names} section.

This begs the question: what is the default if -dwarf-5 is not
specified?

> +@c man begin ENVIRONMENT gdb-add-index
> +@table @env
> +@item @env{GDB}
         ^^^^
You don't need @env here, since that's the default for this @table.

OK with those nits fixed.

Approved-By: Eli Zaretskii <eliz@gnu.org>


More information about the Gdb-patches mailing list