Re: [PATCH 2/3] Allow help.htmlpath to be an http: URL

From: Jeff King <peff@peff.net>
Date: Jun 27, 2012, 22:11 UTC
Message-ID: <20120627221106.GE2292@sigill.intra.peff.net>
In-Reply-To: <7vbok4785a.fsf@alter.siamese.dyndns.org>

On Wed, Jun 27, 2012 at 02:32:49PM -0700, Junio C Hamano wrote:

Show 19 quoted lines

> >>  	/* Check that we have a git documentation directory. */
> >> -	if (stat(mkpath("%s/git.html", html_path), &st)
> >> -	    || !S_ISREG(st.st_mode))
> >> -		die(_("'%s': not a documentation directory."), html_path);
> >> +	if (prefixcmp(html_path, "http:")) {
> >> +		if (stat(mkpath("%s/git.html", html_path), &st)
> >> +				|| !S_ISREG(st.st_mode))
> >> +			die("'%s': not a documentation directory.", html_path);
> >> +	}
> >
> > I'd rather not tie this directly to http. Is there any reason not to
> > allow https, for example? Can we maybe just look for strstr("://")
> > instead? That's the same magic we use to differentiate URLs from paths
> > when looking for repositories.
> 
> One part of me says "any non-standard html-path should be sent to
> the browser".  Another part of me says "what if network is
> unavailable?  Wouldn't it be nice to fall back to use the local
> copy?"

Fallback might be nice, but I really don't want to get into interpreting what URLs mean or whether the network is up.

> And a small voice in me responds to the latter with "If you have a
> local copy anyway, why would you want to go to the network even if
> you could?"

One reason is that the network version may contain more information (for example, the git-scm.com versions give you links to related articles, and also tell you in which versions the documentation changed).

Speaking of versions, this patch is not sufficient to actually point the browser to the correct version at a site like git-scm.com. We could add some kind of strbuf_expand magic like "http://git-scm.com/%c/%v" or something like that (where %c is the command and %v is the git version). But that is probably over-engineering.

> Which leads me to conclude that it is the right thing to do if
> html_path came from the configuration, not from the compiled-in
> default, to always ask browser to do its thing, and let it fail if
> it has to fail---it is not Git's problem anymore at that point.

I don't know that configured vs compiled-in is the right distinction there, though. If I'm building a minimal git for a stripped-down machine and I don't want to include the HTML pages locally, I might want to set the html path to a URL at build-time. That saves each user from having to configure it.

-Peff