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

Added documentation for Target.extract()

Browse Source
This commit is contained in:
Sergei Trofimov 2016-07-14 11:15:08 +01:00
parent baaa67bfcc
commit c4784e0993
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/target.rst
View File

@ -420,3 +420,15 @@ Target
Returns ``True`` if an executable with the specified name is installed on the Returns ``True`` if an executable with the specified name is installed on the
target and ``False`` other wise. target and ``False`` other wise.
.. method:: Target.extract(path, dest=None)
Extracts the specified archive/file and returns the path to the extrated
contents. The extraction method is determined based on the file extension.
``zip``, ``tar``, ``gzip``, and ``bzip2`` are supported.
:param dest: Specified an on-target destination directory (which must exist)
for the extrated contents.
Returns the path to the extracted contents. In case of files (gzip and
bzip2), the path to the decompressed file is returned; for archives, the
path to the directory with the archive's contents is returned.