From d050f7d7f474c7e3ba26902a9cbb185910921a11 Mon Sep 17 00:00:00 2001
From: Tim Wiederhake <tim.wiederhake@intel.com>
Date: Tue, 2 May 2017 11:35:54 +0200
Subject: Python: Introduce gdb.Instruction class

This adds a generic instruction class to Python and has gdb.RecordInstruction
inherit from it.
---
 gdb/doc/python.texi | 40 +++++++++++++++++++++-------------------
 1 file changed, 21 insertions(+), 19 deletions(-)

(limited to 'gdb/doc/python.texi')

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index da579fc..ee4f7a2 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -3149,40 +3149,42 @@ A @code{gdb.Record} object has the following methods:
 Move the replay position to the given @var{instruction}.
 @end defun
 
-A @code{gdb.RecordInstruction} object has the following attributes:
+The common @code{gdb.Instruction} class that recording method specific
+instruction objects inherit from, has the following attributes:
 
-@defvar RecordInstruction.number
-An integer identifying this instruction.  @var{number} corresponds to
-the numbers seen in @code{record instruction-history}
-(@pxref{Process Record and Replay}).
-@end defvar
-
-@defvar RecordInstruction.sal
-A @code{gdb.Symtab_and_line} object representing the associated symtab
-and line of this instruction.  May be @code{None} if no debug information is
-available.
-@end defvar
-
-@defvar RecordInstruction.pc
+@defvar Instruction.pc
 An integer representing this instruction's address.
 @end defvar
 
-@defvar RecordInstruction.data
+@defvar Instruction.data
 A buffer with the raw instruction data.  In Python 3, the return value is a
 @code{memoryview} object.
 @end defvar
 
-@defvar RecordInstruction.decoded
+@defvar Instruction.decoded
 A human readable string with the disassembled instruction.
 @end defvar
 
-@defvar RecordInstruction.size
+@defvar Instruction.size
 The size of the instruction in bytes.
 @end defvar
 
+Additionally @code{gdb.RecordInstruction} has the following attributes:
+
+@defvar RecordInstruction.number
+An integer identifying this instruction.  @code{number} corresponds to
+the numbers seen in @code{record instruction-history}
+(@pxref{Process Record and Replay}).
+@end defvar
+
+@defvar RecordInstruction.sal
+A @code{gdb.Symtab_and_line} object representing the associated symtab
+and line of this instruction.  May be @code{None} if no debug information is
+available.
+@end defvar
+
 @defvar RecordInstruction.is_speculative
-A boolean indicating whether the instruction was executed
-speculatively.
+A boolean indicating whether the instruction was executed speculatively.
 @end defvar
 
 If an error occured during recording or decoding a recording, this error is
-- 
cgit v1.1