sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-02-07 05:30:44 +00:00
Code Issues Releases Wiki Activity

doc/target: Add dry-run documentation

Browse Source
This commit is contained in:
Valentin Schneider 2017-05-23 10:31:05 +01:00
parent 1a5c1dce07
commit e11573594a
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/target.rst
View File

@ -145,6 +145,11 @@ Target
thread. This will always be set to the connection for the current thread. This will always be set to the connection for the current
thread. thread.
.. attribute:: Target.dryrun
The accumulated dry-run commands. If dry-run mode is not active,
this will return the last accumulation list.
.. method:: Target.connect([timeout]) .. method:: Target.connect([timeout])
Establish a connection to the target. It is usually not necessary to call Establish a connection to the target. It is usually not necessary to call
@ -217,9 +222,19 @@ 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.start_dryrun()
Starts dry-run mode, making further calls to Target.execute() accumulate
commands in a list rather than executing them.
.. method:: Target.stop_dryrun()
Stops the dry-run mode.
.. method:: Target.execute(command [, timeout [, check_exit_code [, as_root]]]) .. method:: Target.execute(command [, timeout [, check_exit_code [, as_root]]])
Execute the specified command on the target device and return its output. Execute the specified command on the target device and return its output.
Command is not executed if dry-run mode is enabled.
:param command: The command to be executed. :param command: The command to be executed.
:param timeout: Timeout (in seconds) for the execution of the command. If :param timeout: Timeout (in seconds) for the execution of the command. If