Merge pull request #259 from kbroch-rivosinc/dev/kbroch/fix-schema-typos

fix typos in schema files and a few adocs

Author: dhower-qc

README.adoc

@@ -30,7 +30,7 @@ This repository contains:
 
 === Working examples:
 
- * Generate https://riscv-software-src.github.io/riscv-unified-db/manual/html/index.html[configuration-specific documentation] taylored to the set of implemented extensions and unnamed implementation options (_e.g._, `./do gen:html[generic_rv64]`).
+ * Generate https://riscv-software-src.github.io/riscv-unified-db/manual/html/index.html[configuration-specific documentation] tailored to the set of implemented extensions and unnamed implementation options (_e.g._, `./do gen:html[generic_rv64]`).
  ** Only implemented extensions/instructions/CSRs are included
  ** Unreachable/unimplemented parts of the formal specification are pruned away
  ** A dedicated documentation page for every implemented instruction, including its encoding, pruned execution behavior, and what types of exceptions it may cause.

arch/csr/schema.adoc

@@ -1,6 +1,6 @@
-= Schema for CSR defintions
+= Schema for CSR definitions
 
-A CSR defintion is a mapping (_i.e._, hash, dictionary, ...) containing exactly one key
+A CSR definition is a mapping (_i.e._, hash, dictionary, ...) containing exactly one key
 equal to the CSR name, and pointing to an object specified below. For example:
 
 .CSR object
@@ -30,7 +30,7 @@ Description::
 |===
 | *key*         | description
 | *value type*  | String
-| *description* | A full Asciidoc description of the CSR, indended to be used as documentation.
+| *description* | A full Asciidoc description of the CSR, intended to be used as documentation.
 |===
 
 Defining extension::
@@ -118,12 +118,12 @@ Fields::
 
 == Schema for CSR fields
 
-A CSR field defintion is a mapping (_i.e._, hash, dictionary, ...) containing exactly one key
+A CSR field definition is a mapping (_i.e._, hash, dictionary, ...) containing exactly one key
 equal to the CSR field name, in uppercase, and pointing to an object specified below.
 
 Location::
 
-[IMPORTANT] `location` is required *unless* the location is depenent on the XLEN of a certain mode, in which case both `location_rv32` and `location_rv64` are required
+[IMPORTANT] `location` is required *unless* the location is dependent on the XLEN of a certain mode, in which case both `location_rv32` and `location_rv64` are required
 
 |===
 | *key*         | location
@@ -160,13 +160,13 @@ Reset Value::
 |===
 | *key*         | reset_value
 | *value type*  | Integer -OR- "UNDEFINED_LEGAL"
-| *description* | Value of the field coming out of reset. When the specific value is not defined, "UNDEFINED_LEGAL" is use to indicate that the value isn't known but is gauranteed to a legal value for the field.
+| *description* | Value of the field coming out of reset. When the specific value is not defined, "UNDEFINED_LEGAL" is use to indicate that the value isn't known but is guaranteed to a legal value for the field.
 |===
 
 |===
 | *key*         | reset_value()
 | *value type*  | String of IDL code that returns a reset value
-| *description* | Value of the field coming out of reset. When the specific value is not defined, the special value UNDEFINED_LEGAL can be returned to indicate that the value isn't known but is gauranteed to a legal value for the field.
+| *description* | Value of the field coming out of reset. When the specific value is not defined, the special value UNDEFINED_LEGAL can be returned to indicate that the value isn't known but is guaranteed to a legal value for the field.
 |===
 
 Type::

arch/manual/isa/20240411/contents.yaml

@@ -174,8 +174,9 @@ volumes:
   authors:
   - name: Andrew Waterman
     email: [email protected]
-    organization: SiFive, Inc.
-    url: https://www.sifive.com/
+    organization:
+      name: SiFive, Inc.
+      url: https://www.sifive.com/
   chapters:
     - riscv-isa-manual/src/priv-preface.adoc
     - riscv-isa-manual/src/priv-intro.adoc

schemas/config_schema.json

