Re: [PATCH] Install and generate docs for gdb-add-index

Eli Zaretskii
2018-01-12T18:39:56Z

> From: Sergio Durigan Junior <sergiodj@redhat.com>
> Cc: gdb-patches@sourceware.org, tom@tromey.com
> Date: Fri, 12 Jan 2018 11:58:39 -0500
>
> >> +@code{.gdb_index}. Note that the index is never generated for files that do
> > ^^^^^^^^^^^^^^^^^
> > File names should have the @file markup.
>
> This refers to a section name, not a file name. Should it still be
> marked as @file?

No, it's my bad. @code is fine.

> >> +not contain DWARF debug information (sections named @code{.debug_*}).
> >
> > I think this sentence is too obscure. I think we should say
> > explicitly that the index can only be produced on systems which use
> > ELF binaries and DWARF debug info. E.g., users of GDB on MS-Windows
> > should understand from this that they cannot use this feature.
>
> Here's how I've rewritten this part:
>
> To determine whether a file contains such an index, use the command
> @kbd{readelf -S filename}: the index is stored in a section named
> @code{.gdb_index}. The index file can only be produced on systems
> which use ELF binaries and DWARF debug information (i.e., sections
> named @code{.debug_*}).

Looks good, thanks.