sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-09-24 21:01:53 +01:00
Code Issues Releases Wiki Activity

exceptions: Update doc for transient exceptions

Browse Source
This commit is contained in:
Douglas RAILLARD
2018-06-22 17:21:25 +01:00
committed by Marc Bonnici
parent ec717e3399
commit cc0582ef59
3 changed files with 86 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/target.rst
View File

@@ -232,7 +232,7 @@ Target
:param timeout: timeout (in seconds) for the transfer; if the transfer does
not complete within this period, an exception will be raised.
.. method:: Target.execute(command [, timeout [, check_exit_code [, as_root]]])
.. method:: Target.execute(command [, timeout [, check_exit_code [, as_root, [will_succeed]]]])
Execute the specified command on the target device and return its output.
@@ -245,6 +245,11 @@ Target
raised if it is not ``0``.
:param as_root: The command will be executed as root. This will fail on
unrooted targets.
: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
will make the method always raise an instance of a subclass of
:class:`DevlibTransientError' when the command fails, instead of a
:class:`DevlibStableError`.
.. method:: Target.background(command [, stdout [, stderr [, as_root]]])