Re: [PATCH 6/6] Documentation.

Eli Zaretskii
2011-08-20T08:34:53Z

> From: Sanjoy Das <sanjoy@playingwithpointers.com>
> Cc: Sanjoy Das <sanjoy@playingwithpointers.com>
> Date: Sat, 20 Aug 2011 11:57:15 +0530
>
> +such a parser. More specific details can be found in the file
> +@file{gdb/jit-reader.h.in}.

The file name needs an update, I think.

> +The reader is implemented as a shared object. Two new @value{GDBN}
> +commands, @code{load-jit-reader} and @code{unload-jit-reader} are
> +added, to be used to load and unload the readers from a preconfigured
^^^^^
"provided" is better, especially if the manual is read a year from now ;-)

> +@node Using Readers
> +@subsection Using Readers
> +@kindex load-jit-reader
> +@kindex unload-jit-reader
> +
> +Readers can be loaded and unloaded using the @code{load-jit-reader}
> +and @code{unload-jit-reader} commands.
> +
> +@table @code
> +@kindex load-jit-reader
> +@item load-jit-reader @var{reader-name}

Please leave only one @kindex, the one that's immediately before the
command description.

In general, it is not useful to have identical or very similar index
entries that point to the same page in the document. They just
inflate the index without adding any benefits for the reader who uses
the index to quickly find the information she is after.

> +in @value{GDBN} reporting an error. A new JIT reader can be loaded by
> +first unloading the current one using @code{unload-jit-reader} and
> +then running @code{load-jit-reader}.
^^^^^^^
"invoking" is better here.

> +@node Writing Readers
> +@subsection Writing Readers

Suggest a less general name like "Writing JIT Readers".

> +@findex gdb_init_reader
> +
> +@smallexample

Please don't leave an empty line between the index entries and the
text they index.

> +@cindex @code{struct gdb_reader_funcs}
> +
> +@code{struct gdb_reader_funcs} contains a set of pointers to callback

Same here.

> +reader is being unloaded (@code{destroy}). The struct looks like this
^^
Need two spaces here.

Okay with those changes.

Thanks.