1
0
mirror of https://github.com/ARM-software/devlib.git synced 2025-01-31 02:00:45 +00:00

docs/target: Update Target.{push,pull}() description

Document the fact that it accepts folders as source and destination in
addition to files.
This commit is contained in:
douglas-raillard-arm 2020-06-16 12:07:09 +01:00 committed by Marc Bonnici
parent 590069f01f
commit 07bbf902ba

View File

@ -222,8 +222,8 @@ Target
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 on the host
:param dest: path of to the file on the target :param dest: path on the target
:param as_root: whether root is required. Defaults to false. :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.
@ -232,8 +232,8 @@ Target
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 on the target
:param dest: path of to the file on the host :param dest: path on the host
:param as_root: whether root is required. Defaults to false. :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.