Skip to content

Commit 66d9f28

Browse files
Create proper adoc for CTP book part 1. Part 2 & 3 (ISA manuals) are giving an invalid part error.
1 parent 622a959 commit 66d9f28

File tree

2 files changed

+27
-16
lines changed

2 files changed

+27
-16
lines changed

backends/portfolio/templates/beginning.adoc.erb

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
:revmark: "TODO: revmark"
55
:company: RISC-V
66
:url-riscv: https://riscv.org
7-
:doctype: book
87
:preface-title: Licensing and Acknowledgements
98
:colophon:
109
:appendix-caption: Appendix
@@ -29,7 +28,7 @@
2928
:appendix-refsig: Appendix
3029
:sectnums:
3130
:toc: left
32-
:toclevels: 5
31+
:toclevels: 2
3332
// Determined that uncommenting this causes cross-references to IDL functions
3433
// from instruction IDL code to not link. The IDL code uses this
3534
// block tag to get "source" formatting:

backends/proc_ctp/templates/proc_ctp.adoc.erb

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
11
<%= portfolio_design.include_erb("beginning.adoc.erb") %>
22

3-
= <%= proc_cert_model.name %> Processor Certification Test Plan
3+
// Book title. Need "":doctype: book" immediately after book title (no blank lines allowed).
4+
= <%= proc_cert_model.name %> Processor CTP (Certification Test Plan)
5+
:doctype: book
6+
7+
[preface]
8+
= CTP Book Structure
9+
10+
A CTP book is composed of 3 book parts as follows:
11+
12+
* <<udb:doc,Part 1>> is the core CTP documentation including an appendix each for extension, instruction, and CSR
13+
that could be present in a certificate.
14+
* <<manual:unpriv,Part 2>> is the RISC-V Unprivileged ISA manual, volume I (uses release specified by the certificate)
15+
* <<manual:priv,Part 3>> is the RISC-V Privileged ISA manual, volume II (uses release specified by the certificate)
16+
17+
// Part 1 title
18+
[#udb:doc]
19+
= <%= proc_cert_model.name %> Processor Certification Test Plan: Part 1
420

521
[Preface]
622
== CTP Revision History
@@ -37,23 +53,16 @@ Each certificate has a corresponding CRD and CTP:
3753
* The CTP defines the certification coverage points and certification test procedures followed by the certification
3854
tests that an implementation must pass to obtain certification.
3955

40-
A CTP is structured into 3 volumes as follows:
41-
42-
* Volume A is the core CTP documentation including an appendix each for extension, instruction, and CSR
43-
that could be present in a certificate.
44-
* Volume B is the RISC-V Unprivileged ISA manual (uses release specified by the certificate)
45-
* Volume C is the RISC-V Privileged ISA manual (uses release specified by the certificate)
46-
4756
The certification coverage points reference text in any or all of the following:
4857

49-
* RISC-V ISA manuals in volumes B and C
50-
* Community-generated documentation located in volume A (https://github.com/riscv-software-src/riscv-unified-db)
51-
* IDL (ISA Description Language) executable psuedo-code descriptions located in volume A
58+
* RISC-V ISA manuals in parts 2 and 3
59+
* Community-generated documentation located in part 1 (https://github.com/riscv-software-src/riscv-unified-db)
60+
* IDL (ISA Description Language) executable psuedo-code descriptions located in part 1
5261

53-
The RISC-V ISA manuals in Volumes B and C are the preferred reference for certification coverage points since these manuals
54-
represent the ratified RISC-V standards from the TSC.
62+
The RISC-V ISA manuals are the preferred reference for certification coverage points since these manuals
63+
represent the ratified RISC-V standards.
5564
However, if the information in the ISA manuals isn't sufficiently clear or complete for certification purposes
56-
the content in Volume A is used to fill that gap.
65+
the content in Part 1 is used.
5766

5867
=== Naming Scheme
5968

@@ -117,3 +126,6 @@ include::ext/riscv-isa-manual/src/riscv-unprivileged.adoc[]
117126
// Reset chapter numbering
118127
:!chapter-number:
119128
include::ext/riscv-isa-manual/src/riscv-privileged.adoc[]
129+
130+
// Make sure this didn't get overwritten by the included volumes (AKA book parts).
131+
// :toclevels: 2

0 commit comments

Comments
 (0)