[binutils-gdb] btrace: add instruction-history /s and fix documentation

[Markus Metzger <mmetzger at sourceware dot org>]

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=0c532a298058669a72061ad94ba9e24170ae91ae

commit 0c532a298058669a72061ad94ba9e24170ae91ae
Author: Markus Metzger <markus.t.metzger@intel.com>
Date:   Fri Sep 11 10:09:54 2015 +0200

    btrace: add instruction-history /s and fix documentation
    
    Add support for the /s modifier of the "record instruction-history" command.  It
    behaves exactly like /m and prints disassembled instructions in the order in
    which they were recorded with interleaved sources.  We accept /s in addition
    to /m to align with the "disassemble" command.
    
    The "record instruction-history" modifiers were not documented.  Document
    all of them.
    
    gdb/
    	* record.c (get_insn_history_modifiers): Set DISASSEMBLY_SOURCE
    	instead of DISASSEMBLY_SOURCE_DEPRECATED.  Also accept /s.
    	(_initialize_record): Document the /s modifier.
    	* NEWS: Announce record instruction-history's new /s modifier.
    
    doc/
    	* gdb.texinfo (Process Record and Replay): Document "record
    	instruction-history" modifiers.

Diff:
---
 gdb/ChangeLog       |  7 +++++++
 gdb/NEWS            |  3 +++
 gdb/doc/ChangeLog   |  5 +++++
 gdb/doc/gdb.texinfo | 14 ++++++++++++++
 gdb/record.c        |  5 +++--
 5 files changed, 32 insertions(+), 2 deletions(-)

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index f805e50..a95fe4c 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,5 +1,12 @@
 2015-11-04  Markus Metzger  <markus.t.metzger@intel.com>
 
+	* record.c (get_insn_history_modifiers): Set DISASSEMBLY_SOURCE
+	instead of DISASSEMBLY_SOURCE_DEPRECATED.  Also accept /s.
+	(_initialize_record): Document the /s modifier.
+	* NEWS: Announce record instruction-history's new /s modifier.
+
+2015-11-04  Markus Metzger  <markus.t.metzger@intel.com>
+
 	* record-btrace.c (struct btrace_line_range): New.
 	(btrace_mk_line_range, btrace_line_range_add)
 	(btrace_line_range_is_empty, btrace_line_range_contains_range)
diff --git a/gdb/NEWS b/gdb/NEWS
index b2b1e99..78d1328 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -51,6 +51,9 @@ show remote multiprocess-extensions-packet
   The "/m" option is now considered deprecated: its "source-centric"
   output hasn't proved useful in practice.
 
+* The "record instruction-history" command accepts a new modifier: /s.
+  It behaves exactly like /m and prints mixed source+disassembly.
+
 * The "set scheduler-locking" command supports a new mode "replay".
   It behaves like "off" in record mode and like "on" in replay mode.
 
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 4c1697d..ddf3ae5 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,8 @@
+2015-11-04  Markus Metzger  <markus.t.metzger@intel.com>
+
+	* gdb.texinfo (Process Record and Replay): Document "record
+	instruction-history" modifiers.
+
 2015-10-12  Andrew Burgess  <andrew.burgess@embecosm.com>
 
 	* gdb.texinfo (Frames): Remove 'frame' and 'select-frame'
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 3c1f785..254403d 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -6741,6 +6741,20 @@ default, ten instructions are disassembled.  This can be changed using
 the @code{set record instruction-history-size} command.  Instructions
 are printed in execution order.
 
+It can also print mixed source+disassembly if you specify the the
+@code{/m} or @code{/s} modifier, and print the raw instructions in hex
+as well as in symbolic form by specifying the @code{/r} modifier.
+
+The current position marker is printed for the instruction at the
+current program counter value.  This instruction can appear multiple
+times in the trace and the current position marker will be printed
+every time.  To omit the current position marker, specify the
+@code{/p} modifier.
+
+To better align the printed instructions when the trace contains
+instructions from more than one function, the function name may be
+omitted by specifying the @code{/f} modifier.
+
 Speculatively executed instructions are prefixed with @samp{?}.  This
 feature is not available for all recording formats.
 
diff --git a/gdb/record.c b/gdb/record.c
index 71ef973..b06bec7 100644
--- a/gdb/record.c
+++ b/gdb/record.c
@@ -458,7 +458,8 @@ get_insn_history_modifiers (char **arg)
 	  switch (*args)
 	    {
 	    case 'm':
-	      modifiers |= DISASSEMBLY_SOURCE_DEPRECATED;
+	    case 's':
+	      modifiers |= DISASSEMBLY_SOURCE;
 	      modifiers |= DISASSEMBLY_FILENAME;
 	      break;
 	    case 'r':
@@ -817,7 +818,7 @@ Argument is instruction number, as shown by 'info record'."),
 
   add_cmd ("instruction-history", class_obscure, cmd_record_insn_history, _("\
 Print disassembled instructions stored in the execution log.\n\
-With a /m modifier, source lines are included (if available).\n\
+With a /m or /s modifier, source lines are included (if available).\n\
 With a /r modifier, raw instructions in hex are included.\n\
 With a /f modifier, function names are omitted.\n\
 With a /p modifier, current position markers are omitted.\n\