Separate the introduction into a new file

In order to allow for future expansion of the introduction, move it into a separate file. This is a structural change only. There is no content change. Signed-off-by: Al Stone <[email protected]>
riscvarchive · Oct 7, 2020 · e8b055a · e8b055a
1 parent 3614e0e
commit e8b055a
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 15 deletions.
diff --git a/Makefile b/Makefile
@@ -5,7 +5,7 @@
 ASCIIDOCTOR = asciidoctor
 PLATFORM_SPEC = riscv-platform-spec
 PANDOC = pandoc
-PARTS = changelog.adoc contributors.adoc licensing.adoc
+PARTS = changelog.adoc contributors.adoc introduction.adoc licensing.adoc
 
 # Build the platform spec in several formats
 all: $(PLATFORM_SPEC).md $(PLATFORM_SPEC).pdf $(PLATFORM_SPEC).html

diff --git a/introduction.adoc b/introduction.adoc
@@ -0,0 +1,23 @@
+// SPDX-License-Indentifer: CC-BY-4.0
+//
+// introduction.adoc: describe the purpose of the document
+//
+// Provide a description of the overall intent and purpose of this
+// specifiction.
+//
+
+## Introduction
+
+This document contains the RISC-V UNIX-class platform specification.  This
+specification defines additional restrictions on implementations in order to
+allow software to be compatible between these implementations.  These
+restrictions are enumerated along with the least privileged level to which they
+apply.  Implementations can be compatible with a subset of this specification,
+but that subset must include all restrictions placed on a privilege level as
+well as all less-privileged levels.  For example: implementations can claim to
+be compatible with the "RISC-V Supervisor-Level UNIX Platform" if they are
+compatible with the entire "User-Level Platform" and "Supervisor-Level
+Platform" chapters of this document.
+
+### Versioning
+
diff --git a/riscv-platform-spec.adoc b/riscv-platform-spec.adoc
@@ -23,20 +23,8 @@ include::licensing.adoc[]
 // changelog for the document
 include::changelog.adoc[]
 
-## Introduction
-
-This document contains the RISC-V UNIX-class platform specification.  This
-specification defines additional restrictions on implementations in order to
-allow software to be compatible between these implementations.  These
-restrictions are enumerated along with the least privileged level to which they
-apply.  Implementations can be compatible with a subset of this specification,
-but that subset must include all restrictions placed on a privilege level as
-well as all less-privileged levels.  For example: implementations can claim to
-be compatible with the "RISC-V Supervisor-Level UNIX Platform" if they are
-compatible with the entire "User-Level Platform" and "Supervisor-Level
-Platform" chapters of this document.
-
-### Versioning
+// Introduction: describe the intent and purpose of the document
+include::introduction.adoc[]
 
 ## User-Level Platform