[PATCH] Document update-server-info.
authorJunio C Hamano <junkio@cox.net>
Sun, 24 Jul 2005 00:54:56 +0000 (17:54 -0700)
committerLinus Torvalds <torvalds@g5.osdl.org>
Sun, 24 Jul 2005 01:28:19 +0000 (18:28 -0700)
This adds a minimum documentation to the new command.

Signed-off-by: Junio C Hamano <junkio@cox.net>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Documentation/git-update-server-info.txt [new file with mode: 0644]
Documentation/git.txt

diff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt
new file mode 100644 (file)
index 0000000..4f65acb
--- /dev/null
@@ -0,0 +1,42 @@
+git-update-server-info(1)
+=========================
+v0.1, July 2005
+
+NAME
+----
+git-update-server-info - Update auxiliary info file to help dumb servers
+
+
+SYNOPSIS
+--------
+'git-update-server-info' [--force]
+
+DESCRIPTION
+-----------
+A dumb server that does not do on-the-fly pack generations can
+have some auxiliary information files in $GIT_DIR/info and
+$GIT_OBJECT_DIRECTORY/info directories to help clients discover
+what references and packs the server has and make an optimized
+pull decisions.  This command generates such auxiliary files.
+
+
+OPTIONS
+-------
+
+--force::
+       Update the info files even when they do not appear
+       stale.
+
+
+Author
+------
+Written by Junio C Hamano <junkio@cox.net>
+
+Documentation
+--------------
+Documentation by Junio C Hamano.
+
+GIT
+---
+Part of the link:git.html[git] suite
+
index 004383b..4c01b2e 100644 (file)
@@ -167,6 +167,10 @@ link:git-upload-pack.html[git-upload-pack]::
        Invoked by 'git-clone-pack' and 'git-fetch-pack' to push
        what are asked for.
 
+link:git-update-server-info.html[git-update-server-info]::
+       Updates auxiliary information on a dumb server to help
+       clients discover references and packs on it.
+
 
 Ancilliary Commands
 -------------------