@@ -316,12 +316,12 @@
         "REPORT_ENCODING_IN_STVAL_ON_ILLEGAL_INSTRUCTION": {
           "type": "boolean",
           "default": false,
-          "description": "When true, stval is written with the faulting instruciton encoding when a IllegalInstruction exception occurs.\nWhen false, stval is written with 0"
+          "description": "When true, stval is written with the faulting instruction encoding when a IllegalInstruction exception occurs.\nWhen false, stval is written with 0"
         },
         "REPORT_CAUSE_IN_STVAL_ON_SOFTWARE_CHECK": {
           "type": "boolean",
           "default": false,
-          "description": "When true, stval is written with the casue when a SoftwareCheck exception occurs.\nWhen false, stval is written with 0"
+          "description": "When true, stval is written with the cause when a SoftwareCheck exception occurs.\nWhen false, stval is written with 0"
         },
         "STVAL_WIDTH": {
           "type": "integer",

schemas/csr_schema.json

@@ -64,11 +64,11 @@
         },
         "type": {
           "enum": ["RO", "RO-H", "RW", "RW-R", "RW-H", "RW-RH"],
-          "description": "Type of the field. One of:\n * RO: Read-only immutable\n * RO-H: Read-only, updated by hardware\n * RW: Read-write, not updated by hardware\n * RW-R: Read-write, but values are restricted. sw_write(value) must be provided\n * RW-H: Read-write, with hardware updates\n * RW-RH: Read-write, with hardware updates, but values are restricted. sw_write(value) must be provded"
+          "description": "Type of the field. One of:\n * RO: Read-only immutable\n * RO-H: Read-only, updated by hardware\n * RW: Read-write, not updated by hardware\n * RW-R: Read-write, but values are restricted. sw_write(value) must be provided\n * RW-H: Read-write, with hardware updates\n * RW-RH: Read-write, with hardware updates, but values are restricted. sw_write(value) must be provided"
         },
         "type()": {
           "type": "string",
-          "description": "Function that returns a configuration-depenent type. The return value should be a CsrFieldType enum, and must be compile-time-known."
+          "description": "Function that returns a configuration-dependent type. The return value should be a CsrFieldType enum, and must be compile-time-known."
         },
         "alias": {
           "oneOf": [
@@ -182,7 +182,7 @@
         },
         "description": {
           "type": "string",
-          "description": "A full Asciidoc description of the CSR, indended to be used as documentation."
+          "description": "A full Asciidoc description of the CSR, intended to be used as documentation."
         },
         "definedBy": {
           "$ref": "schema_defs.json#/$defs/requires_entry",
@@ -196,7 +196,7 @@
         },
         "indirect_address": {
           "type": "integer",
-          "description": "Indirect sddress of the CSR, as given to the indirect CSRs of the `Smcsrind`/`Sscdrind` extensions"
+          "description": "Indirect address of the CSR, as given to the indirect CSRs of the `Smcsrind`/`Sscdrind` extensions"
         },
         "indirect": {
           "type": "boolean",
@@ -230,7 +230,7 @@
           "description": "Function that returns the value of the CSR when read by software (i.e., a Zicsr instruction). If not specified, the value last written (through hw_write) is returned."
         },
         "__source": {
-          "description": "Path to the source file this defintion came from; used by downstream tooling -- not expected to be in handwritten files",
+          "description": "Path to the source file this definition came from; used by downstream tooling -- not expected to be in handwritten files",
           "type": "string"
         }
       },

schemas/ext_schema.json

@@ -70,7 +70,7 @@
           }
         },
         "doc_license": {
-          "description": "License that applies to the textual documantation for this extension",
+          "description": "License that applies to the textual documentation for this extension",
           "type": "object",
           "properties": {
             "name": {
@@ -150,7 +150,7 @@
               },
               "url": { "type": "string", "format": "uri", "description": "Link to ratified document" },
               "implies": {
-                "description": "Extension(s) implied by this extension (i.e., any subextesions)",
+                "description": "Extension(s) implied by this extension (i.e., any subextensions)",
                 "oneOf": [
                   { "$ref": "schema_defs.json#/$defs/extension_name_and_version" },
                   { "type": "array", "items": { "$ref": "schema_defs.json#/$defs/extension_name_and_version" }}

schemas/inst_schema.json

@@ -152,11 +152,11 @@
         "name": {
           "type": "string",
           "pattern": "^[a-z0-9.]+$",
-          "desription": "Instruction mnemonic (must be lowercase)"
+          "description": "Instruction mnemonic (must be lowercase)"
         },
         "long_name": {
           "type": "string",
-          "description": "Short descrption of the instruction"
+          "description": "Short description of the instruction"
         },
         "description": {
           "type": "string",
@@ -254,7 +254,7 @@
               },
               "to": {
                 "type": "string",
-                "description": "pseduoinstruction format"
+                "description": "pseudoinstruction format"
               }
             },
             "additionalProperties": false

schemas/manual_version_schema.json

@@ -23,7 +23,7 @@
         },
         "authors": {
           "type": "array",
-          "itesm": {
+          "items": {
             "$ref": "schema_defs.json#/$defs/author"
           }
         },
@@ -66,7 +66,7 @@
     },
     "marketing_version": {
       "type": "string",
-      "description": "The publically displayed version number"
+      "description": "The publicly displayed version number"
     },
     "state": {
       "$ref": "schema_defs.json#/$defs/spec_state",
@@ -91,7 +91,7 @@
       "items": {
         "$ref": "#/$defs/volume"
       },
-      "descriptoin": "List of volumes in this version"
+      "description": "List of volumes in this version"
     }
   },
   "additionalProperties": false

schemas/schema_defs.json

@@ -11,7 +11,7 @@
     "field_location": {
       "oneOf": [
         {"type": "number", "description": "Location of a single bit"},
-        {"type": "string", "pattern": "^[0-9]+-[0-9]+$", "description": "Location range of a multibit field"}
+        {"type": "string", "pattern": "^[0-9]+-[0-9]+$", "description": "Location range of a multi-bit field"}
       ],
       "description": "Location of a field in a register"
     },
@@ -43,7 +43,7 @@
       "pattern": "^((>=)|(>)|(~>)|(<)|(<=)|(=))?\\s*[0-9]+(\\.[0-9]+(\\.[0-9]+(-[a-fA-F0-9]+)?)?)?$"
     },
     "version_requirements": {
-      "description": "A (set of) version requirments",
+      "description": "A (set of) version requirements",
       "oneOf": [
         {
           "$ref": "#/$defs/requirement_string"