sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-02-07 13:40:48 +00:00
Code Issues Releases Wiki Activity

doc/connection: Document the fact that pull supports globs

Browse Source 
This feature is supported implicitly by SshConnection and explicitly by
AdbConnection. A subsequent commit implements it for LocalConnection.
This commit is contained in:
Brendan Jackman 2017-01-27 19:32:11 +00:00
parent adedad8e32
commit 1cb4eb2285
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/connection.rst
View File

@ -31,9 +31,11 @@ class that implements the following methods.
.. method:: pull(self, source, dest, timeout=None) .. method:: pull(self, source, dest, timeout=None)
Transfer a file from the connected device to the host machine. Transfer a file, or files matching a glob pattern, from the connected device
to the host machine.
:param source: path of to the file on the connected device :param source: path of to the file on the connected device. If ``dest`` is a
directory, may be a glob pattern.
:param dest: path of to the file on the host :param dest: path of to the file on the host
: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.