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

docs: Fix Formatting / typos

Browse Source
This commit is contained in:
Marc Bonnici 2021-03-31 10:07:55 +01:00 committed by setrofim
parent fe2fe3ae04
commit 09d0a0f500
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/connection.rst
View File

@ -147,7 +147,7 @@ Connection Types
.. class:: SshConnection(host, username, password=None, keyfile=None, port=22,\ .. class:: SshConnection(host, username, password=None, keyfile=None, port=22,\
timeout=None, platform=None, \ timeout=None, platform=None, \
sudo_cmd="sudo -- sh -c {}", strict_host_check=True, \ 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,\ start_transfer_poll_delay=30, total_transfer_timeout=3600,\
transfer_poll_period=30) transfer_poll_period=30)

11
doc/target.rst
View File

@ -225,15 +225,16 @@ Target
If transfer polling is supported (ADB connections and SSH connections), If transfer polling is supported (ADB connections and SSH connections),
``poll_transfers`` is set in the connection, and a timeout is not specified, ``poll_transfers`` is set in the connection, and a timeout is not specified,
the push will be polled for activity. Inactive transfers will be 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 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.
: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. Leave unset
to utilise transfer polling if enabled.
:param globbing: If ``True``, the ``source`` is interpreted as a globbing :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 matches, ``dest`` must be a folder (or will be created as such if it
does not exists yet). does not exists yet).
@ -244,7 +245,7 @@ Target
If transfer polling is supported (ADB connections and SSH connections), If transfer polling is supported (ADB connections and SSH connections),
``poll_transfers`` is set in the connection, and a timeout is not specified, ``poll_transfers`` is set in the connection, and a timeout is not specified,
the pull will be polled for activity. Inactive transfers will be 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 source: path on the target
:param dest: path on the host :param dest: path on the host
@ -252,7 +253,7 @@ Target
: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.
:param globbing: If ``True``, the ``source`` is interpreted as a globbing :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 matches, ``dest`` must be a folder (or will be created as such if it
does not exists yet). does not exists yet).