git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Chris Webb <chris@arachsys.com>
Date
Jun 27, 2012, 20:55 UTC
Message-ID
<233b27a14d16a2a1cb38b9f3e07a3a79b09a3256.1340830514.git.chris@arachsys.com>
In-Reply-To
<20120627205459.GC11498@arachsys.com>

Setting this to a URL prefix instead of a path to a local directory allows git-help --web to work even when HTML docs aren't locally installed, by pointing the browser at a copy accessible on the web. For example,

    [help]
      format = html
      htmlpath = http://git-scm.com/docs
will use the publicly available documentation on the git homepage.
Signed-off-by: Chris Webb <chris@arachsys.com>
---
 builtin/help.c |    8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/builtin/help.c b/builtin/help.c
index b467db2..60b3251 100644
--- a/builtin/help.c
+++ b/builtin/help.c
@@ -399,9 +399,11 @@ static void get_html_page_path(struct strbuf *page_path, const char *page)
 		html_path = system_path(GIT_HTML_PATH);
 
 	/* 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);
+	}
 
 	strbuf_init(page_path, 0);
 	strbuf_addf(page_path, "%s/%s.html", html_path, page);
-- 
1.7.10
Previous: Chris WebbNext: Jeff King
Message 3 of 15 in “A handful of help-related patches”
  1. Chris WebbJun 27, 2012
  2. 1/3 Add config variable to set HTML path for git-help --webChris Webb, Jun 27, 2012
  3. 2/3 Allow help.htmlpath to be an http: URLChris Webb, Jun 27, 2012
  4. Jeff KingJun 27, 2012
  5. Chris WebbJun 27, 2012
  6. Junio C HamanoJun 27, 2012
  7. Chris WebbJun 27, 2012
  8. Jeff KingJun 27, 2012
  9. Chris WebbJun 27, 2012
  10. Jeff KingJun 27, 2012
  11. Junio C HamanoJun 28, 2012
  12. Chris WebbJun 28, 2012
  13. Jeff KingJun 28, 2012
  14. Chris WebbJun 28, 2012
  15. 3/3 Add a help format 'usage' to provide brief command usageChris Webb, Jun 27, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.