From c4784e0993849144a83d0afc2b75c1e1863a88b2 Mon Sep 17 00:00:00 2001 From: Sergei Trofimov Date: Thu, 14 Jul 2016 11:15:08 +0100 Subject: [PATCH] Added documentation for Target.extract() --- doc/target.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/target.rst b/doc/target.rst index 04e8fa8..e24cd09 100644 --- a/doc/target.rst +++ b/doc/target.rst @@ -420,3 +420,15 @@ Target Returns ``True`` if an executable with the specified name is installed on the 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.