From 1fc9f6cc94cf48d8c51cdbd57dd9b3091b14a0ce Mon Sep 17 00:00:00 2001
From: Jonathan Paynter <jonathan.paynter@arm.com>
Date: Fri, 11 Sep 2020 10:11:55 +0100
Subject: [PATCH] doc/target: Add polling to target push method
Update the documentation for ``target`` to mention transfer polling,
and redirect to more information in ``connection``.
---
doc/target.rst | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/doc/target.rst b/doc/target.rst
index fc55d4f..022d1c1 100644
--- a/doc/target.rst
+++ b/doc/target.rst
@@ -222,6 +222,11 @@ Target
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 dest: path on the target
: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.
+ 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 dest: path on the host
:param as_root: whether root is required. Defaults to false.