Merge pull request #953 from riscv/frozen

Change version to 1.0.0-rc1 (frozen); rebuild PDF.
riscv · Jan 17, 2024 · f510a7d · f510a7d
2 parents 359bedc + 99102bc
commit f510a7d
Show file tree

Hide file tree

Showing 11 changed files with 27 additions and 123 deletions.
diff --git a/Makefile b/Makefile
@@ -2,6 +2,7 @@ CC=$(RISCV)/bin/riscv64-unknown-elf-gcc
 
 DRAFT=riscv-debug-draft
 STABLE=riscv-debug-stable
+FROZEN=riscv-debug-frozen
 RELEASE=riscv-debug-release
 NOTES=riscv-debug-workgroup-notes
 
@@ -28,16 +29,17 @@ INCLUDES_TEX += jtagdtm.tex
 INCLUDES_TEX += implementations.tex
 INCLUDES_TEX += debugger_implementation.tex
 INCLUDES_TEX += riscv-debug-spec.tex
-INCLUDES_TEX += future.tex
 
 FIGURES = fig/*
 
-all:	stable $(NOTES).pdf
+all:	frozen $(NOTES).pdf
 
 draft:	$(DRAFT).pdf
 
 stable:	$(STABLE).pdf
 
+frozen:	$(FROZEN).pdf
+
 release:	$(RELEASE).pdf
 
 %.pdf: %.tex $(REGISTERS_TEX) $(FIGURES) $(INCLUDES_TEX) vc.tex changelog.tex

diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
 RISC-V Debug Specification
 ==========================
 
-The current master branch is v1.0.0-stable.
+The current master branch is v1.0.0-frozen.
 
 You may be looking for one of the following pre-built PDFs:
-* [Latest stable](https://github.com/riscv/riscv-debug-spec/blob/master/riscv-debug-stable.pdf)
+* [Latest frozen](https://github.com/riscv/riscv-debug-spec/blob/master/riscv-debug-frozen.pdf)
 * [Latest release](https://github.com/riscv/riscv-debug-spec/blob/release/riscv-debug-release.pdf)
 
 Build Instructions

diff --git a/future.tex b/future.tex
diff --git a/preface.tex b/preface.tex
@@ -1,4 +1,14 @@
 \chapter{Preface}
+\ifdefstring{\releasename}{Frozen}{
+    {\bf
+    This specification is Frozen.
+
+    Change is extremely unlikely. A high threshold will be used, and a change
+    will only occur because of some truly critical issue being identified during
+    the public review cycle. Any other desired or needed changes can be the
+    subject of a follow-on new extension.}
+}{}
+
 \ifdefstring{\releasename}{STABLE}{
     {\bf This stable specification might change before being accepted as
     standard. We're trying to only make backwards-compatible changes, but

diff --git a/riscv-debug-draft.tex b/riscv-debug-draft.tex
@@ -1,4 +1,5 @@
 \newif\ifrelease
 \releasefalse
 \newcommand{\releasename}{DRAFT}
+\newcommand{\versionnum}{1.0\ifrelease\else-\releasename\fi}
 \input{riscv-debug-spec.tex}
diff --git a/riscv-debug-stable.pdf → riscv-debug-frozen.pdf b/riscv-debug-stable.pdf → riscv-debug-frozen.pdf
diff --git a/riscv-debug-frozen.tex b/riscv-debug-frozen.tex
@@ -0,0 +1,5 @@
+\newif\ifrelease
+\releasefalse
+\newcommand{\releasename}{Frozen}
+\newcommand{\versionnum}{1.0.0-rc1}
+\input{riscv-debug-spec.tex}
diff --git a/riscv-debug-release.tex b/riscv-debug-release.tex
@@ -1,3 +1,4 @@
 \newif\ifrelease
 \releasetrue
+\newcommand{\versionnum}{1.0\ifrelease\else-\releasename\fi}
 \input{riscv-debug-spec.tex}
diff --git a/riscv-debug-spec.tex b/riscv-debug-spec.tex
@@ -82,8 +82,6 @@
 
 \input{vc.tex}
 
-\newcommand{\versionnum}{1.0\ifrelease\else-\releasename\fi}
-
 \begin{document}
 
 \title{RISC-V Debug Specification\\
@@ -92,7 +90,7 @@
 }
 \author{Editors: \\
 Paul Donahue \textless [email protected]\textgreater, Ventana Micro Systems \\
-Tim Newsome \textless tim@sifive.com\textgreater, SiFive, Inc.}
+Tim Newsome \textless tim@casualhacker.net\textgreater}
 \date{\GITAuthorDate}
 \maketitle
 
@@ -132,11 +130,13 @@
 
 \ifrelease
 \else
+\ifdefstring{\releasename}{Frozen}{}{
     \chapter{Change Log}
 
     \begin{versionhistory}
         \input{changelog.tex}
     \end{versionhistory}
+}
 \fi
 
 \end{document}
diff --git a/riscv-debug-stable.tex b/riscv-debug-stable.tex
@@ -1,4 +1,5 @@
 \newif\ifrelease
 \releasefalse
 \newcommand{\releasename}{STABLE}
+\newcommand{\versionnum}{1.0\ifrelease\else-\releasename\fi}
 \input{riscv-debug-spec.tex}
diff --git a/xml/serial.xml b/xml/serial.xml