diff options
author | Guido Günther <agx@sigxcpu.org> | 2012-01-28 21:08:47 +0100 |
---|---|---|
committer | Guido Günther <agx@sigxcpu.org> | 2012-01-30 12:47:06 +0100 |
commit | 33f714a7ceec242b4e7a25fdf56e94a538195f4f (patch) | |
tree | 42cf33c86c3ec4ce84065f987e6763422fdc4512 /gbp | |
parent | f2629181162fb7c4c0e6e5f79de24c7f24a25df8 (diff) |
GitRepository: document archive()
Diffstat (limited to 'gbp')
-rw-r--r-- | gbp/git/repository.py | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/gbp/git/repository.py b/gbp/git/repository.py index 3670a67..6af56df 100644 --- a/gbp/git/repository.py +++ b/gbp/git/repository.py @@ -1131,6 +1131,19 @@ class GitRepository(object): #} def archive(self, format, prefix, output, treeish, **kwargs): + """ + Create an archive from a treeish + + @param format: the type of archive to create, e.g. 'tar.gz' + @type format: C{str} + @param prefix: prefix to prepend to each filename in the archive + @type prefix: C{str} + @param output: the name of the archive to create + @type output: C{str} + @param treeish: the treeish to create the archive from + @type treeish: C{str} + @param kwargs: additional commandline options passed to git-archive + """ args = [ '--format=%s' % format, '--prefix=%s' % prefix, '--output=%s' % output, treeish ] out, ret = self.__git_getoutput('archive', args, **kwargs) |