Skip to content

Commit

Permalink
Changed priv/unpriv manual colophons to use level 1 adoc heading (was…
Browse files Browse the repository at this point in the history
… using level 0) and created unique anchors at top of each manual (were using the same anchor).
  • Loading branch information
james-ball-qualcomm committed Feb 4, 2025
1 parent 6f69218 commit 0cd3b44
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 5 deletions.
10 changes: 8 additions & 2 deletions src/colophon.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
[colophon]
= Preface

== Preface
// Had to make the above a level 1 heading (two equals signs) to avoid error when building
// the ISA manual as a book with other "parts". This is opposite to what the adoc says to do
// but otherwise asciidoctor creates the error messsage:
//
// asciidoctor: ERROR: ext/riscv-isa-manual/src/colophon.adoc: line 2: invalid part, must have at least one section (e.g., chapter, appendix, etc.)
//
// See asciidoctor doc which seems wrong: https://docs.asciidoctor.org/asciidoc/latest/sections/colophon/

This document describes the RISC-V unprivileged architecture.

Expand Down
9 changes: 8 additions & 1 deletion src/priv-preface.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
[colophon]
= Preface
== Preface
// Had to make the above a level 1 heading (two equals signs) to avoid error when building
// the ISA manual as a book with other "parts". This is opposite to what the adoc says to do
// but otherwise asciidoctor creates the error messsage:
//
// asciidoctor: ERROR: ext/riscv-isa-manual/src/priv-preface.adoc: line 2: invalid part, must have at least one section (e.g., chapter, appendix, etc.)
//
// See asciidoctor doc which seems wrong: https://docs.asciidoctor.org/asciidoc/latest/sections/colophon/

[.big]*_Preface to Version 20241101_*

Expand Down
2 changes: 1 addition & 1 deletion src/riscv-privileged.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[risc-v-isa]]
[[manual:priv,RISC-V ISA Manual Volume II: Privileged Architecture]]
= The RISC-V Instruction Set Manual: Volume II: Privileged Architecture
include::../docs-resources/global-config.adoc[]
:description: Volume II - Privileged Architecture
Expand Down
2 changes: 1 addition & 1 deletion src/riscv-unprivileged.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[risc-v-isa]]
[[manual:unpriv,RISC-V ISA Manual Volume I: Unprivileged Architecture]]
= The RISC-V Instruction Set Manual Volume I: Unprivileged Architecture
include::../docs-resources/global-config.adoc[]
:description: Unprivileged Architecture
Expand Down

0 comments on commit 0cd3b44

Please sign in to comment.