xref: /freebsd-src/contrib/llvm-project/lldb/bindings/interface/SBPlatformDocstrings.i (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1*06c3fb27SDimitry Andric %feature("docstring",
2*06c3fb27SDimitry Andric "Describes how :py:class:`SBPlatform.ConnectRemote` connects to a remote platform."
3*06c3fb27SDimitry Andric ) lldb::SBPlatformConnectOptions;
4*06c3fb27SDimitry Andric 
5*06c3fb27SDimitry Andric %feature("docstring",
6*06c3fb27SDimitry Andric "Represents a shell command that can be run by :py:class:`SBPlatform.Run`."
7*06c3fb27SDimitry Andric ) lldb::SBPlatformShellCommand;
8*06c3fb27SDimitry Andric 
9*06c3fb27SDimitry Andric %feature("docstring",
10*06c3fb27SDimitry Andric "A class that represents a platform that can represent the current host or a remote host debug platform.
11*06c3fb27SDimitry Andric 
12*06c3fb27SDimitry Andric The SBPlatform class represents the current host, or a remote host.
13*06c3fb27SDimitry Andric It can be connected to a remote platform in order to provide ways
14*06c3fb27SDimitry Andric to remotely launch and attach to processes, upload/download files,
15*06c3fb27SDimitry Andric create directories, run remote shell commands, find locally cached
16*06c3fb27SDimitry Andric versions of files from the remote system, and much more.
17*06c3fb27SDimitry Andric 
18*06c3fb27SDimitry Andric SBPlatform objects can be created and then used to connect to a remote
19*06c3fb27SDimitry Andric platform which allows the SBPlatform to be used to get a list of the
20*06c3fb27SDimitry Andric current processes on the remote host, attach to one of those processes,
21*06c3fb27SDimitry Andric install programs on the remote system, attach and launch processes,
22*06c3fb27SDimitry Andric and much more.
23*06c3fb27SDimitry Andric 
24*06c3fb27SDimitry Andric Every :py:class:`SBTarget` has a corresponding SBPlatform. The platform can be
25*06c3fb27SDimitry Andric specified upon target creation, or the currently selected platform
26*06c3fb27SDimitry Andric will attempt to be used when creating the target automatically as long
27*06c3fb27SDimitry Andric as the currently selected platform matches the target architecture
28*06c3fb27SDimitry Andric and executable type. If the architecture or executable type do not match,
29*06c3fb27SDimitry Andric a suitable platform will be found automatically."
30*06c3fb27SDimitry Andric 
31*06c3fb27SDimitry Andric ) lldb::SBPlatform;
32