lldb/bindings/interface/SBPlatformDocstrings.i

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