Skip to content

Commit 573e273

Browse files
authored
Merge pull request #262 from riscv-non-isa/state-statement-preamble
Add state statement in preamble
2 parents fb07dbd + 25df520 commit 573e273

File tree

2 files changed

+33
-17
lines changed

2 files changed

+33
-17
lines changed

preamble.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
1+
2+
ifeval::["{revlifecycle}" == "dev"]
3+
[WARNING]
4+
.This document is in the link:http://riscv.org/spec-state[Development state]
5+
====
6+
Assume everything can change.
7+
====
8+
endif::[]
9+
ifeval::["{revlifecycle}" == "stable"]
10+
[WARNING]
11+
.This document is in the link:http://riscv.org/spec-state[Stable state]
12+
====
13+
Assume anything could still change, but limited change should be expected.
14+
====
15+
endif::[]
16+
ifeval::["{revlifecycle}" == "frozen"]
17+
[WARNING]
18+
.This document is in the link:http://riscv.org/spec-state[Frozen state]
19+
====
20+
Change is extremely unlikely. A high threshold will be used, and a change will
21+
only occur because of some truly critical issue being identified during the
22+
public review cycle.
23+
====
24+
endif::[]
25+
ifeval::["{revlifecycle}" == "ratified"]
26+
[WARNING]
27+
.This document is in the link:http://riscv.org/spec-state[Ratified state]
28+
====
29+
No changes are allowed. Any desired or needed changes can be the subject of
30+
a follow-on new extension. Ratified extensions are never revised.
31+
====
32+
endif::[]
33+
134
Contributors to all versions of the spec in alphabetical order:
235

336
Alex Bradbury,

prelude.adoc

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,4 @@
11
:company: RISC-V.org
2-
// These are the definitions from docs-template:
3-
//
4-
// development: Assume everything can change
5-
// stable: Assume everything could change
6-
// frozen: If you implement this version you assume the risk that something
7-
// might change because of the public review cycle but we expect
8-
// little to no change.
9-
// ratified: You can implement this and be assured nothing will change. If
10-
// something needs to change due to an errata or enhancement, it
11-
// will come out in a new extension. we do not revise extensions.
12-
//
13-
// These don't really make sense for our development process, so we replace
14-
// development with a single dev version that we brand as Pre-release, but
15-
// anything featuring in the document is implicitly frozen (in fact, stronger,
16-
// as frozen can still change in incompatible ways) as we cannot break ABI once
17-
// features are implemented in toolchains. Similarly stable is still frozen
18-
// just by another name for policy reasons.
192
:revlifecycle: frozen
203
:revnumber: 1.0-rc4-draft
214
ifeval::["{revlifecycle}" == "dev"]

0 commit comments

Comments
 (0)