git-commit-vandalism/Documentation/git-tar-tree.txt
Junio C Hamano 34925d35ff Documentation: add missing docs make check-docs found.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-06-07 11:49:35 -07:00

68 lines
1.7 KiB
Plaintext

git-tar-tree(1)
===============
NAME
----
git-tar-tree - Creates a tar archive of the files in the named tree
SYNOPSIS
--------
'git-tar-tree' [--remote=<repo>] <tree-ish> [ <base> ]
DESCRIPTION
-----------
Creates a tar archive containing the tree structure for the named tree.
When <base> is specified it is added as a leading path to the files in the
generated tar archive.
git-tar-tree behaves differently when given a tree ID versus when given
a commit ID or tag ID. In the first case the current time is used as
modification time of each file in the archive. In the latter case the
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
------
Written by Rene Scharfe.
Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
GIT
---
Part of the gitlink:git[7] suite