[Lldb-commits] [lldb] r173107 - /lldb/trunk/docs/lldb-gdb-remote.txt

[Greg Clayton]

Author: gclayton
Date: Mon Jan 21 17:54:42 2013
New Revision: 173107

URL: http://llvm.org/viewvc/llvm-project?rev=173107&view=rev
Log:
Clear up the documentation for the "container-regs" and "invalidate-regs" key/value pair responses for qRegisterInfo with examples of single and multiple registers for each.


Modified:
    lldb/trunk/docs/lldb-gdb-remote.txt

Modified: lldb/trunk/docs/lldb-gdb-remote.txt
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/docs/lldb-gdb-remote.txt?rev=173107&r1=173106&r2=173107&view=diff
==============================================================================
--- lldb/trunk/docs/lldb-gdb-remote.txt (original)
+++ lldb/trunk/docs/lldb-gdb-remote.txt Mon Jan 21 17:54:42 2013
@@ -377,9 +377,17 @@
 			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".
+			contained in "rax" by specifying the register number for "rax" (whose
+			register number is 0x00)
 			
-			"container-regs:00,0a,3b;"
+			"container-regs:00;"
+			
+			If a register is comprised of one or more registers, like "d0" is ARM
+			which is a 64 bit register, it might be made up of "s0" and "s1". If
+			the register number for "s0" is 0x20, and the register number of "s1"
+			is "0x21", the "container-regs" key/value pair would be:
+			
+			"container-regs:20,21;"
 			
 			This is handy for defining what GDB used to call "pseudo" registers.
 			These registers are never requested by LLDB via the register read
@@ -391,9 +399,17 @@
 			leading "0x") register numbers.
 			
 			This specifies which register values should be invalidated when this
-			register is modified.
+			register is modified. For example if modifying "eax" would cause "rax",
+			"eax", "ax", "ah", and "al" to be modified  where rax is 0x0, eax is 15,
+			ax is 0x25, ah is 0x35, and al is 0x39, the "invalidate-regs" key/value
+			pair would be:
 
-			"invalidate-regs:01,0b,1e;"
+			"invalidate-regs:0,15,25,35,39;"
+			
+			If there is a single register that gets invalidated, then omit the comma
+			and just list a single register:
+			
+			"invalidate-regs:0;"
 			
 			This is handy when modifying a specific register can cause other
 			register values to change. For example, when debugging an ARM target,