xref: /llvm-project/lldb/bindings/interface/SBModuleSpecDocstrings.i (revision 662548c82683bd8657a3179afee693c4965a3dfd)
1*662548c8SAlex Langford %feature("docstring", "
2*662548c8SAlex Langford     Get const accessor for the module file.
3*662548c8SAlex Langford 
4*662548c8SAlex Langford     This function returns the file for the module on the host system
5*662548c8SAlex Langford     that is running LLDB. This can differ from the path on the
6*662548c8SAlex Langford     platform since we might be doing remote debugging.
7*662548c8SAlex Langford 
8*662548c8SAlex Langford     @return
9*662548c8SAlex Langford         A const reference to the file specification object."
10*662548c8SAlex Langford ) lldb::SBModuleSpec::GetFileSpec;
11*662548c8SAlex Langford 
12*662548c8SAlex Langford %feature("docstring", "
13*662548c8SAlex Langford     Get accessor for the module platform file.
14*662548c8SAlex Langford 
15*662548c8SAlex Langford     Platform file refers to the path of the module as it is known on
16*662548c8SAlex Langford     the remote system on which it is being debugged. For local
17*662548c8SAlex Langford     debugging this is always the same as Module::GetFileSpec(). But
18*662548c8SAlex Langford     remote debugging might mention a file '/usr/lib/liba.dylib'
19*662548c8SAlex Langford     which might be locally downloaded and cached. In this case the
20*662548c8SAlex Langford     platform file could be something like:
21*662548c8SAlex Langford     '/tmp/lldb/platform-cache/remote.host.computer/usr/lib/liba.dylib'
22*662548c8SAlex Langford     The file could also be cached in a local developer kit directory.
23*662548c8SAlex Langford 
24*662548c8SAlex Langford     @return
25*662548c8SAlex Langford         A const reference to the file specification object."
26*662548c8SAlex Langford ) lldb::SBModuleSpec::GetPlatformFileSpec;
27*662548c8SAlex Langford 
28*662548c8SAlex Langford %feature("docstring",
29*662548c8SAlex Langford "Represents a list of :py:class:`SBModuleSpec`."
30*662548c8SAlex Langford ) lldb::SBModuleSpecList;
31