Re: [rfc] Shared libraries over the remote protocol, take two

Eli Zaretskii
2007-06-18T20:05:17Z

> Date: Mon, 18 Jun 2007 11:02:11 -0400
> From: Daniel Jacobowitz <drow@false.org>
> Cc: Ulrich Weigand <uweigand@de.ibm.com>, Pedro Alves <pedro_alves@portugalmail.pt>
>
> Index: gdb/NEWS
> ===================================================================
> --- gdb/NEWS.orig 2007-06-18 10:15:05.000000000 -0400
> +++ gdb/NEWS 2007-06-18 10:15:14.000000000 -0400

This is fine, thanks.

> --- gdb/doc/gdb.texinfo.orig 2007-06-18 10:15:05.000000000 -0400
> +++ gdb/doc/gdb.texinfo 2007-06-18 10:15:14.000000000 -0400

This is also fine, but...

> +The currently defined stop reasons are:
> +
> +@itemize @bullet
> +@item
> +If @var{n} is @samp{watch}, @samp{rwatch}, or @samp{awatch}, then the
> +packet indicates a watchpoint hit, and @var{r} is the data address, in
> +hex.
> +
> +@item
> +@cindex shared library events, remote reply
> +If @var{n} is @samp{library}, then the packet indicates that the
> +loaded libraries have changed. @value{GDBN} should use
> +@samp{qXfer:libraries:read} to fetch a new list of loaded libraries.
> +@var{r} is ignored.
> +@end itemize

I think using @itemize and conditional sentences like this is not the
very elegant and concise way of saying things. Compare with this
alternative:

The currently defined stop reasons are:

@table @samp
@item watch
@itemx rwatch
@itemx awatch
The packet indicates a watchpoint hit, and @var{r} is the data address, in
hex.

@cindex shared library events, remote reply
@item library
The packet indicates that the loaded libraries have changed.
@value{GDBN} should use @samp{qXfer:libraries:read} to fetch a new
list of loaded libraries. @var{r} is ignored.
@end table

I think this is better, as it makes the stop reasons stand out in a
more clear way. Do you agree?