Updated the LLDB qRegisterInfo documentation to contain information on the new "inval...
authorGreg Clayton <gclayton@apple.com>
Mon, 21 Jan 2013 23:18:28 +0000 (23:18 +0000)
committerGreg Clayton <gclayton@apple.com>
Mon, 21 Jan 2013 23:18:28 +0000 (23:18 +0000)
llvm-svn: 173102

lldb/docs/lldb-gdb-remote.txt

index e80af4f..68dc898 100644 (file)
@@ -370,6 +370,36 @@ generic     If the register is a generic register that most CPUs have, classify
              arg1 - arg8 (specified for registers that contain function 
                       arguments when the argument fits into a register)
 
+container-regs
+                       The value for this key is a comma separated list of decimal register
+                       numbers.
+
+                       This specifies that this register is contained in other concrete
+                       register values. For example "eax" is in the lower 32 bits of the
+                       "rax" register value for x86_64, so "eax" could specify that it is
+                       contained in "rax" by specifying the register number for "rax".
+                       
+                       "container-regs:0,1;"
+                       
+                       This is handy for defining what GDB used to call "pseudo" registers.
+                       These registers are never requested by LLDB via the register read
+                       or write packets, the container registers will be requested on behalf
+                       of this register.
+                       
+invalidate-regs
+                       The value for this key is a comma separated list of decimal register
+                       numbers.
+                       
+                       This specifies which register values should be invalidated when this
+                       register is modified.
+
+                       "invalidate-regs:1,2,3;"
+                       
+                       This is handy when modifying a specific register can cause other
+                       register values to change. For example, when debugging an ARM target,
+                       modifying the CPSR register can cause the r8 - r14 and cpsr value to
+                       change depending on if the mode has changed. 
+
 //----------------------------------------------------------------------
 // "qHostInfo"
 //