From 34925d35ff278c7377e0cf3fce0227d5eceffeb5 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 7 Jun 2006 11:15:10 -0700 Subject: [PATCH] Documentation: add missing docs make check-docs found. Signed-off-by: Junio C Hamano --- Documentation/git-tar-tree.txt | 31 ++++++++++++++++++++++++++++++- Documentation/git-upload-tar.txt | 39 +++++++++++++++++++++++++++++++++++++++ Documentation/git.txt | 7 +++++++ 3 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 Documentation/git-upload-tar.txt diff --git a/Documentation/git-tar-tree.txt b/Documentation/git-tar-tree.txt index 2139b6ff..831537b6 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' [ ] +'git-tar-tree' [--remote=] [ ] 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 +------- + +:: + The tree or commit to produce tar archive for. If it is + the object name of a commit object. + +:: + Leading path to the files in the resulting tar archive. + +--remote=:: + 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 index 00000000..a1019a02 --- /dev/null +++ b/Documentation/git-upload-tar.txt @@ -0,0 +1,39 @@ +git-upload-tar(1) +================= + +NAME +---- +git-upload-tar - Send tar archive + + +SYNOPSIS +-------- +'git-upload-tar' + +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 +------- +:: + The repository to get a tar archive from. + +Author +------ +Written by Junio C Hamano + +Documentation +-------------- +Documentation by Junio C Hamano. + +GIT +--- +Part of the gitlink:git[7] suite diff --git a/Documentation/git.txt b/Documentation/git.txt index 24ca55da..61331ab1 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -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. -- 2.11.0