From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-78351-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 4359 invoked by alias); 17 Feb 2011 11:41:21 -0000
Received: (qmail 4350 invoked by uid 22791); 17 Feb 2011 11:41:20 -0000
X-SWARE-Spam-Status: No, hits=-2.0 required=5.0	tests=AWL,BAYES_00,T_RP_MATCHES_RCVD
X-Spam-Check-By: sourceware.org
Received: from fencepost.gnu.org (HELO fencepost.gnu.org) (140.186.70.10)    by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Thu, 17 Feb 2011 11:41:12 +0000
Received: from eliz by fencepost.gnu.org with local (Exim 4.71)	(envelope-from <eliz@gnu.org>)	id 1Pq2EN-0004ac-Qe; Thu, 17 Feb 2011 06:41:07 -0500
Date: Thu, 17 Feb 2011 14:40:00 -0000
Message-Id: <E1Pq2EN-0004ac-Qe@fencepost.gnu.org>
From: Eli Zaretskii <eliz@gnu.org>
To: Hui Zhu <teawater@gmail.com>
CC: tromey@redhat.com, gdb-patches@sourceware.org, dje@google.com,	stan@codesourcery.com, msnyder@vmware.com
In-reply-to: <AANLkTingH93q9-j9dRBGX_qLctD6NYiSKYVyoPG44ENW@mail.gmail.com>	(message from Hui Zhu on Thu, 17 Feb 2011 16:13:11 +0800)
Subject: Re: [PATCH] tracepoint: add new trace command "printf"[3] doc
Reply-to: Eli Zaretskii <eliz@gnu.org>
References: <AANLkTingH93q9-j9dRBGX_qLctD6NYiSKYVyoPG44ENW@mail.gmail.com>
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: 2011-02/txt/msg00418.txt.bz2

> From: Hui Zhu <teawater@gmail.com>
> Date: Thu, 17 Feb 2011 16:13:11 +0800
> Cc: Doug Evans <dje@google.com>, Stan Shebs <stan@codesourcery.com>, 
> 	Michael Snyder <msnyder@vmware.com>
> 
> This is the patch for the doc for the tracepoint command printf and
> agent op printf.

Thanks.

> +Print the values in the stack under the control of the string template.

"on the stack", not "in".

Also, you say "values" here, but the rest of the description talks
about one value at most.  Which one is right?

I would remove "the" before "control".

Finally, "template" should be in @var.

> +The end of @var{template} is 0x00.

Not clear what you mean here.  Do you mean that "template" is a
null-terminated string?

> +If @var{n} is 0, just output the string template.
> +If @var{n} is 1, pop a value from the stack and print it under the control
> +of the string template.

Same comments as above: remove "the" before "control" and put
"template" in @var.

> +@kindex printf

We already have one such @kindex entry.  Please change this one to

  @kindex printf, in tracepoint actions

> +@item printf @var{template}, @var{expressions}@dots{}
> +Print the values of one or more @var{expressions} under the control of

"under control", without "the".

> +the string @var{template} in @code{gdbserver} part.

I don't understand what do you mean by "in @code{gdbserver} part".

> +The command format is with simple @code{printf} (@pxref{Output, printf}).

Please rephrase as

  @var{template} is a format string of the same form as used with the
  @value{GDBN} command @code{printf} (@pxref{Output, printf}).

Thanks.