summaryrefslogtreecommitdiff
path: root/Documentation/git-tar-tree.txt
diff options
context:
space:
mode:
authorJunio C Hamano <junkio@cox.net>2006-06-07 18:15:10 (GMT)
committerJunio C Hamano <junkio@cox.net>2006-06-07 18:49:35 (GMT)
commit34925d35ff278c7377e0cf3fce0227d5eceffeb5 (patch)
tree0705b77265528ae5003951d11d3fc0f6e79ca72c /Documentation/git-tar-tree.txt
parent3742506578dda5de2fe97e403f04150a85ffef17 (diff)
downloadgit-34925d35ff278c7377e0cf3fce0227d5eceffeb5.zip
git-34925d35ff278c7377e0cf3fce0227d5eceffeb5.tar.gz
git-34925d35ff278c7377e0cf3fce0227d5eceffeb5.tar.bz2
Documentation: add missing docs make check-docs found.
Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-tar-tree.txt')
-rw-r--r--Documentation/git-tar-tree.txt31
1 files changed, 30 insertions, 1 deletions
diff --git a/Documentation/git-tar-tree.txt b/Documentation/git-tar-tree.txt
index 2139b6f..831537b 100644
--- a/Documentation/git-tar-tree.txt
+++ b/Documentation/git-tar-tree.txt
@@ -8,7 +8,7 @@ git-tar-tree - Creates a tar archive of the files in the named tree
SYNOPSIS
--------
-'git-tar-tree' <tree-ish> [ <base> ]
+'git-tar-tree' [--remote=<repo>] <tree-ish> [ <base> ]
DESCRIPTION
-----------
@@ -23,6 +23,35 @@ commit time as recorded in the referenced commit object is used instead.
Additionally the commit ID is stored in a global extended pax header.
It can be extracted using git-get-tar-commit-id.
+OPTIONS
+-------
+
+<tree-ish>::
+ The tree or commit to produce tar archive for. If it is
+ the object name of a commit object.
+
+<base>::
+ Leading path to the files in the resulting tar archive.
+
+--remote=<repo>::
+ Instead of making a tar archive from local repository,
+ retrieve a tar archive from a remote repository.
+
+Examples
+--------
+git tar-tree HEAD | (cd /var/tmp/ && mkdir junk && tar Cxf junk -)::
+
+ Create a tar archive that contains the contents of the
+ latest commit on the current branch, and extracts it in
+ `/var/tmp/junk` directory.
+
+git tar-tree v2.6.17 linux-2.6.17 | gzip >linux-2.6.17.tar.gz
+
+ Create a tarball for v2.6.17 release.
+
+git tar-tree --remote=example.com:git.git v0.99 >git-0.99.tar
+
+ Get a tarball v0.99 from example.com.
Author
------