Skip to content

Commit

Permalink
Merge pull request #953 from riscv/frozen
Browse files Browse the repository at this point in the history
Change version to 1.0.0-rc1 (frozen); rebuild PDF.
  • Loading branch information
rtwfroody committed Jan 17, 2024
2 parents 359bedc + 99102bc commit f510a7d
Show file tree
Hide file tree
Showing 11 changed files with 27 additions and 123 deletions.
6 changes: 4 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
40 changes: 0 additions & 40 deletions future.tex

This file was deleted.

10 changes: 10 additions & 0 deletions preface.tex
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions riscv-debug-draft.tex
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
\newif\ifrelease
\releasefalse
\newcommand{\releasename}{DRAFT}
\newcommand{\versionnum}{1.0\ifrelease\else-\releasename\fi}
\input{riscv-debug-spec.tex}
Binary file renamed riscv-debug-stable.pdf → riscv-debug-frozen.pdf
Binary file not shown.
5 changes: 5 additions & 0 deletions riscv-debug-frozen.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
\newif\ifrelease
\releasefalse
\newcommand{\releasename}{Frozen}
\newcommand{\versionnum}{1.0.0-rc1}
\input{riscv-debug-spec.tex}
1 change: 1 addition & 0 deletions riscv-debug-release.tex
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
\newif\ifrelease
\releasetrue
\newcommand{\versionnum}{1.0\ifrelease\else-\releasename\fi}
\input{riscv-debug-spec.tex}
6 changes: 3 additions & 3 deletions riscv-debug-spec.tex
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,6 @@

\input{vc.tex}

\newcommand{\versionnum}{1.0\ifrelease\else-\releasename\fi}

\begin{document}

\title{RISC-V Debug Specification\\
Expand All @@ -92,7 +90,7 @@
}
\author{Editors: \\
Paul Donahue \textless pdonahue@ventanamicro.com\textgreater, Ventana Micro Systems \\
Tim Newsome \textless tim@sifive.com\textgreater, SiFive, Inc.}
Tim Newsome \textless tim@casualhacker.net\textgreater}
\date{\GITAuthorDate}
\maketitle

Expand Down Expand Up @@ -132,11 +130,13 @@

\ifrelease
\else
\ifdefstring{\releasename}{Frozen}{}{
\chapter{Change Log}

\begin{versionhistory}
\input{changelog.tex}
\end{versionhistory}
}
\fi

\end{document}
1 change: 1 addition & 0 deletions riscv-debug-stable.tex
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
\newif\ifrelease
\releasefalse
\newcommand{\releasename}{STABLE}
\newcommand{\versionnum}{1.0\ifrelease\else-\releasename\fi}
\input{riscv-debug-spec.tex}
76 changes: 0 additions & 76 deletions xml/serial.xml

This file was deleted.

0 comments on commit f510a7d

Please sign in to comment.