sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-11-04 07:51:21 +00:00
Code Issues Releases Wiki Activity

doc: Extend doc of Target.background()

Browse Source 
Add doc for parameters "force_locale" and "timeout".
This commit is contained in:
douglas-raillard-arm
2021-03-24 14:51:54 +00:00
committed by Marc Bonnici
parent 4f2d9fa66d
commit d953377ff3
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/target.rst
View File

@@ -280,7 +280,7 @@ Target
command to get predictable output that can be more safely parsed.
If ``None``, no locale is prepended.
.. method:: Target.background(command [, stdout [, stderr [, as_root]]])
.. method:: Target.background(command [, stdout [, stderr [, as_root, [, force_locale [, timeout]]])
Execute the command on the target, invoking it via subprocess on the host.
This will return :class:`subprocess.Popen` instance for the command.
@@ -292,6 +292,12 @@ Target
this may be used to redirect it to an alternative file handle.
:param as_root: The command will be executed as root. This will fail on
unrooted targets.
:param force_locale: Prepend ``LC_ALL=<force_locale>`` in front of the
command to get predictable output that can be more safely parsed.
If ``None``, no locale is prepended.
:param timeout: Timeout (in seconds) for the execution of the command. When
the timeout expires, :meth:`BackgroundCommand.cancel` is executed to
terminate the command.
.. note:: This **will block the connection** until the command completes.