From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-49473-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 31133 invoked by alias); 18 Jun 2007 20:05:17 -0000
Received: (qmail 31119 invoked by uid 22791); 18 Jun 2007 20:05:16 -0000
X-Spam-Check-By: sourceware.org
Received: from nitzan.inter.net.il (HELO nitzan.inter.net.il) (213.8.233.22)     by sourceware.org (qpsmtpd/0.31) with ESMTP; Mon, 18 Jun 2007 20:05:13 +0000
Received: from HOME-C4E4A596F7 (IGLD-80-230-206-181.inter.net.il [80.230.206.181]) 	by nitzan.inter.net.il (MOS 3.7.3a-GA) 	with ESMTP id HAD75652 (AUTH halo1); 	Mon, 18 Jun 2007 23:02:50 +0300 (IDT)
Date: Mon, 18 Jun 2007 20:05:00 -0000
Message-Id: <uzm2xqbdo.fsf@gnu.org>
From: Eli Zaretskii <eliz@gnu.org>
To: Daniel Jacobowitz <drow@false.org>
CC: gdb-patches@sourceware.org, uweigand@de.ibm.com,         pedro_alves@portugalmail.pt
In-reply-to: <20070618150211.GA23415@caradoc.them.org> (message from Daniel 	Jacobowitz on Mon, 18 Jun 2007 11:02:11 -0400)
Subject: Re: [rfc] Shared libraries over the remote protocol, take two
Reply-to: Eli Zaretskii <eliz@gnu.org>
References:  <20070618150211.GA23415@caradoc.them.org>
X-IsSubscribed: yes
Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm
Precedence: bulk
List-Id: <gdb-patches.sourceware.org>
List-Subscribe: <mailto:gdb-patches-subscribe@sourceware.org>
List-Archive: <http://sourceware.org/ml/gdb-patches/>
List-Post: <mailto:gdb-patches@sourceware.org>
List-Help: <mailto:gdb-patches-help@sourceware.org>, <http://sourceware.org/ml/#faqs>
Sender: gdb-patches-owner@sourceware.org
X-SW-Source: 2007-06/txt/msg00346.txt.bz2

> 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?