@matheusbsbs / matheus-bagliano / commits / 34925d35ff
Fork 0

Documentation: add missing docs make check-docs found.

Signed-off-by: Junio C Hamano <junkio@cox.net>

Junio C Hamano committed Jun 7, 2006 at 11:15 UTC 34925d35ff278c7377e0cf3fce0227d5eceffeb5
3 files changed +76 -1
Documentation/git-tar-tree.txt
+30 -1
@@ -8,7 +8,7 @@ git-tar-tree - Creates a tar archive of the files in the named tree
8
9 SYNOPSIS
10 --------
11 -'git-tar-tree' <tree-ish> [ <base> ]
11 +'git-tar-tree' [--remote=<repo>] <tree-ish> [ <base> ]
12
13 DESCRIPTION
14 -----------
@@ -23,6 +23,35 @@ commit time as recorded in the referenced commit object is used instead.
23 Additionally the commit ID is stored in a global extended pax header.
24 It can be extracted using git-get-tar-commit-id.
25
26 +OPTIONS
27 +-------
28 +
29 +<tree-ish>::
30 + The tree or commit to produce tar archive for. If it is
31 + the object name of a commit object.
32 +
33 +<base>::
34 + Leading path to the files in the resulting tar archive.
35 +
36 +--remote=<repo>::
37 + Instead of making a tar archive from local repository,
38 + retrieve a tar archive from a remote repository.
39 +
40 +Examples
41 +--------
42 +git tar-tree HEAD | (cd /var/tmp/ && mkdir junk && tar Cxf junk -)::
43 +
44 + Create a tar archive that contains the contents of the
45 + latest commit on the current branch, and extracts it in
46 + `/var/tmp/junk` directory.
47 +
48 +git tar-tree v2.6.17 linux-2.6.17 | gzip >linux-2.6.17.tar.gz
49 +
50 + Create a tarball for v2.6.17 release.
51 +
52 +git tar-tree --remote=example.com:git.git v0.99 >git-0.99.tar
53 +
54 + Get a tarball v0.99 from example.com.
55
56 Author
57 ------
Documentation/git-upload-tar.txt new
+39
@@ -0,0 +1,39 @@
1 +git-upload-tar(1)
2 +=================
3 +
4 +NAME
5 +----
6 +git-upload-tar - Send tar archive
7 +
8 +
9 +SYNOPSIS
10 +--------
11 +'git-upload-tar' <directory>
12 +
13 +DESCRIPTION
14 +-----------
15 +Invoked by 'git-tar-tree --remote' and sends a generated tar archive
16 +to the other end over the git protocol.
17 +
18 +This command is usually not invoked directly by the end user.
19 +The UI for the protocol is on the 'git-tar-tree' side, and the
20 +program pair is meant to be used to get a tar achive from a
21 +remote repository.
22 +
23 +
24 +OPTIONS
25 +-------
26 +<directory>::
27 + The repository to get a tar archive from.
28 +
29 +Author
30 +------
31 +Written by Junio C Hamano <junio@kernel.org>
32 +
33 +Documentation
34 +--------------
35 +Documentation by Junio C Hamano.
36 +
37 +GIT
38 +---
39 +Part of the gitlink:git[7] suite
Documentation/git.txt
+7
@@ -237,6 +237,10 @@ gitlink:git-upload-pack[1]::
237 Invoked by 'git-clone-pack' and 'git-fetch-pack' to push
238 what are asked for.
239
240 +gitlink:git-upload-tar[1]::
241 + Invoked by 'git-tar-tree --remote' to return the tar
242 + archive the other end asked for.
243 +
244
245 High-level commands (porcelain)
246 -------------------------------
@@ -378,6 +382,9 @@ gitlink:git-merge-one-file[1]::
382 gitlink:git-prune[1]::
383 Prunes all unreachable objects from the object database.
384
385 +gitlink:git-quiltimport[1]::
386 + Applies a quilt patchset onto the current branch.
387 +
388 gitlink:git-relink[1]::
389 Hardlink common objects in local repositories.
390