RE: [PATCH 03/10] btrace: Enable auxiliary instructions in record function-call-history.

["Willgerodt, Felix" <felix.willgerodt@intel.com>]

Markus> I agree this output looks nice.  One problem with it, though, is that the user asked
Markus> for 4 lines of output and we give 8.

I had assumed this is only about functions, not lines. According to the docs:

record function-call-history begin, end
Prints functions beginning with function number begin until function number end.
The function number end is included.

The docs mention mostly functions, but are a bit inconsistent and mention lines occasionally.
Which is understandable, as they are equivalent without my patches.
The size setting only mentions lines, I didn't realize that before:

set record function-call-history-size size
set record function-call-history-size unlimited
Define how many lines to print in the record function-call-history command. (...)

For the instruction-history the docs don't ever mention lines, e.g.: 

set record instruction-history-size size
set record instruction-history-size unlimited
Define how many instructions to disassemble in the record instruction-history command. (...)

I propose to update the documentation to not mention lines (but functions) for
'set record function-call-history-size'. I know changing "existing documented behavior" is
usually not the best idea, but in my view it clearly improves usability in this case. 
It could be seen as improving the docs - not changing behavior - anyway, as they are inconsistent.
What do you think?

Regards,
Felix


Intel Deutschland GmbH
Registered Address: Am Campeon 10, 85579 Neubiberg, Germany
Tel: +49 89 99 8853-0, www.intel.de <http://www.intel.de>
Managing Directors: Christin Eisenschmid, Sharon Heck, Tiffany Doon Silva  
Chairperson of the Supervisory Board: Nicole Lau
Registered Office: Munich
Commercial Register: Amtsgericht Muenchen HRB 186928