mirror of
https://github.com/ARM-software/devlib.git
synced 2025-01-31 02:00:45 +00:00
docs: Fix Formatting / typos
This commit is contained in:
parent
fe2fe3ae04
commit
09d0a0f500
@ -147,7 +147,7 @@ Connection Types
|
||||
.. class:: SshConnection(host, username, password=None, keyfile=None, port=22,\
|
||||
timeout=None, platform=None, \
|
||||
sudo_cmd="sudo -- sh -c {}", strict_host_check=True, \
|
||||
use_scp=False, poll_transfers=False,
|
||||
use_scp=False, poll_transfers=False, \
|
||||
start_transfer_poll_delay=30, total_transfer_timeout=3600,\
|
||||
transfer_poll_period=30)
|
||||
|
||||
|
@ -225,15 +225,16 @@ Target
|
||||
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).
|
||||
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.
|
||||
: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. Leave unset
|
||||
to utilise transfer polling if enabled.
|
||||
:param globbing: If ``True``, the ``source`` is interpreted as a globbing
|
||||
pattern instead of being take as-is. If the pattern has mulitple
|
||||
pattern instead of being take as-is. If the pattern has multiple
|
||||
matches, ``dest`` must be a folder (or will be created as such if it
|
||||
does not exists yet).
|
||||
|
||||
@ -244,7 +245,7 @@ Target
|
||||
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).
|
||||
cancelled. (See :ref:`connection-types` for more information on polling).
|
||||
|
||||
:param source: path on the target
|
||||
:param dest: path on the host
|
||||
@ -252,7 +253,7 @@ Target
|
||||
:param timeout: timeout (in seconds) for the transfer; if the transfer does
|
||||
not complete within this period, an exception will be raised.
|
||||
:param globbing: If ``True``, the ``source`` is interpreted as a globbing
|
||||
pattern instead of being take as-is. If the pattern has mulitple
|
||||
pattern instead of being take as-is. If the pattern has multiple
|
||||
matches, ``dest`` must be a folder (or will be created as such if it
|
||||
does not exists yet).
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user