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

doc/target: Add polling to target push method

Browse Source 
Update the documentation for ``target`` to mention transfer polling,
and redirect to more information in ``connection``.
This commit is contained in:
Jonathan Paynter 2020-09-11 10:11:55 +01:00 committed by Marc Bonnici
parent 4194b1dd5e
commit 1fc9f6cc94
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/target.rst
View File

@ -222,6 +222,11 @@ Target
Transfer a file from the host machine to the target device. Transfer a file from the host machine to the target device.
If transfer polling is supported (ADB connections and SSH connections),
``poll_transfers`` is set in the connection, and a timeout is not specified,
the push will be polled for activity. Inactive transfers will be
cancelled. (See :ref:`connection-types`\ for more information on polling).
:param source: path on the host :param source: path on the host
:param dest: path 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.
@ -236,6 +241,11 @@ Target
Transfer a file from the target device to the host machine. Transfer a file from the target device to the host machine.
If transfer polling is supported (ADB connections and SSH connections),
``poll_transfers`` is set in the connection, and a timeout is not specified,
the pull will be polled for activity. Inactive transfers will be
cancelled. (See :ref:`connection-types`\ for more information on polling).
:param source: path on the target :param source: path on the target
:param dest: path 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.