Re: [PATCH] Smart-http documentation: add example of how to execute from userdir

From: Tarmigan <tarmigan+git@gmail.com>
Date: Dec 28, 2009, 04:18 UTC
Message-ID: <905315640912272018r1282394fh62d37b5c9e91a234@mail.gmail.com>
In-Reply-To: <be6fef0d0912261919m7b175c4fh532ad05a713d86c7@mail.gmail.com>

On Sat, Dec 26, 2009 at 10:19 PM, Tay Ray Chuan <rctay89@gmail.com> wrote:

Show 7 quoted lines

>> -All of the following examples map 'http://$hostname/git/foo/bar.git'
>> -to '/var/www/git/foo/bar.git'.
>> +Unless otherwise noted, the following examples map
>> +'http://$hostname/git/foo/bar.git' to '/var/www/git/foo/bar.git'.
>
> This rephrase seems to be unrelated (to providing an example of
> serving smart http).

I think this change is related because previously all the examples provided the same mapping. With the new example with a different mapping, the "_All_ of the following" is no longer true.

Show 17 quoted lines

>> @@ -144,6 +144,42 @@ ScriptAliasMatch \
>>  ScriptAlias /git/ /var/www/cgi-bin/gitweb.cgi/
>>  ----------------------------------------------------------------
>>
>> +In the following example, a repository at
>> +'/home/$username/devel/foo/bar.git' will be accessible at
>> +'http://$hostname/\~$username/cgi-bin/git/foo/bar.git'
>> +
>> +From UserDir on Apache 2.x::
>> +       One way to configure 'git-http-backend' to execute and serve
>> +       from a user directory (for example, on a shared hosting
>> +       provider), is to have a symbolic link that points from the cgi
>> +       directory to the 'git-http-backend' executable in libexec.  The
>> +       advantage of the symblic link is that any updates to the
>
> s/symblic/symbolic
> s/update/updates/.

Thanks.

Show 9 quoted lines

> At this point, the user dealing with the "easy" case (ie. the user
> just symlinks the shared git installation and doesn't have to create
> symlinks in his own home directory) should have enough configuration
> details without having to read any further. So, you could tell the
> user about the symlinks to create and the configuration lines in
> .htaccess.
>
> It might also be a good idea to start a new paragraph for the "hard"
> case, for better readability.

OK, these suggestions sound good to me.  I'll send out an updated patch shortly.

Thanks, Tarmigan