revision-history.yaml

# 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:
    spec:
      - Add intrinsic modules to syntax highlighting
      - Add connect, invalidate to syntax highlighting
      - Add alternative `regreset` syntax
      - Add literal identifiers to allow for legal numeric fields
      - Simplify last-connect semantics explanation, remove "statement groups"
        (which are not part of the spec) which are only used in the original
        explanation
      - Add enumeration types, match statements, and enumeration expressions
      - Fixup probe endpoint and non-passive force examples.
      - Add type alias
      - Restrict string-encoded integers to only being usable in the
        construction of hardware literals.
      - Change string-encoded integers to radix-encoded integers.
      - Remove legacy connect (`<=`) and invalidate (`is invalid`) syntax
      - Make connect disallow implicit truncation (again).
    abi:
      - Initial ABI description.
  # Information about the old versions.  This should be static.
  oldVersions:
    - version: 2.4.0
      spec:
        - Add radix-encoded integer literals as alternative syntax for
          string-encoded integer literals.
        - Add missing deprecation notice for "reg with" syntax.
    - version: 2.3.0
      spec:
        - Add intrinsic modules to syntax highlighting
        - Add connect, invalidate to syntax highlighting
        - Add alternative `regreset` syntax
    - version: 2.2.0
      spec:
        - Add 'asAsyncReset' to primop_1expr_keyword in "FIRRTL Language
          Definition"
        - Fix grammar for force_release statements
        - Add a description of conventions for modules
    - version: 2.1.1
      spec:
        - Fix typos in force/release examples, force takes expr not int literal.
        - Delineate string and single-quoted/double-quoted string in grammar.
        - Deprecate reference-first statements.
        - Tweak grammar of 'read' to support 'read(probe(x))' as in examples.
    - version: 2.0.1
      spec:
        - Clarify int/string types and their allowed usage.
    - version: 2.0.0
      spec:
        - Remove Fixed Point Types.
        - Remove conditionally valid expression (`validif`)
        - Remove partial connect ("<-")
        - Remove FIRRTL forms and lowering, indicate that high-level constructs
          may be preserved by a FIRRTL compiler
        - Add Compiler Implementation Details documenting Lower Types pass
        - Define constant type modifier.
        - Remove stray language leftover from removing conditionally valid.
        - Render inline annotations as JSON, fix typo in example.
        - Fix rendering of type modifiers (const) in document.
        - Fix grammar for registers.
        - Add reference types and related statements.
    - version: 1.2.0
      spec:
        - Specify behavior of zero bit width integers, add zero-width literals
        - Specify behavior of indeterminate values
        - Add an explicit section about "Aggregate Types" and move "Vector Type" and
          "Bundle Type" under it.
        - Move "head" and "tail" from primop_1expr_keyword to
          primop_1expr1int_keyword in the "FIRRTL Language Definition".
        - Add in-line annotation format
        - Specify behavior of combinational loops
        - Change connect to truncate widths to align with all existing FIRRTL
          Compiler implementations
        - Fix spelling/grammar issues
        - Allow out-of-bounds errors to be caught at compile time.
        - Clarify the string argument for cover is a comment, not a message
          as it is for assert and assume.
        - Add intrinsics.
        - Fix parameter grammar to include name of parameter.
    - version: 1.1.0
      spec:
        - Add version information to FIRRTL files
        - Specify "As-If" limited to boolean
    - version: 1.0.0
      spec:
        - Document the versioning scheme of this specification.
    - version: 0.4.0
      spec:
        - >
          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
      spec:
        - Clarify analog usage in registers
        - Rework authorship as "The FIRRTL Specification Contributors"
        - Add version information as subtitle
        - Formatting fixes
    - version: 0.3.0
      spec:
        - Document moved to Markdown