Author: jmolenda
Date: Mon Nov 17 23:43:11 2014
New Revision: 222225
URL: http://llvm.org/viewvc/llvm-project?rev=222225&view=rev
Log:
Add documentation for the SBTarget::ReadInstructions and
SBTarget::GetInstructions APIs so it's a little clearer to
understand which should be used.
<rdar://problem/18787018>
Modified:
lldb/trunk/scripts/Python/interface/SBTarget.i
Modified: lldb/trunk/scripts/Python/interface/SBTarget.i
URL:
http://llvm.org/viewvc/llvm-project/lldb/trunk/scripts/Python/interface/SBTarget.i?rev=222225&r1=222224&r2=222225&view=diff
==============================================================================
--- lldb/trunk/scripts/Python/interface/SBTarget.i (original)
+++ lldb/trunk/scripts/Python/interface/SBTarget.i Mon Nov 17 23:43:11 2014
@@ -868,16 +868,41 @@ public:
lldb::SBValue
CreateValueFromAddress (const char *name, lldb::SBAddress addr,
lldb::SBType type);
-
+
+ %feature("docstring", "
+ Disassemble a specified number of instructions starting at an address.
+ Parameters:
+ base_addr -- the address to start disassembly from
+ count -- the number of instructions to disassemble
+ flavor_string -- may be 'intel' or 'att' on x86 targets to specify
that style of disassembly
+ Returns an SBInstructionList.")
+ ReadInstructions;
lldb::SBInstructionList
ReadInstructions (lldb::SBAddress base_addr, uint32_t count);
lldb::SBInstructionList
ReadInstructions (lldb::SBAddress base_addr, uint32_t count, const char
*flavor_string);
+ %feature("docstring", "
+ Disassemble the bytes in a buffer and return them in an SBInstructionList.
+ Parameters:
+ base_addr -- used for symbolicating the offsets in the byte stream when
disassembling
+ buf -- bytes to be disassembled
+ size -- (C++) size of the buffer
+ Returns an SBInstructionList.")
+ GetInstructions;
lldb::SBInstructionList
GetInstructions (lldb::SBAddress base_addr, const void *buf, size_t size);
-
+
+ %feature("docstring", "
+ Disassemble the bytes in a buffer and return them in an SBInstructionList,
with a supplied flavor.
+ Parameters:
+ base_addr -- used for symbolicating the offsets in the byte stream when
disassembling
+ flavor -- may be 'intel' or 'att' on x86 targets to specify that
style of disassembly
+ buf -- bytes to be disassembled
+ size -- (C++) size of the buffer
+ Returns an SBInstructionList.")
+ GetInstructionsWithFlavor;
lldb::SBInstructionList
GetInstructionsWithFlavor (lldb::SBAddress base_addr, const char
*flavor_string, const void *buf, size_t size);
_______________________________________________
lldb-commits mailing list
[email protected]
http://lists.cs.uiuc.edu/mailman/listinfo/lldb-commits
