From a2072d5c48dd111298fb0a98fdb04b6336d70d62 Mon Sep 17 00:00:00 2001 From: Brendan Jackman Date: Fri, 1 Dec 2017 13:50:57 +0000 Subject: [PATCH] doc: Document as_root param of Target.push/pull --- doc/target.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/target.rst b/doc/target.rst index 5a6583e..69b559d 100644 --- a/doc/target.rst +++ b/doc/target.rst @@ -202,21 +202,23 @@ Target operations during reboot process to detect if the reboot has failed and 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. :param source: path of to the file on the host :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 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. :param source: path of to the file on the target :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 not complete within this period, an exception will be raised.