From 29c5a6ea7aa11d457364c8096faaea56e791e81d Mon Sep 17 00:00:00 2001
From: Philipp Wagner <phw@lowrisc.org>
Date: Thu, 17 Sep 2020 10:48:36 +0100
Subject: [PATCH] [doc] Don't strip markdown headings from HW checklist

The checklist template is processed by Mako, which uses `##` as template
comment. Use syntax which avoids stripping the headings out.

(The Mako comment behavior cannot really be configured; we could write a
pre-processor which does the escaping, but since we're only having a
single template here and many invocations of Mako in different scripts,
doing that seems fragile. See also
https://github.com/sqlalchemy/mako/issues/268.)

Signed-off-by: Philipp Wagner <phw@lowrisc.org>
---
 util/uvmdvgen/checklist.md.tpl | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/util/uvmdvgen/checklist.md.tpl b/util/uvmdvgen/checklist.md.tpl
index 45656ebe4ed9d..4f7bf23fc1bfe 100644
--- a/util/uvmdvgen/checklist.md.tpl
+++ b/util/uvmdvgen/checklist.md.tpl
@@ -10,9 +10,9 @@ stage, and updated as needed. Once done, please remove this comment before check
 This checklist is for [Hardware Stage]({{< relref "/doc/project/development_stages.md" >}}) transitions for the [${name.upper()} peripheral.]({{< relref "hw/ip/${name}/doc" >}})
 All checklist items refer to the content in the [Checklist.]({{< relref "/doc/project/checklist.md" >}})
 
-## Design Checklist
+<%text>## Design Checklist</%text>
 
-### D1
+<%text>### D1</%text>
 
 Type          | Item                  | Resolution  | Note/Collaterals
 --------------|-----------------------|-------------|------------------
@@ -38,7 +38,7 @@ Review        | Signoff date          | Not Started |
 [ASSERT_KNOWN_ADDED]: {{<relref "/doc/project/checklist.md#assert-known-added" >}}
 [LINT_SETUP]:         {{<relref "/doc/project/checklist.md#lint-setup" >}}
 
-### D2
+<%text>### D2</%text>
 
 Type          | Item                    | Resolution  | Note/Collaterals
 --------------|-------------------------|-------------|------------------
@@ -82,7 +82,7 @@ Review        | Signoff date            | Not Started |
 [SEC_NON_RESET_FLOPS]: {{<relref "/doc/project/checklist.md#sec-non-reset-flops" >}}
 [SEC_SHADOW_REGS]:     {{<relref "/doc/project/checklist.md#sec-shadow-regs" >}}
 
-### D3
+<%text>### D3</%text>
 
  Type         | Item                    | Resolution  | Note/Collaterals
 --------------|-------------------------|-------------|------------------
@@ -111,9 +111,9 @@ Review        | Signoff date            | Not Started |
 [REVIEW_SW_CHANGE]:     {{<relref "/doc/project/checklist.md#review-sw-change" >}}
 [REVIEW_SW_ERRATA]:     {{<relref "/doc/project/checklist.md#review-sw-errata" >}}
 
-## Verification Checklist
+<%text>## Verification Checklist</%text>
 
-### V1
+<%text>### V1</%text>
 
  Type         | Item                                  | Resolution  | Note/Collaterals
 --------------|---------------------------------------|-------------|------------------
@@ -163,7 +163,7 @@ Review        | Signoff date                          | Not Started |
 [STD_TEST_CATEGORIES_PLANNED]:        {{<relref "/doc/project/checklist.md#std-test-categories-planned" >}}
 [V2_CHECKLIST_SCOPED]:                {{<relref "/doc/project/checklist.md#v2-checklist-scoped" >}}
 
-### V2
+<%text>### V2</%text>
 
  Type         | Item                                    | Resolution  | Note/Collaterals
 --------------|-----------------------------------------|-------------|------------------
@@ -207,7 +207,7 @@ Review        | Signoff date                            | Not started |
 [PRE_VERIFIED_SUB_MODULES_V2]:        {{<relref "/doc/project/checklist.md#pre-verified-sub-modules-v2" >}}
 [V3_CHECKLIST_SCOPED]:                {{<relref "/doc/project/checklist.md#v3-checklist-scoped" >}}
 
-### V3
+<%text>### V3</%text>
 
  Type         | Item                              | Resolution  | Note/Collaterals
 --------------|-----------------------------------|-------------|------------------