Documentation: add missing docs make check-docs found.
authorJunio C Hamano <junkio@cox.net>
Wed, 7 Jun 2006 18:15:10 +0000 (11:15 -0700)
committerJunio C Hamano <junkio@cox.net>
Wed, 7 Jun 2006 18:49:35 +0000 (11:49 -0700)
Signed-off-by: Junio C Hamano <junkio@cox.net>
Documentation/git-tar-tree.txt
Documentation/git-upload-tar.txt [new file with mode: 0644]
Documentation/git.txt

index 2139b6ff8ce3df6d1c872be1410349e2637eb4f1..831537b6ffe5c53b8b1955fe7b4f8bac9a3df60d 100644 (file)
@@ -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
 ------
diff --git a/Documentation/git-upload-tar.txt b/Documentation/git-upload-tar.txt
new file mode 100644 (file)
index 0000000..a1019a0
--- /dev/null
@@ -0,0 +1,39 @@
+git-upload-tar(1)
+=================
+
+NAME
+----
+git-upload-tar - Send tar archive
+
+
+SYNOPSIS
+--------
+'git-upload-tar' <directory>
+
+DESCRIPTION
+-----------
+Invoked by 'git-tar-tree --remote' and sends a generated tar archive
+to the other end over the git protocol.
+
+This command is usually not invoked directly by the end user.
+The UI for the protocol is on the 'git-tar-tree' side, and the
+program pair is meant to be used to get a tar achive from a
+remote repository.
+
+
+OPTIONS
+-------
+<directory>::
+       The repository to get a tar archive from.
+
+Author
+------
+Written by Junio C Hamano <junio@kernel.org>
+
+Documentation
+--------------
+Documentation by Junio C Hamano.
+
+GIT
+---
+Part of the gitlink:git[7] suite
index 24ca55da684265b5e14f0e60c00917c3d623fcbc..61331ab12140c43c3b043aab7e6dd21294678041 100644 (file)
@@ -237,6 +237,10 @@ gitlink:git-upload-pack[1]::
        Invoked by 'git-clone-pack' and 'git-fetch-pack' to push
        what are asked for.
 
+gitlink:git-upload-tar[1]::
+       Invoked by 'git-tar-tree --remote' to return the tar
+       archive the other end asked for.
+
 
 High-level commands (porcelain)
 -------------------------------
@@ -378,6 +382,9 @@ gitlink:git-merge-one-file[1]::
 gitlink:git-prune[1]::
        Prunes all unreachable objects from the object database.
 
+gitlink:git-quiltimport[1]::
+       Applies a quilt patchset onto the current branch.
+
 gitlink:git-relink[1]::
        Hardlink common objects in local repositories.