Re: [3/4] RFC: add DWARF index support

[Eli Zaretskii <eliz at gnu dot org>]

> From: Tom Tromey <tromey@redhat.com>
> Cc: gdb-patches@sourceware.org
> Date: Thu, 08 Jul 2010 11:00:45 -0600
> 
> +@node Index Files
> +@section Index Files Speed Up GDB
                                 ^^^
Should be "@value{GDBN}".

> +@cindex @file{.gnu-index} file
                 ^^^^^^^^^^
".gdb-index", I believe.

> +When @value{GDBN} finds a symbol file, it scans the symbols in the
> +file in order to construct an internal symbol table.  This lets most
> +@value{GDBN} operations work quickly----at the cost of a delay early
                                       ^^^^
One dash too much.

> +To create an index file, use the @code{maint save-gdb-index} command:

Why are we putting this command in the "maint" class?  It sounds like
a first-class user-level feature, not a GDB maintainer's feature.

> +@item maint save-gdb-index @var{directory}
> +@kindex maint 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
> +directory.
   ^^^^^^^^^
"@var{directory}"

Btw, why isn't this argument optional?

> +@smallexample
> +$ objcopy --add-section .gdb_index=symfile.gdb-index --set-section-flags .gdb_index=readonly symfile symfile
> +@end smallexample

This line is too long for @smallexample, please split it into two
(with a backslash between them).

> +  out_file = fopen (filename, "w");

This should use "wb", I believe, or it will not DTRT on DOS/Windows.

> +  add_cmd ("save-gdb-index", class_maintenance, save_gdb_index_command,
> +	   _("Save the a .gdb-index file"),
                   ^^^^^
"the" or "a"?

Thanks.