Skip to contentSkip to conversation

docs: Render .md files using pandoc

PATCH In review Andrew Cooper 3 participants 3 messages Apr 3, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: Render .md files using pandoc

This fixes the fact that qemu-deprivilege.md, non-cooperative-migration.md and xenstore-migration.md don't currently get rendered at all, and are therefore missing from xenbits.xen.org/docs

---
CC: George Dunlap <[email protected]>
CC: Paul Durrant <[email protected]>
CC: Ian Jackson <[email protected]>

Ian - given qemu-deprivilege.md was in 4.12, this wants backporting. It quite possibly needs some intermediate prerequisites

---
 docs/Makefile | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)
docs/Makefile +8 -7
index d8ba99b1dc..3eae2dae60 100644
@@ -15,7 +15,7 @@ RST-SRC-y := $(sort $(filter-out %index.rst,$(shell find * -type f -name '*.rst'
 
 TXTSRC-y := $(sort $(shell find misc -name '*.txt' -print))
 
-PANDOCSRC-y := $(sort $(shell find designs/ features/ misc/ process/ specs/ -name '*.pandoc' -print))
+PANDOCSRC-y := $(sort $(shell find designs/ features/ misc/ process/ specs/ \( -name '*.pandoc' -o -name '*.md' \) -print))
 
 # Documentation targets
 $(foreach i,$(MAN_SECTIONS), \
@@ -24,15 +24,18 @@ $(foreach i,$(MAN_SECTIONS), \
 
 DOC_HTML := html/SUPPORT.html \
             $(patsubst %.pandoc,html/%.html,$(PANDOCSRC-y)) \
+            $(patsubst %.md,html/%.html,$(PANDOCSRC-y)) \
             $(patsubst %.rst,html/%.html,$(RST-SRC-y)) \
             $(patsubst %,html/%.html,$(MAN-SRC-y)) \
             $(patsubst %.txt,html/%.txt,$(TXTSRC-y)) \
             $(patsubst %,html/hypercall/%/index.html,$(DOC_ARCHES))
 DOC_TXT  := $(patsubst %.txt,txt/%.txt,$(TXTSRC-y)) \
             $(patsubst %.pandoc,txt/%.txt,$(PANDOCSRC-y)) \
+            $(patsubst %.md,txt/%.txt,$(PANDOCSRC-y)) \
             $(patsubst %.rst,txt/%.txt,$(RST-SRC-y)) \
             $(patsubst %,txt/%.txt,$(MAN-SRC-y))
 DOC_PDF  := $(patsubst %.pandoc,pdf/%.pdf,$(PANDOCSRC-y)) \
+            $(patsubst %.md,pdf/%.pdf,$(PANDOCSRC-y)) \
             $(patsubst %.rst,pdf/%.pdf,$(RST-SRC-y))
 
 # Top level build targets
@@ -228,12 +231,10 @@ define GENERATE_PANDOC_RULE
 # $(1) is the target documentation format. $(2) is the source format.
 $(call GENERATE_PANDOC_RULE_RAW,$(1)/%.$(1),%.$(2))
 endef
-$(eval $(call GENERATE_PANDOC_RULE,pdf,pandoc))   # pdf/%.pdf: %.pandoc
-$(eval $(call GENERATE_PANDOC_RULE,pdf,rst))      # pdf/%.pdf: %.rst
-$(eval $(call GENERATE_PANDOC_RULE,txt,pandoc))   # txt/%.txt: %.pandoc
-$(eval $(call GENERATE_PANDOC_RULE,txt,rst))      # txt/%.txt: %.rst
-$(eval $(call GENERATE_PANDOC_RULE,html,pandoc))  # html/%.html: %.pandoc
-$(eval $(call GENERATE_PANDOC_RULE,html,rst))     # html/%.html: %.rst
+
+$(foreach dst-fmt,pdf txt html,\
+$(foreach src-fmt,pandoc md rst,\
+$(eval $(call GENERATE_PANDOC_RULE,$(dst-fmt),$(src-fmt)))))
 
 $(eval $(call GENERATE_PANDOC_RULE_RAW,html/SUPPORT.html,$(XEN_ROOT)/SUPPORT.md))
 
Signature · 1 line
2.11.0
Reviewed-by on v1 1/1
#1 lore raw
Quoted 12 lines

-----Original Message-----
From: Xen-devel <[email protected]> On Behalf Of Andrew Cooper
Sent: 03 April 2020 14:17
To: Xen-devel <[email protected]>
Cc: George Dunlap <[email protected]>; Andrew Cooper <[email protected]>; Paul Durrant <[email protected]>; Ian Jackson <[email protected]>
Subject: [PATCH] docs: Render .md files using pandoc

This fixes the fact that qemu-deprivilege.md, non-cooperative-migration.md and xenstore-migration.md don't currently get rendered at all, and are therefore missing from xenbits.xen.org/docs

Quoted 6 lines

---
CC: George Dunlap <[email protected]>
CC: Paul Durrant <[email protected]>
CC: Ian Jackson <[email protected]>

Reviewed-by on v1 1/1
#2 lore raw
In reply to Andrew Cooper

Andrew Cooper writes ("[PATCH] docs: Render .md files using pandoc"):

Quoted 9 lines

This fixes the fact that qemu-deprivilege.md, non-cooperative-migration.md and xenstore-migration.md don't currently get rendered at all, and are therefore missing from xenbits.xen.org/docs

---
CC: George Dunlap <[email protected]>
CC: Paul Durrant <[email protected]>
CC: Ian Jackson <[email protected]>

Quoted 2 lines

Ian - given qemu-deprivilege.md was in 4.12, this wants backporting. It quite possibly needs some intermediate prerequisites

Cool. Can you add a "Backport: 4.12" tag then ?

Thanks,
Ian.