Re: [PATCH] tracepoint: add new trace command "printf"[3] doc

[Eli Zaretskii <eliz@gnu.org>]

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