WARNING - OLD ARCHIVES

This is an archived copy of the Xen.org mailing list, which we have preserved to ensure that existing links to archives are not broken. The live archive, which contains the latest emails, can be found at http://lists.xen.org/
   
 
 
Xen 
 
Home Products Support Community News
 
   
 

xen-changelog

[Xen-changelog] [xen-unstable] docs: add some scaffolding for building H

To: xen-changelog@xxxxxxxxxxxxxxxxxxx
Subject: [Xen-changelog] [xen-unstable] docs: add some scaffolding for building HTML docs from markdown
From: Xen patchbot-unstable <patchbot@xxxxxxx>
Date: Tue, 01 Nov 2011 23:55:24 +0000
Delivery-date: Tue, 01 Nov 2011 17:02:14 -0700
Envelope-to: www-data@xxxxxxxxxxxxxxxxxxx
List-help: <mailto:xen-changelog-request@lists.xensource.com?subject=help>
List-id: BK change log <xen-changelog.lists.xensource.com>
List-post: <mailto:xen-changelog@lists.xensource.com>
List-subscribe: <http://lists.xensource.com/mailman/listinfo/xen-changelog>, <mailto:xen-changelog-request@lists.xensource.com?subject=subscribe>
List-unsubscribe: <http://lists.xensource.com/mailman/listinfo/xen-changelog>, <mailto:xen-changelog-request@lists.xensource.com?subject=unsubscribe>
Reply-to: xen-devel@xxxxxxxxxxxxxxxxxxx
Sender: xen-changelog-bounces@xxxxxxxxxxxxxxxxxxx
# HG changeset patch
# User Ian Campbell <ian.campbell@xxxxxxxxxx>
# Date 1319646217 -3600
# Node ID 3568883ebd550be6e26bf5d34dc0764c31918f09
# Parent  4c7c063631db44d3244710ef78bbc81b10fec050
docs: add some scaffolding for building HTML docs from markdown

Signed-off-by: Ian Campbell <ian.campbell@xxxxxxxxxx>
Acked-by: Ian Jackson <ian.jackson.citrix.com>
Committed-by: Ian Jackson <ian.jackson.citrix.com>
---


diff -r 4c7c063631db -r 3568883ebd55 docs/Docs.mk
--- a/docs/Docs.mk      Wed Oct 26 17:20:21 2011 +0100
+++ b/docs/Docs.mk      Wed Oct 26 17:23:37 2011 +0100
@@ -7,3 +7,4 @@
 POD2MAN                := pod2man
 DOT            := dot
 NEATO          := neato
+MARKDOWN       := markdown
diff -r 4c7c063631db -r 3568883ebd55 docs/Makefile
--- a/docs/Makefile     Wed Oct 26 17:20:21 2011 +0100
+++ b/docs/Makefile     Wed Oct 26 17:23:37 2011 +0100
@@ -11,10 +11,11 @@
 DOC_MAN1       := $(patsubst man/%.pod.1,man1/%.1,$(DOC_MAN1SRC))
 DOC_MAN5       := $(patsubst man/%.pod.5,man5/%.5,$(DOC_MAN5SRC))
 DOC_TEX                := src/user.tex src/interface.tex
+DOC_MARKDOWN   := $(wildcard misc/*.markdown)
 DOC_PS         := $(patsubst src/%.tex,ps/%.ps,$(DOC_TEX))
 DOC_PDF                := $(patsubst src/%.tex,pdf/%.pdf,$(DOC_TEX))
-DOC_HTML       := $(patsubst src/%.tex,html/%/index.html,$(DOC_TEX))
-
+DOC_HTML       := $(patsubst src/%.tex,html/%/index.html,$(DOC_TEX)) \
+                  $(patsubst %.markdown,html/%.html,$(DOC_MARKDOWN))
 GFX = $(patsubst %.fig, %.eps, $(wildcard figs/*.fig))
 
 .PHONY: all
@@ -37,9 +38,7 @@
 pdf: $(DOC_PDF)
 
 .PHONY: html
-html:
-       @if which $(LATEX2HTML) 1>/dev/null 2>/dev/null; then \
-       $(MAKE) $(DOC_HTML); fi
+html: $(DOC_HTML)
 
 .PHONY: python-dev-docs
 python-dev-docs:
@@ -110,7 +109,16 @@
        $(FIG2DEV) -L eps $< $@
 
 html/%/index.html: src/%.tex
-       $(INSTALL_DIR) $(@D)
+       @$(INSTALL_DIR) $(@D)
+       @set -e ; if which $(LATEX2HTML) 1>/dev/null 2>/dev/null; then \
+        echo "Running latex2html to generate $*/index.html ... "; \
        $(LATEX2HTML) -split 0 -show_section_numbers -toc_depth 3 -nonavigation 
\
        -numbered_footnotes -local_icons -noinfo -math -dir $(@D) \
-       $< 1>/dev/null 2>/dev/null
+       $< 1>/dev/null 2>/dev/null ;fi
+
+html/%.html: %.markdown
+       @$(INSTALL_DIR) $(@D)
+       @set -e ; if which $(MARKDOWN) 1>/dev/null 2>/dev/null; then \
+       echo "Running markdown to generate $*.html ... "; \
+       $(MARKDOWN) $< > $@.tmp ; \
+       $(call move-if-changed,$@.tmp,$@) ; fi

_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-changelog

<Prev in Thread] Current Thread [Next in Thread>
  • [Xen-changelog] [xen-unstable] docs: add some scaffolding for building HTML docs from markdown, Xen patchbot-unstable <=