Re: [PATCH 5/5] btrace: maintenance commands

[Eli Zaretskii <eliz at gnu dot org>]

> From: Markus Metzger <markus.t.metzger@intel.com>
> Cc: gdb-patches@sourceware.org, Eli Zaretskii <eliz@gnu.org>
> Date: Tue, 23 Jun 2015 10:16:58 +0200
> 
> Add maintenance commands that help debugging the btrace record target.

Thanks.

> +  add_setshow_boolean_cmd ("skip-pad", class_maintenance,
> +			   &maint_btrace_pt_skip_pad, _("\
> +Set whether PAD packets should be skipped in the btrace packet history."), _("\
> +Show whether PAD packets should be skipped in the btrace packet history."),_("\
> +When enabled, PAD packets are ignored when processing the trace to compute \
> +the btrace packet history.\n\

This line is too long to fit on a standard text terminal.  Is that
necessary?

> +This does not modify the already computed packet history.  Use 'maintenance \
> +btrace clear-packet-history' to clear and recompute the existing history."),

Same here (and in a few more places).

> +	   _("Prints the raw branch tracing data.\n\

I think we use "Print", not "Prints".  (Again, there are other doc
strings in the patch with the same issue.)

> +execution history for the @samp{record btrace} command.  The
> +information printed as well as the format depends on the btrace
> +recording format.

"Both the information and the format in which it is printed depend
on ..."

> +@table @code
> +@item bts
> +For the BTS recording format, it prints a list of blocks of sequential

"print" instead of "it prints" -- this matches the style of the
previous sentences.

> +code.  For each block, the following information is printed:
> +
> +@table @code

@code is inappropriate here, I suggest to use @asis instead.

> +@item The block number

I'd lose the "The" part, it's redundant in a table.

The documentation parts are OK with those fixed.