Update website for Chisel 3.6 (#392)

* Remove chisel-testers * Point submodules at _.6.x branches * Add pointers to _.6 API docs * Add new Chisel pages to sidebar
freechipsproject · Feb 17, 2023 · 0b374c1 · 0b374c1
1 parent 2432ef4
commit 0b374c1
Show file tree

Hide file tree

Showing 23 changed files with 61 additions and 88 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -1,24 +1,20 @@
 [submodule "chisel3"]
 	path = chisel3
-	url = https://github.com/freechipsproject/chisel3.git
-	branch = 3.5.x
-[submodule "chisel-testers"]
-	path = chisel-testers
-	url = https://github.com/freechipsproject/chisel-testers.git
-	branch = 2.5.x
+	url = https://github.com/chipsalliance/chisel3.git
+	branch = 3.6.x
 [submodule "firrtl"]
 	path = firrtl
-	url = https://github.com/freechipsproject/firrtl
-	branch = 1.5.x
+	url = https://github.com/chipsalliance/firrtl
+	branch = 1.6.x
 [submodule "treadle"]
 	path = treadle
-	url = https://github.com/freechipsproject/treadle
-	branch = 1.5.x
+	url = https://github.com/chipsalliance/treadle
+	branch = 1.6.x
 [submodule "diagrammer"]
 	path = diagrammer
 	url = https://github.com/freechipsproject/diagrammer
-	branch = 1.5.x
+	branch = 1.6.x
 [submodule "chiseltest"]
 	path = chiseltest
-	url = https://github.com/ucb-bar/chisel-testers2
-	branch = 0.5.x
+	url = https://github.com/ucb-bar/chiseltest
+	branch = 0.6.x
diff --git a/Makefile b/Makefile
@@ -12,7 +12,6 @@ www-src = \
 	docs/src/main/tut/chisel3/index.md \
 	chisel3/README.md \
 	firrtl/README.md \
-	chisel-testers/README.md \
 	chiseltest/README.md \
 	treadle/README.md \
 	diagrammer/README.md
@@ -39,12 +38,11 @@ endif
 .PRECIOUS: \
 	$(subprojects)/chisel3/%/.git $(subprojects)/chisel3/%/target/scala-$(scalaVersion)/unidoc/index.html \
 	$(subprojects)/firrtl/%/.git $(subprojects)/firrtl/%/target/scala-$(scalaVersion)/unidoc/index.html \
-	$(subprojects)/chisel-testers/%/.git $(subprojects)/chisel-testers/%/target/scala-$(scalaVersion)/api/index.html \
 	$(subprojects)/chiseltest/%/.git $(subprojects)/chiseltest/%/target/scala-$(scalaVersion)/api/index.html \
 	$(subprojects)/treadle/%/.git $(subprojects)/treadle/%/target/scala-$(scalaVersion)/api/index.html \
 	$(subprojects)/diagrammer/%/.git $(subprojects)/diagrammer/%/target/scala-$(scalaVersion)/api/index.html \
 	$(apis)/chisel3/v%/index.html \
-	docs/target/site/api/%/ docs/target/site/api/firrtl/%/ docs/target/site/api/chisel-testers/%/ \
+	docs/target/site/api/%/ docs/target/site/api/firrtl/%/ \
 	docs/target/site/api/chiseltest/%/ docs/target/site/api/treadle/%/ docs/target/site/api/diagrammer/%/ \
 	$(apis)/%/
 
@@ -100,16 +98,14 @@ docs/target/site/api/%/index.html: $(apis)/chisel3/v%/index.html | docs/target/s
 %/.git:
 	git submodule update --init --depth 1 $*
 $(subprojects)/chisel3/%/.git:
-	git clone "https://github.com/freechipsproject/chisel3.git" --depth 1 --branch $* $(dir $@)
+	git clone "https://github.com/chipsalliance/chisel3.git" --depth 1 --branch $* $(dir $@)
 $(subprojects)/firrtl/%/.git:
-	git clone "https://github.com/freechipsproject/firrtl.git" --depth 1 --branch $* $(dir $@)
-$(subprojects)/chisel-testers/%/.git:
-	git clone "https://github.com/freechipsproject/chisel-testers.git" --depth 1 --branch $* $(dir $@)
+	git clone "https://github.com/chipsalliance/firrtl.git" --depth 1 --branch $* $(dir $@)
 $(subprojects)/treadle/%/.git:
-	git clone "https://github.com/freechipsproject/treadle.git" --depth 1 --branch $* $(dir $@)
+	git clone "https://github.com/chipsalliance/treadle.git" --depth 1 --branch $* $(dir $@)
 $(subprojects)/diagrammer/%/.git:
 	git clone "https://github.com/freechipsproject/diagrammer.git" --depth 1 --branch $* $(dir $@)
 $(subprojects)/chiseltest/%/.git:
-	git clone "https://github.com/ucb-bar/chisel-testers2.git" --depth 1 --branch $* $(dir $@)
+	git clone "https://github.com/ucb-bar/chiseltest.git" --depth 1 --branch $* $(dir $@)
 %/:
 	mkdir -p $@
diff --git a/build.sbt b/build.sbt
@@ -47,11 +47,6 @@ lazy val micrositeSettings = Seq(
       Map("title" -> "Home",
           "section" -> "home",
           "technologies" -> technologies)),
-    file("chisel-testers/README.md") -> ExtraMdFileConfig(
-      "chisel-testers/index.md", "docs",
-      Map("title" -> "Testers",
-          "section" -> "chisel-testers",
-          "position" -> "2")),
     file("chiseltest/README.md") -> ExtraMdFileConfig(
       "chiseltest/index.md", "docs",
       Map("title" -> "ChiselTest",

diff --git a/chisel-testers b/chisel-testers
diff --git a/chisel3 b/chisel3
diff --git a/chiseltest b/chiseltest
diff --git a/diagrammer b/diagrammer
diff --git a/docs/src/main/resources/microsite/data/menu.yml b/docs/src/main/resources/microsite/data/menu.yml
@@ -48,6 +48,10 @@ options:
         url: chisel3/docs/explanations/supported-hardware.html
         menu_type: chisel3
         menu_section: supported-hardware
+      - title: Connectable
+        url: chisel3/docs/explanations/connectable.html
+        menu_type: chisel3
+        menu_section: connectable
       - title: Data Types
         url: chisel3/docs/explanations/data-types.html
         menu_type: chisel3
@@ -148,6 +152,14 @@ options:
         url: chisel3/docs/explanations/chisel-type-vs-scala-type.html
         menu_type: chisel3
         menu_section: chisel-type-vs-scala-type
+      - title: Decoders
+        url: chisel3/docs/explanations/decoder.html
+        menu_type: chisel3
+        menu_section: decoders
+      - title: Source Locators
+        url: chisel3/docs/explanations/source-locators.html
+        menu_type: chisel3
+        menu_section: source-locators
   - title: Appendix
     url: chisel3/docs/appendix/appendix.html
     menu_type: chisel3
@@ -180,6 +192,8 @@ options:
     nested_options:
       - title: Latest
         url: api/chisel3/latest/
+      - title: 3.6
+        url: api/chisel3/3.6/
       - title: 3.5
         url: api/chisel3/3.5/
       - title: 3.4
@@ -189,25 +203,6 @@ options:
       - title: 3.2
         url: api/3.2.8/
 
-  # Testers Site
-  - title: Testers
-    url: chisel-testers/
-    menu_type: chisel-testers
-  - title: API Documentation
-    url: api/chisel-testers/
-    menu_type: chisel-testers
-    nested_options:
-      - title: Latest
-        url: api/chisel-testers/latest
-      - title: 2.5
-        url: api/chisel-testers/2.5
-      - title: 1.5
-        url: api/chisel-testers/1.5
-      - title: 1.4
-        url: api/chisel-testers/1.4
-      - title: 1.3
-        url: api/chisel-testers/1.3
-
   # Chisel Test (chisel-testers2)
   - title: ChiselTest
     url: chiseltest/
@@ -218,6 +213,8 @@ options:
     nested_options:
       - title: Latest
         url: api/chiseltest/latest
+      - title: 0.6
+        url: api/chiseltest/0.6
       - title: 0.5
         url: api/chiseltest/0.5
       - title: 0.3
@@ -237,6 +234,8 @@ options:
     nested_options:
       - title: Latest
         url: api/firrtl/latest
+      - title: 1.6
+        url: api/firrtl/1.6
       - title: 1.5
         url: api/firrtl/1.5
       - title: 1.4
@@ -264,6 +263,8 @@ options:
     nested_options:
       - title: Latest
         url: api/treadle/latest
+      - title: 1.6
+        url: api/treadle/1.6
       - title: 1.5
         url: api/treadle/1.5
       - title: 1.3
@@ -283,6 +284,8 @@ options:
     nested_options:
       - title: Latest
         url: api/diagrammer/latest
+      - title: 1.6
+        url: api/diagrammer/1.6
       - title: 1.5
         url: api/diagrammer/1.5
       - title: 1.3

diff --git a/docs/src/main/tut/api/chisel-testers/1.3/index.md b/docs/src/main/tut/api/chisel-testers/1.3/index.md
diff --git a/docs/src/main/tut/api/chisel-testers/1.4/index.md b/docs/src/main/tut/api/chisel-testers/1.4/index.md
diff --git a/docs/src/main/tut/api/chisel-testers/1.5/index.md b/docs/src/main/tut/api/chisel-testers/1.5/index.md
diff --git a/docs/src/main/tut/api/chisel-testers/2.5/index.md b/docs/src/main/tut/api/chisel-testers/2.5/index.md
diff --git a/docs/src/main/tut/api/chisel-testers/index.md b/docs/src/main/tut/api/chisel-testers/index.md
diff --git a/docs/src/main/tut/api/chisel-testers/latest/index.md b/docs/src/main/tut/api/chisel-testers/latest/index.md
diff --git a/docs/src/main/tut/api/chisel3/3.6/index.md b/docs/src/main/tut/api/chisel3/3.6/index.md
@@ -0,0 +1,3 @@
+---
+redirect_to: https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.6
+---
diff --git a/docs/src/main/tut/api/chisel3/latest/.index.md.swp b/docs/src/main/tut/api/chisel3/latest/.index.md.swp
diff --git a/docs/src/main/tut/api/chiseltest/0.6/index.md b/docs/src/main/tut/api/chiseltest/0.6/index.md
@@ -0,0 +1,4 @@
+---
+redirect_to: https://javadoc.io/doc/edu.berkeley.cs/chiseltest_2.13/0.6
+---
+
diff --git a/docs/src/main/tut/api/diagrammer/1.6/index.md b/docs/src/main/tut/api/diagrammer/1.6/index.md
@@ -0,0 +1,4 @@
+---
+redirect_to: https://javadoc.io/doc/edu.berkeley.cs/firrtl-diagrammer_2.13/1.6
+---
+
diff --git a/docs/src/main/tut/api/firrtl/1.6/index.md b/docs/src/main/tut/api/firrtl/1.6/index.md
@@ -0,0 +1,4 @@
+---
+redirect_to: https://javadoc.io/doc/edu.berkeley.cs/firrtl_2.13/1.6
+---
+
diff --git a/docs/src/main/tut/api/index.md b/docs/src/main/tut/api/index.md
@@ -9,6 +9,7 @@ section: "chisel3"
 We host only the latest minor version for each major version to keep the size down for website hosting.
 Please see the page about [Versioning](../chisel3/docs/appendix/versioning.html) for more information about major and minor versioning and binary compatibility.
 
+* [3.6](3.6/)
 * [3.5](3.5/)
 * [3.4](3.4.4/)
 * [3.3](3.3.3/)

diff --git a/docs/src/main/tut/api/treadle/1.6/index.md b/docs/src/main/tut/api/treadle/1.6/index.md
@@ -0,0 +1,4 @@
+---
+redirect_to: https://javadoc.io/doc/edu.berkeley.cs/treadle_2.13/1.6
+---
+
diff --git a/firrtl b/firrtl
diff --git a/treadle b/treadle
+6 −0		.github/configs/mergify_config.yml
+16 −5		.github/workflows/test.yml
+34 −8		.mergify.yml
+31 −4		README.md
+28 −13		build.sbt
+23 −21		build.sc
+1 −1		project/build.properties
+1 −1		project/plugins.sbt
+2 −2		src/main/resources/simulator/vpi.h
+1 −1		src/main/scala/chisel3/internaltest/EnumHelpers.scala
+0 −120		src/main/scala/chisel3/tester/package.scala
+3 −3		src/main/scala/chiseltest/DecoupledDriver.scala
+8 −5		src/main/scala/chiseltest/RawTester.scala
+3 −3		src/main/scala/chiseltest/Region.scala
+1 −0		src/main/scala/chiseltest/exceptions.scala
+0 −1		src/main/scala/chiseltest/experimental/Observe.scala
+2 −1		src/main/scala/chiseltest/experimental/UncheckedClockPoke.scala
+24 −3		src/main/scala/chiseltest/formal/backends/Maltese.scala
+67 −0		src/main/scala/chiseltest/formal/backends/smt/CompactSmtEncoding.scala
+35 −0		src/main/scala/chiseltest/formal/backends/smt/SMTExprEval.scala
+56 −32		src/main/scala/chiseltest/formal/backends/smt/SMTLibResponseParser.scala
+109 −10		src/main/scala/chiseltest/formal/backends/smt/SMTLibSolver.scala
+20 −64		src/main/scala/chiseltest/formal/backends/smt/SMTModelChecker.scala
+5 −2		src/main/scala/chiseltest/formal/backends/smt/Solver.scala
+94 −0		src/main/scala/chiseltest/formal/backends/smt/UnrollSmtEncoding.scala
+2 −0		src/main/scala/chiseltest/formal/package.scala
+2 −2		src/main/scala/chiseltest/formal/past.scala
+108 −0		src/main/scala/chiseltest/formal/vips/MagicPacketTracker.scala
+2 −1		src/main/scala/chiseltest/internal/BackendExecutive.scala
+8 −3		src/main/scala/chiseltest/internal/BackendInterface.scala
+20 −3		src/main/scala/chiseltest/internal/GenericBackend.scala
+1 −1		src/main/scala/chiseltest/internal/PeekPokeTesterBackend.scala
+19 −3		src/main/scala/chiseltest/internal/SingleThreadBackend.scala
+2 −2		src/main/scala/chiseltest/internal/ThreadedBackend.scala
+1 −5		src/main/scala/chiseltest/iotesters/PeekPokeTester.scala
+49 −10		src/main/scala/chiseltest/package.scala
+19 −1		src/main/scala/chiseltest/simulator/BlackBox.scala
+15 −8		src/main/scala/chiseltest/simulator/IcarusSimulator.scala
+5 −2		src/main/scala/chiseltest/simulator/VcsSimulator.scala
+2 −1		src/main/scala/chiseltest/simulator/VerilatorCoverage.scala
+25 −6		src/main/scala/chiseltest/simulator/VerilatorSimulator.scala
+29 −19		src/main/scala/chiseltest/simulator/ipc/IPCSimulatorContext.scala
+25 −10		src/main/scala/chiseltest/simulator/jna/JNAUtils.scala
+2 −2		src/main/scala/chiseltest/simulator/jna/VerilatorCppJNAHarnessGenerator.scala
+2 −1		src/test/scala/chiseltest/backends/icarus/IcarusBlackBoxTest.scala
+5 −5		src/test/scala/chiseltest/backends/icarus/IcarusTimeTaskTest.scala
+2 −1		src/test/scala/chiseltest/backends/treadle/TreadleBlackBoxTest.scala
+1 −1		src/test/scala/chiseltest/backends/verilator/VerilatorClockPokeTest.scala
+1 −1		src/test/scala/chiseltest/backends/verilator/VerilatorCoverageTests.scala
+5 −5		src/test/scala/chiseltest/backends/verilator/VerilatorTimeTaskTest.scala
+38 −0		src/test/scala/chiseltest/backends/verilator/VerilatorUnspecifiedWidthIOTests.scala
+36 −0		src/test/scala/chiseltest/backends/verilator/VerilatorZeroWidthIntsTest.scala
+2 −1		src/test/scala/chiseltest/backends/verilator/VerilogBlackBoxTest.scala
+9 −5		src/test/scala/chiseltest/formal/ExpressionSemanticsTests.scala
+3 −0		src/test/scala/chiseltest/formal/FormalBackendOption.scala
+383 −0		src/test/scala/chiseltest/formal/MagicPacketTrackerTests.scala
+44 −0		src/test/scala/chiseltest/formal/backends/smt/SMTExprEvalSpec.scala
+1 −1		src/test/scala/chiseltest/formal/examples/SvaDemos.scala
+16 −18		src/test/scala/chiseltest/formal/examples/VGBComparisonOfFormalAndSimulation.scala
+8 −8		src/test/scala/chiseltest/iotesters/AggregateOrderingSpec.scala
+0 −1		src/test/scala/chiseltest/iotesters/EnumSpec.scala
+1 −1		src/test/scala/chiseltest/iotesters/examples/ALUTester.scala
+0 −53		src/test/scala/chiseltest/iotesters/examples/FixedIsWholeTester.scala
+2 −3		src/test/scala/chiseltest/iotesters/examples/PeekPokeBundleSpec.scala
+17 −4		src/test/scala/chiseltest/simulator/BasicCompliance.scala
+23 −5		src/test/scala/chiseltest/simulator/Icarus.scala
+2 −0		src/test/scala/chiseltest/simulator/PeekPokeCompliance.scala
+2 −2		src/test/scala/chiseltest/simulator/Treadle.scala
+1 −1		src/test/scala/chiseltest/simulator/Vcs.scala
+6 −3		src/test/scala/chiseltest/simulator/Verilator.scala
+22 −0		src/test/scala/chiseltest/tests/BasicTest.scala
+1 −2		src/test/scala/chiseltest/tests/ChiselEnumTest.scala
+1 −1		src/test/scala/chiseltest/tests/ClockDividerTest.scala
+3 −3		src/test/scala/chiseltest/tests/CombinationalPathTest.scala
+0 −20		src/test/scala/chiseltest/tests/DeprecatedTest.scala
+4 −4		src/test/scala/chiseltest/tests/ElementTest.scala
+1 −1		src/test/scala/chiseltest/tests/ExceptionPropagationTest.scala
+0 −1		src/test/scala/chiseltest/tests/FaultDecoderTest.scala
+1 −1		src/test/scala/chiseltest/tests/FaultLocatorTest.scala
+54 −0		src/test/scala/chiseltest/tests/GetStepCountTest.scala
+1 −1		src/test/scala/chiseltest/tests/NoScalatestTesterTest.scala
+19 −0		src/test/scala/chiseltest/tests/QueueTest.scala
+31 −0		src/test/scala/chiseltest/tests/RawTesterCustomTestNameTest.scala
+2 −2		src/test/scala/chiseltest/tests/ShiftRegisterTest.scala
+1 −10		src/test/scala/chiseltest/tests/TestUtils.scala
+4 −4		src/test/scala/chiseltest/tests/ThreadJoinTest.scala
+2 −2		src/test/scala/chiseltest/tests/ThreadSafetyLocatorTest.scala
+6 −6		src/test/scala/chiseltest/tests/ThreadSafetyTest.scala
+1 −1		src/test/scala/chiseltest/tests/TimescopeTest.scala
+11 −7		src/test/scala/chiseltest/tests/UtestTesterTest.scala
+13 −0		src/test/scala/chiseltest/tests/ValidQueueTest.scala
+59 −0		src/test/scala/chiseltest/tests/ZeroWidthIntsTest.scala