Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-9.6 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6616AC43331 for ; Fri, 3 Apr 2020 13:18:08 +0000 (UTC) Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 3507A20721 for ; Fri, 3 Apr 2020 13:18:08 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=citrix.com header.i=@citrix.com header.b="KaCrRx4G" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 3507A20721 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=citrix.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.89) (envelope-from ) id 1jKMCP-0006Jb-Cc; Fri, 03 Apr 2020 13:17:29 +0000 Received: from all-amaz-eas1.inumbo.com ([34.197.232.57] helo=us1-amaz-eas2.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.89) (envelope-from ) id 1jKMCN-0006JW-PP for xen-devel@lists.xenproject.org; Fri, 03 Apr 2020 13:17:27 +0000 X-Inumbo-ID: 76156276-75ad-11ea-bd0e-12813bfff9fa Received: from esa6.hc3370-68.iphmx.com (unknown [216.71.155.175]) by us1-amaz-eas2.inumbo.com (Halon) with ESMTPS id 76156276-75ad-11ea-bd0e-12813bfff9fa; Fri, 03 Apr 2020 13:17:26 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=citrix.com; s=securemail; t=1585919846; h=from:to:cc:subject:date:message-id:mime-version; bh=ALGvBdmFms4PYlnV2x24j5U+BD1c7rKpbBLtIR/PaNo=; b=KaCrRx4Gv3rqTTl1drAT+ItofgDo3K0Btab/iAitPFu+MpYrz3sPf/Ad x9xHYPJgK2uIiTE4bpLpqU7KbwaJvUX05VqWuJtdXlpfh03bXYOlUO1Ct p2HxJLQNxzBTavQEuFrO3jmRAYistjt0skFEXTHEpao+BFBJhajxOHh48 s=; Authentication-Results: esa6.hc3370-68.iphmx.com; dkim=none (message not signed) header.i=none; spf=None smtp.pra=andrew.cooper3@citrix.com; spf=Pass smtp.mailfrom=Andrew.Cooper3@citrix.com; spf=None smtp.helo=postmaster@mail.citrix.com Received-SPF: None (esa6.hc3370-68.iphmx.com: no sender authenticity information available from domain of andrew.cooper3@citrix.com) identity=pra; client-ip=162.221.158.21; receiver=esa6.hc3370-68.iphmx.com; envelope-from="Andrew.Cooper3@citrix.com"; x-sender="andrew.cooper3@citrix.com"; x-conformance=sidf_compatible Received-SPF: Pass (esa6.hc3370-68.iphmx.com: domain of Andrew.Cooper3@citrix.com designates 162.221.158.21 as permitted sender) identity=mailfrom; client-ip=162.221.158.21; receiver=esa6.hc3370-68.iphmx.com; envelope-from="Andrew.Cooper3@citrix.com"; x-sender="Andrew.Cooper3@citrix.com"; x-conformance=sidf_compatible; x-record-type="v=spf1"; x-record-text="v=spf1 ip4:209.167.231.154 ip4:178.63.86.133 ip4:195.66.111.40/30 ip4:85.115.9.32/28 ip4:199.102.83.4 ip4:192.28.146.160 ip4:192.28.146.107 ip4:216.52.6.88 ip4:216.52.6.188 ip4:162.221.158.21 ip4:162.221.156.83 ip4:168.245.78.127 ~all" Received-SPF: None (esa6.hc3370-68.iphmx.com: no sender authenticity information available from domain of postmaster@mail.citrix.com) identity=helo; client-ip=162.221.158.21; receiver=esa6.hc3370-68.iphmx.com; envelope-from="Andrew.Cooper3@citrix.com"; x-sender="postmaster@mail.citrix.com"; x-conformance=sidf_compatible IronPort-SDR: cWlfgwN6+VbQVN7Ngd1aAcZy/gYrCr7VgsECTdVCNgWDHbK0eb5lcHzy/A7DFMgslkNzAR1l6V I0513dxVlFZ7D91phcBSZBcR3sQ/2KXPhzbq+6NP3o/XAG0NyIX/tKGsXfVjsDb8i4CUPF4ulZ jXtcWXurtabtHeUdLtjMX854t+az2DA3EMu+8D3fH6fq+AnDCEyBy7uNPFfKRdljUSyaX59BzM ogyXlcYKEFYMUQZiAsPCC8uqMKB6pCMJlFECe/BV0IqIx2SfJMOs0cOhEhU9pUt0nfjl/pYsYe LCQ= X-SBRS: 2.7 X-MesageID: 15538761 X-Ironport-Server: esa6.hc3370-68.iphmx.com X-Remote-IP: 162.221.158.21 X-Policy: $RELAYED X-IronPort-AV: E=Sophos;i="5.72,339,1580792400"; d="scan'208";a="15538761" From: Andrew Cooper To: Xen-devel Subject: [PATCH] docs: Render .md files using pandoc Date: Fri, 3 Apr 2020 14:17:20 +0100 Message-ID: <20200403131720.30140-1-andrew.cooper3@citrix.com> X-Mailer: git-send-email 2.11.0 MIME-Version: 1.0 Content-Type: text/plain X-BeenThere: xen-devel@lists.xenproject.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Cc: George Dunlap , Andrew Cooper , Paul Durrant , Ian Jackson Errors-To: xen-devel-bounces@lists.xenproject.org Sender: "Xen-devel" 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 Signed-off-by: Andrew Cooper --- CC: George Dunlap CC: Paul Durrant CC: Ian Jackson 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(-) diff --git a/docs/Makefile b/docs/Makefile index d8ba99b1dc..3eae2dae60 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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)) -- 2.11.0