Add a note on how to create an empty target and use it to attach to

processes whose executables you don't know up front.

llvm-svn: 259396

1 files changed, 10 insertions, 0 deletions

diff --git a/lldb/scripts/interface/SBDebugger.i b/lldb/scripts/interface/SBDebugger.i
index 89b2882aeb9..db774d350e9 100644
--- a/lldb/scripts/interface/SBDebugger.i
+++ b/lldb/scripts/interface/SBDebugger.i
@@ -105,6 +105,16 @@ if target:
         else:
             print('Unexpected process state: %s, killing process...' % debugger.StateAsCString (state))
             process.Kill()
+
+Sometimes you need to create an empty target that will get filled in later.  The most common use for this
+is to attach to a process by name or pid where you don't know the executable up front.  The most convenient way
+to do this is:
+
+target = debugger.CreateTarget('')
+error = lldb.SBError()
+process = target.AttachToProcessWithName(debugger.GetListener(), 'PROCESS_NAME', False, error)
+
+or the equivalent arguments for AttachToProcessWithID.
 ") SBDebugger;
 class SBDebugger
 {