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

Re: Why is git-subtree docs XML and not HTML?

From
Jeff King <peff@peff.net>
Date
Oct 29, 2013, 15:50 UTC
Message-ID
<20131029155037.GA3628@sigill.intra.peff.net>
In-Reply-To
<CAHGBnuO1xPrAFG1tvS5zaVD9yefa2VUNYM93YLt1pQ1yJwHkrw@mail.gmail.com>
On Tue, Oct 29, 2013 at 03:03:40PM +0100, Sebastian Schuberth wrote:
Show 6 quoted lines
> I'm currently looking at subtree's Makefile and wondering why the
> generated markup docs is git-subtree.xml, and not git-subtree.html
> like for the rest of the git commands. I have not looked at
> git-subtree.xml because I'm lacking asciidoc right now, but is it just
> a matter of changing the file extension from .xml to .html, or does
> generating a HTML file involve more work?

The XML is an intermediate format for the manpage; the original source is .txt, from which asciidoc generate docbook .xml, from which xmlto generate the roff git-subtree.1.

If you want HTML, you need to have asciidoc generate .html from the .txt directly (you probably _can_ generate it from docbook, but that is more complicated, and not how regular git commands work).

I think this would do what you want:
diff --git a/contrib/subtree/Makefile b/contrib/subtree/Makefile
index 435b2de..e9026da 100644
--- a/contrib/subtree/Makefile
+++ b/contrib/subtree/Makefile
@@ -21,6 +21,7 @@ GIT_SUBTREE    := git-subtree
 GIT_SUBTREE_DOC := git-subtree.1
 GIT_SUBTREE_XML := git-subtree.xml
 GIT_SUBTREE_TXT := git-subtree.txt
+GIT_SUBTREE_HTML := git-subtree.html
 
 all: $(GIT_SUBTREE)
 
@@ -46,6 +47,10 @@ $(GIT_SUBTREE_XML): $(GIT_SUBTREE_TXT)
 	asciidoc -b docbook -d manpage -f $(ASCIIDOC_CONF) \
 		-agit_version=$(gitver) $^
 
+$(GIT_SUBTREE_HTML): $(GIT_SUBTREE_TXT)
+	asciidoc -b xhtml11 -d manpage -f $(ASCIIDOC_CONF) \
+		-agit_version=$(gitver) $^
+
 test:
 	$(MAKE) -C t/ test
 
Previous: Sebastian SchuberthNext: Sebastian Schuberth
Message 2 of 5 in “Why is git-subtree docs XML and not HTML?”
  1. Sebastian SchuberthOct 29, 2013
  2. Jeff KingOct 29, 2013
  3. Sebastian SchuberthOct 29, 2013
  4. subtree: add makefile target for html docsJeff King, Oct 29, 2013
  5. Junio C HamanoOct 30, 2013

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.