archive: provide builtin .tar.gz filter

[git.git] / Documentation / git-archive.txt

diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt
index 726bf63d460121ac06e480806e1915b0733b294d..8b0080a97759314e7b5f9c0c404c4e7d4af0a401 100644 (file)
--- a/Documentation/git-archive.txt
+++ b/Documentation/git-archive.txt
@@ -110,6 +110,9 @@ tar.<format>.command::
        to the command (e.g., "-9"). An output file with the same
        extension as `<format>` will be use this format if no other
        format is given.
++
+The "tar.gz" and "tgz" formats are defined automatically and default to
+`gzip -cn`. You may override them with custom commands.
 
 ATTRIBUTES
 ----------
@@ -143,6 +146,14 @@ git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz::
 
        Create a compressed tarball for v1.4.0 release.
 
+git archive --format=tar.gz --prefix=git-1.4.0/ v1.4.0 >git-1.4.0.tar.gz::
+
+       Same as above, but using the builtin tar.gz handling.
+
+git archive --prefix=git-1.4.0/ -o git-1.4.0.tar.gz v1.4.0::
+
+       Same as above, but the format is inferred from the output file.
+
 git archive --format=tar --prefix=git-1.4.0/ v1.4.0{caret}\{tree\} | gzip >git-1.4.0.tar.gz::
 
        Create a compressed tarball for v1.4.0 release, but without a