Manual Version Schema

v0.1

Auto-generated

This page is generated from manual_version_schema.json by the schema doc generator. To update this page, edit the schema file and run bin/chore gen schema-docs.

Definitions

volume

Property	Type	Required	Description
title	string	✓	Title of the volume
description	string	✓	Description of the volume
authors	Array<{name, email, organization}> ↓ schema	✓
chapters	Array<chapter>		Ordered (in display order) list of chapters
extensions	Array<{name, version}> ↓ schema		List of extensions defined in this volume, with version numbers
changes	Array<string>		List of changes made since the last version

authors item schema

Property	Type	Required	Description
name	string	✓	Author's full name
email	string		Author's email address
organization	object		Author's organization, which should be an RVI member (or individual)

extensions item schema

Property	Type	Required	Description
name	string	✓	Extension name (e.g., I, M, Zicsr, Smstateen)
version	string	✓	Exact version in MAJOR[.MINOR[.PATCH]] format (e.g., 2.1.0, 2.1, 2)

chapter — Relative (to the contents.yaml file) path to the chapter source

Relative (to the contents.yaml file) path to the chapter source

Type: string

Properties

Property	Type	Required	Description
$schema	any	✓
kind	any	✓
name	string	✓	Name (database key) of this version
long_name	string	✓	One line description of the instruction
manual	object	✓
version	string (pattern: `^(0	[1-9]\d*).(0	[1-9]\d*).(0
marketing_version	string	✓	The publicly displayed version number
state	Ratification state of a specification or extension version: development (actively being worked on), frozen (feature-complete, under review), public-review (open for public comment), ratification-ready (approved by the task group, awaiting board vote), ratified (officially approved by RISC-V International), or nonstandard-released (released but not part of the RISC-V standard).	✓	State of this version
volumes	Array<volume>	✓	List of volumes in this version
url	string		URL to the version, if stored external to the database
uses_isa_manual	boolean		Whether or not this manual version is derived from riscv-isa-manual
isa_manual_tree	string		The git tree-ish of the riscv-isa-manual repository used to generate this version

Tooling field

$source is an optional field set automatically by UDB tooling to record the file path this object was loaded from. You do not need to set it manually.

Schema Information

Property	Value
Version	v0.1
JSON Schema Version	Draft 07