Skip to content

Commit

Permalink
[nfc] Move Revision History to separate YAML file
Browse files Browse the repository at this point in the history
Move the Revision History into a separate YAML file.  This should make
things clearer in documentation exactly what users need to edit.

Signed-off-by: Schuyler Eldridge <[email protected]>
  • Loading branch information
seldridge committed Aug 12, 2022
1 parent e6197fb commit 1e43d94
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 34 deletions.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ PANDOC_FLAGS=\
--filter pandoc-crossref \
--metadata version:$(VERSION)

build/spec.pdf: spec.md include/spec-template.tex include/firrtl.xml include/ebnf.xml $(IMG_EPSS) | build/
pandoc $< $(PANDOC_FLAGS) -o $@
build/spec.pdf: spec.md revision-history.yaml include/spec-template.tex include/firrtl.xml include/ebnf.xml $(IMG_EPSS) | build/
pandoc $< --metadata-file=revision-history.yaml $(PANDOC_FLAGS) -o $@

build/img/%.eps: include/img_src/%.dot | build/img/
dot -Teps $< -o $@
Expand Down
32 changes: 32 additions & 0 deletions revision-history.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Information about revision history. This is used by the LaTeX template.
revisionHistory:
# Information about what was added in the current version. This will be
# populated using the "version" that the Makefile grabs from git. Notable
# additions to the specification should append entries here.
thisVersion:
# Information about the old versions. This should be static.
oldVersions:
- version: 1.1.0
changes:
- Add version information to FIRRTL files
- Specify "As-If" limited to boolean
- version: 1.0.0
changes:
- Document the versioning scheme of this specification.
- version: 0.4.0
changes:
- >
Add documentation for undocumented features of the Scala-based FIRRTL
Compiler (SFC) that are de facto a part of the FIRRTL specification
due to their widespread use in Chisel and the SFC: Annotations,
Targets, Asynchronous Reset, Abstract Reset
- Minor typo corrections and prose clarifications.
- version: 0.3.1
changes:
- Clarify analog usage in registers
- Rework authorship as "The FIRRTL Specification Contributors"
- Add version information as subtitle
- Formatting fixes
- version: 0.3.0
changes:
- Document moved to Markdown
32 changes: 0 additions & 32 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,38 +39,6 @@ secPrefix:
- Sections
# This 'lastDelim' option does not work...
lastDelim: ", and"
# Information about revision history. This is used by the LaTeX template.
revisionHistory:
# Information about what was added in the current version. This will be
# populated using the "version" that the Makefile grabs from git. Notable
# additions to the specification should append entries here.
thisVersion:
# Information about the old versions. This should be static.
oldVersions:
- version: 1.1.0
changes:
- Add version information to FIRRTL files
- Specify "As-If" limited to boolean
- version: 1.0.0
changes:
- Document the versioning scheme of this specification.
- version: 0.4.0
changes:
- >
Add documentation for undocumented features of the Scala-based FIRRTL
Compiler (SFC) that are de facto a part of the FIRRTL specification
due to their widespread use in Chisel and the SFC: Annotations,
Targets, Asynchronous Reset, Abstract Reset
- Minor typo corrections and prose clarifications.
- version: 0.3.1
changes:
- Clarify analog usage in registers
- Rework authorship as "The FIRRTL Specification Contributors"
- Add version information as subtitle
- Formatting fixes
- version: 0.3.0
changes:
- Document moved to Markdown
---

# Introduction
Expand Down

0 comments on commit 1e43d94

Please sign in to comment.