sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-11-04 07:51:21 +00:00
Code Issues Releases Wiki Activity

doc/conns: Update documentation to include strip_colors parameter

Browse Source
This commit is contained in:
Marc Bonnici
2018-10-31 10:08:32 +00:00
committed by setrofim
parent b9b38a20f6
commit 01c39cfe4c
2 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/connection.rst
View File

@@ -40,7 +40,7 @@ class that implements the following methods.
:param timeout: timeout (in seconds) for the transfer; if the transfer does :param timeout: timeout (in seconds) for the transfer; if the transfer does
not complete within this period, an exception will be raised. not complete within this period, an exception will be raised.
.. method:: execute(self, command, timeout=None, check_exit_code=False, as_root=False, will_succeed=False) .. method:: execute(self, command, timeout=None, check_exit_code=False, as_root=False, strip_colors=True, will_succeed=False)
Execute the specified command on the connected device and return its output. Execute the specified command on the connected device and return its output.
@@ -53,6 +53,8 @@ class that implements the following methods.
raised if it is not ``0``. raised if it is not ``0``.
:param as_root: The command will be executed as root. This will fail on :param as_root: The command will be executed as root. This will fail on
unrooted connected devices. unrooted connected devices.
:param strip_colours: The command output will have colour encodings and
most ANSI escape sequences striped out before returning.
:param will_succeed: The command is assumed to always succeed, unless there is :param will_succeed: The command is assumed to always succeed, unless there is
an issue in the environment like the loss of network connectivity. That an issue in the environment like the loss of network connectivity. That
will make the method always raise an instance of a subclass of will make the method always raise an instance of a subclass of

4
doc/target.rst
View File

@@ -232,7 +232,7 @@ Target
:param timeout: timeout (in seconds) for the transfer; if the transfer does :param timeout: timeout (in seconds) for the transfer; if the transfer does
not complete within this period, an exception will be raised. not complete within this period, an exception will be raised.
.. method:: Target.execute(command [, timeout [, check_exit_code [, as_root, [will_succeed]]]]) .. method:: Target.execute(command [, timeout [, check_exit_code [, as_root [, strip_colors [, will_succeed]]]]])
Execute the specified command on the target device and return its output. Execute the specified command on the target device and return its output.
@@ -245,6 +245,8 @@ Target
raised if it is not ``0``. raised if it is not ``0``.
:param as_root: The command will be executed as root. This will fail on :param as_root: The command will be executed as root. This will fail on
unrooted targets. unrooted targets.
:param strip_colours: The command output will have colour encodings and
most ANSI escape sequences striped out before returning.
:param will_succeed: The command is assumed to always succeed, unless there is :param will_succeed: The command is assumed to always succeed, unless there is
an issue in the environment like the loss of network connectivity. That an issue in the environment like the loss of network connectivity. That
will make the method always raise an instance of a subclass of will make the method always raise an instance of a subclass of