From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-109489-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 5840 invoked by alias); 18 Jan 2014 08:25:14 -0000
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
Received: (qmail 5825 invoked by uid 89); 18 Jan 2014 08:25:13 -0000
Authentication-Results: sourceware.org; auth=none
X-Virus-Found: No
X-Spam-SWARE-Status: No, score=-3.0 required=5.0 tests=AWL,BAYES_00,RCVD_IN_DNSWL_NONE,SPF_SOFTFAIL autolearn=no version=3.3.2
X-HELO: mtaout21.012.net.il
Received: from mtaout21.012.net.il (HELO mtaout21.012.net.il) (80.179.55.169) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Sat, 18 Jan 2014 08:25:12 +0000
Received: from conversion-daemon.a-mtaout21.012.net.il by a-mtaout21.012.net.il (HyperSendmail v2007.08) id <0MZL00M0086XCQ00@a-mtaout21.012.net.il> for gdb-patches@sourceware.org; Sat, 18 Jan 2014 10:25:09 +0200 (IST)
Received: from HOME-C4E4A596F7 ([87.69.4.28]) by a-mtaout21.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0MZL00M8X8PW3T70@a-mtaout21.012.net.il>; Sat, 18 Jan 2014 10:25:09 +0200 (IST)
Date: Sat, 18 Jan 2014 08:25:00 -0000
From: Eli Zaretskii <eliz@gnu.org>
Subject: Re: [PATCH 3/3, doc RFA] gdbserver debug_printf+timestamps: main patch
In-reply-to: <21209.45676.594470.76921@ruffy.mtv.corp.google.com>
To: Doug Evans <dje@google.com>
Cc: palves@redhat.com, yao@codesourcery.com, gdb-patches@sourceware.org
Reply-to: Eli Zaretskii <eliz@gnu.org>
Message-id: <83zjmtk87t.fsf@gnu.org>
References: <yjt2zjnztait.fsf@ruffy.mtv.corp.google.com> <52B1842F.5020401@redhat.com> <21205.55987.69477.892571@ruffy.mtv.corp.google.com> <52D81569.3080006@redhat.com> <CADPb22SK=YQeOcOdNPXERxXKOT2E64k=pHhw0GBiLj4LQhL-Ag@mail.gmail.com> <52D82AD5.7000306@redhat.com> <21208.27400.695984.88504@ruffy.mtv.corp.google.com> <21208.27945.781450.905336@ruffy.mtv.corp.google.com> <52D92610.4010202@redhat.com> <21209.45676.594470.76921@ruffy.mtv.corp.google.com>
X-IsSubscribed: yes
X-SW-Source: 2014-01/txt/msg00691.txt.bz2

> From: Doug Evans <dje@google.com>
> Date: Fri, 17 Jan 2014 14:45:00 -0800
> cc: gdb-patches <gdb-patches@sourceware.org>
> 
> --- a/gdb/NEWS
> +++ b/gdb/NEWS
> @@ -3,6 +3,14 @@
>  
>  *** Changes since GDB 7.7
>  
> +* New features in the GDB remote stub, GDBserver
> +
> +  ** New option --debug-format=option1[,option2,...] allows one to add
> +     additional text to each debugging message.  At present only timestamps
> +     are supported: --debug-format=timestamps.

I stumbled on "debugging message".  Why not say "to each output"
instead?

> +The @option{--debug-format=option1[,option2,...]} option tells
> +@code{gdbserver} to include additional information in each line of
> +debugging output.  Possible options are:

Again, "each line of debugging output" is somewhat vague.  (Aren't
there multi-line outputs, and if so, will gdbserver indeed precede
each of these lines with a timestamp?)  I hope we can find something
more clear.  Also, an example will help here.

Also, a @cindex entry here would be nice.

> @@ -44342,6 +44374,24 @@ Instruct @code{gdbserver} to display remote protocol debug output.
>  This option is intended for @code{gdbserver} development and for bug reports to
>  the developers.
>  
> +@item --debug-format=option1@r{[},option2,...@r{]}
> +Instruct @code{gdbserver} to include extra information in each line
> +of debugging output.
> +
> +Possible options are:

Why is this described twice?  I suggest to describe once, and leave a
cross-reference in the second place.

The documentation part is OK with these fixed.

Thanks.