Skip to content

Commit b9af4ab

Browse files
MarkLodatogitster
authored andcommitted
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 <[email protected]> Signed-off-by: Shawn O. Pearce <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 917adc0 commit b9af4ab

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

Documentation/git-http-backend.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,15 @@ DESCRIPTION
1414
-----------
1515
A simple CGI program to serve the contents of a Git repository to Git
1616
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.
1720

1821
By default, only the `upload-pack` service is enabled, which serves
1922
'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'.
2426

2527
SERVICES
2628
--------
@@ -50,6 +52,8 @@ automatically by the web server.
5052

5153
EXAMPLES
5254
--------
55+
All of the following examples map 'http://$hostname/git/foo/bar.git'
56+
to '/var/www/git/foo/bar.git'.
5357

5458
Apache 2.x::
5559
Ensure mod_cgi, mod_alias, and mod_env are enabled, set

0 commit comments

Comments
 (0)