[PATCH v3.1 2/5] DWARF-5: .debug_names index producer

[Eli Zaretskii]

> Date: Thu, 22 Jun 2017 20:35:42 +0200
> From: Jan Kratochvil <jan.kratochvil@redhat.com>
> Cc: gdb-patches@sourceware.org, vleschuk@accesssoftek.com
> 
> -@item save gdb-index @var{directory}
> +@item save gdb-index [-dwarf-4] @var{directory}
>  @kindex save gdb-index
>  Create an index file for each symbol file currently known by
>  @value{GDBN}.  Each file is named after its corresponding symbol file,
> -with @samp{.gdb-index} appended, and is written into the given
> -@var{directory}.
> +with @file{.debug_names} and @file{.debug_str} (or @file{.gdb-index}
> +from @code{-dwarf-4} option for older index consumers) appended, and is written
> +into the given @var{directory}.
>  @end table

Given your explanations, I suggest to reword this:

  Create index files for all symbol files currently known by
  @value{GDBN}.  For each known @var{symbol-file}, this command
  by default creates 2 files: @file{@var{symbol-file}.debug_names}
  and @file{@var{symbol-file}.debug_str}.  If you invoke this
  command with the @option{-dwarf-4} option, it produces a single
  file @file{@var{symbol-file}.gdb-index}.  The files are created
  in the given @var{directory}.

Otherwise, the documentation parts are fine, thanks.