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