From b6cab6467ddd232fdbb0bb420c94d573360daa3b Mon Sep 17 00:00:00 2001 From: Marc Bonnici Date: Mon, 18 Nov 2019 11:26:05 +0000 Subject: [PATCH] docs: Add `LinuxTarget` and `LocalLinuxTarget` to the documentation --- doc/target.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/target.rst b/doc/target.rst index c2c9a87..30a4491 100644 --- a/doc/target.rst +++ b/doc/target.rst @@ -559,6 +559,24 @@ Target Installs an additional module to the target after the initial setup has been performed. +Linux Target +------------ + +.. class:: LinuxTarget(connection_settings=None, platform=None, working_directory=None, executables_directory=None, connect=True, modules=None, load_default_modules=True, shell_prompt=DEFAULT_SHELL_PROMPT, conn_cls=SshConnection, is_container=False,) + + :class:`LinuxTarget` is a subclass of :class:`~devlib.target.Target` + with customisations specific to a device running linux. + + +Local Linux Target +------------------ + +.. class:: LocalLinuxTarget(connection_settings=None, platform=None, working_directory=None, executables_directory=None, connect=True, modules=None, load_default_modules=True, shell_prompt=DEFAULT_SHELL_PROMPT, conn_cls=SshConnection, is_container=False,) + + :class:`LocalLinuxTarget` is a subclass of + :class:`~devlib.target.LinuxTarget` with customisations specific to using + the host machine running linux as the target. + Android Target ---------------