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

From: Tay Ray Chuan <rctay89@gmail.com>
Date: Dec 27, 2009, 03:19 UTC
Message-ID: <be6fef0d0912261919m7b175c4fh532ad05a713d86c7@mail.gmail.com>
In-Reply-To: <1261847255-13970-1-git-send-email-tarmigan+git@gmail.com>

Hi,

On Sun, Dec 27, 2009 at 1:07 AM, Tarmigan Casebolt <tarmigan+git@gmail.com> wrote:

Show 8 quoted lines

> @@ -60,8 +60,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'.
> +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).

Show 14 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/.

> +       installed version of 'git-http-backend' also update the version

s/update/updates/.

> +       that is run in the userdir.  Depending on the configuration of
> +       the server, the symbolic link may be able to point to a global
> +       installation of git.  If, for security reasons, the server is

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.

-- 
Cheers,
Ray Chuan