From 2e2c7c0857bf9f7d0bde75e22f01b5f092d6e33c Mon Sep 17 00:00:00 2001
From: Jack Koenig
Date: Wed, 8 Dec 2021 15:20:27 -0800
Subject: [docs] Update versioning appendix to include 3.5 (#2293)
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>---
docs/src/appendix/versioning.md | 22 +++++++++++++---------
1 file changed, 13 insertions(+), 9 deletions(-)
(limited to 'docs')
diff --git a/docs/src/appendix/versioning.md b/docs/src/appendix/versioning.md
index 8c5ef91c..9f799275 100644
--- a/docs/src/appendix/versioning.md
+++ b/docs/src/appendix/versioning.md
@@ -17,19 +17,23 @@ Historically, due to a mistake in versioning with chisel-iotesters as well as so
the compatible versions of Chisel-related projects has not been obvious.
We are taking steps to improve the situation by bringing the major versions more in line (the `B` part in `A.B.C`),
but the inconsistencies remain in previously published versions.
+Beginning with Chisel 3.5, the major versions for all projects are aligned on `A.5`).
Please use the following table to determine which versions of the related projects are compatible.
In particular, versions of projects in this table were compiled against the version of any dependencies listed in the same row.
For example, `chisel-iotesters` version 1.4 was compiled against `chisel3` version 3.3.
-| chisel3 | chiseltest | chisel-iotesters | firrtl | treadle | diagrammer | firrtl-interpreter2 |
-| ------- | ---------- | ---------------- | ------ | ------- | ---------- | ----- |
-| 3.4 | 0.3 | 1.5 | 1.4 | 1.3 | 1.3 | 1.4 |
-| 3.3 | 0.2 | 1.4 | 1.3 | 1.2 | 1.2 | 1.3 |
-| 3.2 | 0.11 | 1.3 | 1.2 | 1.1 | 1.1 | 1.2 |
-| 3.1 | - | 1.2 | 1.1 | 1.0 | 1.0 | 1.1 |
-| 3.0 | - | 1.1 | 1.0 | -3 | - | 1.0 |
+| chisel3 | chiseltest | chisel-iotesters3 | firrtl | treadle | diagrammer | firrtl-interpreter2 |
+| ------- | ---------- | ---------------- | ------ | ------- | ---------- | ----- |
+| 3.5 | 0.54 | 2.55 | 1.5 | 1.54 | 1.54 | - |
+| 3.4 | 0.3 | 1.5 | 1.4 | 1.3 | 1.3 | 1.4 |
+| 3.3 | 0.2 | 1.4 | 1.3 | 1.2 | 1.2 | 1.3 |
+| 3.2 | 0.11 | 1.3 | 1.2 | 1.1 | 1.1 | 1.2 |
+| 3.1 | - | 1.2 | 1.1 | 1.0 | 1.0 | 1.1 |
+| 3.0 | - | 1.1 | 1.0 | - | - | 1.0 |
1 chiseltest 0.1 was published under artifact name [chisel-testers2](https://search.maven.org/search?q=a:chisel-testers2_2.12) (0.2 was published under both artifact names)
-2 Replaced by Treadle, in maintenance mode only since version 1.1
-3 Treadle was preceded by the firrtl-interpreter
+2 Replaced by Treadle, in maintenance mode only since version 1.1, final version is 1.4
+3 Replaced by chiseltest, final version is 2.5
+4 chiseltest, treadle, and diagrammer skipped X.4 to have a consistent major version with Chisel
+5 chisel-iotesters skipped from 1.5 to 2.5 to have a consistent major version with Chisel
--
cgit v1.2.3