chiark / gitweb /
git-urlmap: clarify comments
authorTony Finch <dot@dotat.at>
Wed, 31 Mar 2010 02:30:52 +0000 (03:30 +0100)
committerIan Jackson <ian@liberator.relativity.greenend.org.uk>
Sat, 22 May 2010 14:54:42 +0000 (15:54 +0100)
git-daemon/git-urlmap

index cf8b557..a72b48c 100644 (file)
@@ -4,8 +4,10 @@
 # You may do anything with it, at your own risk.
 # http://creativecommons.org/publicdomain/zero/1.0/
 #
-# This is a perl script which is expected to set a few variables
-# to locate the requested repository.
+# This is a perl script which is expected to turn the information
+# found in the request variables into the location of the
+# corresponding repository, which it stores in the output variables.
+# Some information about the network connection is also available.
 #
 # REQUEST VARIABLES
 #  $service - normally "git-upload-pack"
 #  $uri     = git://$host/$path
 #  $_       = $uri
 #
-# CONNECTION VARIABLES
-#  $client_addr
-#  $client_port
-#  $client      = [$client_addr]:$client_port
-#  $server_addr
-#  $server_port
-#  $server      = [$server_addr]:$server_port
-#
 # OUTPUT VARIABLES
 #  $user - who runs the service
 #  $dir  - may be:
 #  $check_repo   - whether to restrict the syntax of $repo
 #                  (default true)
 #  @opts - options for the service command
+#
+# CONNECTION VARIABLES
+#  $client_addr
+#  $client_port
+#  $client      = [$client_addr]:$client_port
+#  $server_addr
+#  $server_port
+#  $server      = [$server_addr]:$server_port
 
 if ($path =~ m{^~([^/]*)/(.*)}) {
     $user = $1;