From: "Shawn O. Pearce" <spearce@spearce.org>
To: git@vger.kernel.org
Cc: Mark Lodato <lodatom@gmail.com>
Subject: [PATCH v5 17/28] http-backend: reword some documentation
Date: Fri, 30 Oct 2009 17:47:36 -0700 [thread overview]
Message-ID: <1256950067-27938-19-git-send-email-spearce@spearce.org> (raw)
In-Reply-To: <1256950067-27938-1-git-send-email-spearce@spearce.org>
From: Mark Lodato <lodatom@gmail.com>
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>
---
Documentation/git-http-backend.txt | 12 ++++++++----
1 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt
index 99dbbfb..0b5e951 100644
--- a/Documentation/git-http-backend.txt
+++ b/Documentation/git-http-backend.txt
@@ -14,13 +14,15 @@ DESCRIPTION
-----------
A simple CGI program to serve the contents of a Git repository to Git
clients accessing the repository over http:// and https:// protocols.
+The program supports clients fetching using both the smart HTTP protcol
+and the backwards-compatible dumb HTTP protocol, as well as clients
+pushing using the smart HTTP protocol.
By default, only the `upload-pack` service is enabled, which serves
'git-fetch-pack' and 'git-ls-remote' clients, which are invoked from
-'git-fetch', 'git-pull', and 'git-clone'.
-
-This is ideally suited for read-only updates, i.e., pulling from
-git repositories.
+'git-fetch', 'git-pull', and 'git-clone'. If the client is authenticated,
+the `receive-pack` service is enabled, which serves 'git-send-pack'
+clients, which is invoked from 'git-push'.
SERVICES
--------
@@ -50,6 +52,8 @@ automatically by the web server.
EXAMPLES
--------
+All of the following examples map 'http://$hostname/git/foo/bar.git'
+to '/var/www/git/foo/bar.git'.
Apache 2.x::
Ensure mod_cgi, mod_alias, and mod_env are enabled, set
--
1.6.5.2.181.gd6f41
next prev parent reply other threads:[~2009-10-31 0:49 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-10-31 0:47 [PATCH v5 00/28] Return of smart HTTP Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 00/28] interdiff to v4 Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 01/28] http-push: fix check condition on http.c::finish_http_pack_request() Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 02/28] pkt-line: Add strbuf based functions Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 03/28] pkt-line: Make packet_read_line easier to debug Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 04/28] fetch-pack: Use a strbuf to compose the want list Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 05/28] Move "get_ack()" back to fetch-pack Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 06/28] Add multi_ack_detailed capability to fetch-pack/upload-pack Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 07/28] remote-curl: Refactor walker initialization Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 08/28] fetch: Allow transport -v -v -v to set verbosity to 3 Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 09/28] remote-helpers: Fetch more than one ref in a batch Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 10/28] remote-helpers: Support custom transport options Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 11/28] Move WebDAV HTTP push under remote-curl Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 12/28] remote-helpers: return successfully if everything up-to-date Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 13/28] Git-aware CGI to provide dumb HTTP transport Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 14/28] Add stateless RPC options to upload-pack, receive-pack Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 15/28] Smart fetch and push over HTTP: server side Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 16/28] http-backend: add GIT_PROJECT_ROOT environment var Shawn O. Pearce
2009-10-31 0:47 ` Shawn O. Pearce [this message]
2009-10-31 0:47 ` [PATCH v5 18/28] http-backend: use mod_alias instead of mod_rewrite Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 19/28] http-backend: add example for gitweb on same URL Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 20/28] http-backend: more explict LocationMatch Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 21/28] Discover refs via smart HTTP server when available Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 22/28] Smart push over HTTP: client side Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 23/28] Smart fetch " Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 24/28] Smart HTTP fetch: gzip requests Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 25/28] t5540-http-push: remove redundant fetches Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 26/28] set httpd port before sourcing lib-httpd Shawn O. Pearce
2009-10-31 0:47 ` [PATCH v5 27/28] http tests: use /dumb/ URL prefix Shawn O. Pearce
2009-11-01 14:50 ` Tay Ray Chuan
2009-10-31 0:47 ` [PATCH v5 28/28] test smart http fetch and push Shawn O. Pearce
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1256950067-27938-19-git-send-email-spearce@spearce.org \
--to=spearce@spearce.org \
--cc=git@vger.kernel.org \
--cc=lodatom@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).