http-backend: reword some documentation
Clarify some of the git-http-backend documentation, particularly: * In the Description, state that smart/dumb HTTP fetch and smart HTTP push are supported, state that authenticated clients allow push, and remove the note that this is only suited for read-only updates. * At the start of Examples, state explicitly what URL is mapping to what location on disk. Signed-off-by: Mark Lodato <lodatom@gmail.com> Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Mark Lodato committed
Oct 30, 2009 at 17:47 UTC
b9af4ab3cd33f699ea2a978acb83dbddf07900e6
1 file changed
+8
-4
Documentation/git-http-backend.txt
+8
-4
@@ -14,13 +14,15 @@ DESCRIPTION
14
-----------
15
A simple CGI program to serve the contents of a Git repository to Git
16
clients accessing the repository over http:// and https:// protocols.
17
+The program supports clients fetching using both the smart HTTP protcol
18
+and the backwards-compatible dumb HTTP protocol, as well as clients
19
+pushing using the smart HTTP protocol.
20
21
By default, only the `upload-pack` service is enabled, which serves
22
'git-fetch-pack' and 'git-ls-remote' clients, which are invoked from
20
-'git-fetch', 'git-pull', and 'git-clone'.
21
-
22
-This is ideally suited for read-only updates, i.e., pulling from
23
-git repositories.
23
+'git-fetch', 'git-pull', and 'git-clone'. If the client is authenticated,
24
+the `receive-pack` service is enabled, which serves 'git-send-pack'
25
+clients, which is invoked from 'git-push'.
26
27
SERVICES
28
--------
@@ -50,6 +52,8 @@ automatically by the web server.
52
53
EXAMPLES
54
--------
55
+All of the following examples map 'http://$hostname/git/foo/bar.git'
56
+to '/var/www/git/foo/bar.git'.
57
58
Apache 2.x::
59
Ensure mod_cgi, mod_alias, and mod_env are enabled, set