sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-01-31 10:10:46 +00:00
Code Issues Releases Wiki Activity

doc: Document as_root param of Target.push/pull

Browse Source
This commit is contained in:
Brendan Jackman 2017-12-01 13:50:57 +00:00 committed by setrofim
parent 35c7196396
commit a2072d5c48
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/target.rst
View File

@ -202,21 +202,23 @@ Target
operations during reboot process to detect if the reboot has failed and operations during reboot process to detect if the reboot has failed and
the device has hung. the device has hung.
.. method:: Target.push(source, dest [, timeout]) .. method:: Target.push(source, dest [,as_root , timeout])
Transfer a file from the host machine to the target device. Transfer a file from the host machine to the target device.
:param source: path of to the file on the host :param source: path of to the file on the host
:param dest: path of to the file on the target :param dest: path of to the file on the target
:param as_root: whether root is required. Defaults to false.
: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.pull(source, dest [, timeout]) .. method:: Target.pull(source, dest [, as_root, timeout])
Transfer a file from the target device to the host machine. Transfer a file from the target device to the host machine.
:param source: path of to the file on the target :param source: path of to the file on the target
:param dest: path of to the file on the host :param dest: path of to the file on the host
:param as_root: whether root is required. Defaults to false.
: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.