summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar W. Trevor King <wking@tremily.us>2013-02-17 19:16:01 -0500
committerLibravatar Junio C Hamano <gitster@pobox.com>2013-02-18 00:48:52 -0800
commit7ed1690c343dc16dfd5a5493589cbf74d503c238 (patch)
treea0d5c0e1088aef6d2dcaad5b87b018b5fb395f65 /Documentation
parentuser-manual: use 'git config --global user.*' for setup (diff)
downloadtgif-7ed1690c343dc16dfd5a5493589cbf74d503c238.tar.xz
user-manual: use -o latest.tar.gz to create a gzipped tarball
This functionality was introduced by 0e804e09 (archive: provide builtin .tar.gz filter, 2011-07-21) for v1.7.7. Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/user-manual.txt15
1 files changed, 12 insertions, 3 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 8074313f8a..52c8523c7d 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -931,11 +931,20 @@ The linkgit:git-archive[1] command can create a tar or zip archive from
any version of a project; for example:
-------------------------------------------------
-$ git archive --format=tar --prefix=project/ HEAD | gzip >latest.tar.gz
+$ git archive -o latest.tar.gz --prefix=project/ HEAD
-------------------------------------------------
-will use HEAD to produce a tar archive in which each filename is
-preceded by "project/".
+will use HEAD to produce a gzipped tar archive in which each filename
+is preceded by `project/`. The output file format is inferred from
+the output file extension if possible, see linkgit:git-archive[1] for
+details.
+
+Versions of Git older than 1.7.7 don't know about the 'tar.gz' format,
+you'll need to use gzip explicitly:
+
+-------------------------------------------------
+$ git archive --format=tar --prefix=project/ HEAD | gzip >latest.tar.gz
+-------------------------------------------------
If you're releasing a new version of a software project, you may want
to simultaneously make a changelog to include in the release