Bump 3.4.0 (#97)

* Removed old chisel3 docs * Added make rules to copy chisel3 docs over * Added pages for subheadings * Bump other repos * Delete index.md from chisel3 when copying over docs
freechipsproject · Oct 13, 2020 · a57f118 · a57f118
1 parent 667bb90
commit a57f118
Show file tree

Hide file tree

Showing 48 changed files with 166 additions and 3,724 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@
 target
 project/target
 build
+docs/src/main/tut/chisel3/docs/
 
 travis-deploy-key
 travis-deploy-key.pub
@@ -12,5 +13,7 @@ test_run_dir
 *.anno.json
 *.v
 *.fir
+*.DS_STORE
+.idea
 
 docs/src/main/tut/contributors.md
diff --git a/Makefile b/Makefile
@@ -1,10 +1,18 @@
 buildDir ?= build
 subprojects = $(buildDir)/subprojects
 apis = $(buildDir)/api
+docs = $(buildDir)/docs
+
+www-docs = \
+    $(shell find chisel3/docs/ -name "*.md")
 
 www-src = \
-	$(shell find docs/src/main/tut/ -name "*.md") \
 	$(shell find docs/src/main/resources) \
+	docs/src/main/tut/chisel3/docs \
+	docs/src/main/tut/chisel3/index.md \
+	docs/src/main/tut/chisel3/explanations.md \
+	docs/src/main/tut/chisel3/cookbooks.md \
+	docs/src/main/tut/chisel3/wiki-deprecated.md \
 	chisel3/README.md \
 	firrtl/README.md \
 	chisel-testers/README.md \
@@ -203,7 +211,7 @@ apis-diagrammer: $(diagrammerTags:%=$(apis)/diagrammer/%/index.html) $(apis)/dia
 
 # Remove the output of all build targets
 clean:
-	rm -rf docs/target docs/src/main/tut/contributors.md
+	rm -rf docs/target docs/src/main/tut/contributors.md docs/src/main/tut/chisel3/docs
 
 # Remove everything
 mrproper:
@@ -270,6 +278,10 @@ $(apis)/chiseltest/%/index.html: $(subprojects)/chiseltest/%/.git | $(apis)/chis
 	(cd $(subprojects)/chiseltest/$* && sbt doc)
 	find $(<D) -type d -name api -exec cp -r '{}'/. $(@D) ';'
 
+# Build docs in subproject with a specific tag.
+docs/src/main/tut/chisel3/docs: chisel3/.git $(www-docs)
+	(cd chisel3 && sbt docs/mdoc && cp -r docs/generated ../docs/src/main/tut/chisel3/docs && rm ../docs/src/main/tut/chisel3/docs/wiki-deprecated/index.md)
+
 # Copy *SNAPSHOT* API of subprojects into API directory
 docs/target/site/api/SNAPSHOT/index.html: $(apis)/chisel3/$(chiselSnapshot)/index.html | docs/target/site/api/SNAPSHOT/
 	cp -r $(<D)/. $(@D)

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/json/README.md b/docs/src/main/resources/json/README.md
@@ -0,0 +1 @@
+These files were used to generate the waveforms used in documentation.
diff --git a/...3/memories_waveforms/smem_read_write.json → .../main/resources/json/smem_read_write.json b/...3/memories_waveforms/smem_read_write.json → .../main/resources/json/smem_read_write.json
@@ -17,3 +17,4 @@ head:{
 },
 config: { hscale: 2 }
 }
+
diff --git a/...t/chisel3/memories_waveforms/smem_rw.json → docs/src/main/resources/json/smem_rw.json b/...t/chisel3/memories_waveforms/smem_rw.json → docs/src/main/resources/json/smem_rw.json
@@ -1,3 +1,4 @@
+
 {
 signal: [
   ['in',

diff --git a/docs/src/main/resources/microsite/data/menu.yml b/docs/src/main/resources/microsite/data/menu.yml
@@ -2,117 +2,131 @@ options:
 
   # Chisel Site
   - title: Chisel3
+    menu_type: chisel3
+    menu_section: chisel3
     url: chisel3/
+  - title: Cookbooks
     menu_type: chisel3
     menu_section: chisel3
+    url: chisel3/cookbooks.html
     nested_options:
-      - title: FAQs
-        url: chisel3/faqs.html
-      - title: Cookbook
-        url: chisel3/cookbook.html
-      - title: Troubleshooting
-        url: chisel3/troubleshooting
-      - title: Resources
-        url: chisel3/resources
-  - title: Introduction
-    url: chisel3/introduction.html
-    menu_type: chisel3
-    menu_section: introduction
-  - title: Supported Hardware
-    url: chisel3/supported-hardware.html
-    menu_type: chisel3
-    menu_section: supported-hardware
-  - title: Data Types
-    url: chisel3/data-types.html
-    menu_type: chisel3
-    menu_section: data-types
-  - title: Combinational Circuits
-    url: chisel3/combinational-circuits.html
-    menu_type: chisel3
-    menu_section: combinational-circuits
-  - title: Operators
-    url: chisel3/operators.html
-    menu_type: chisel3
-    menu_section: operators
-  - title: Width Inference
-    url: chisel3/width-inference.html
-    menu_type: chisel3
-    menu_section: width-inference
-  - title: Functional Abstraction
-    url: chisel3/functional-abstraction.html
-    menu_type: chisel3
-    menu_section: functional-abstraction
-  - title: Bundles and Vecs
-    url: chisel3/bundles-and-vecs.html
-    menu_type: chisel3
-    menu_section: bundles-and-vecs
-  - title: Ports
-    url: chisel3/ports.html
-    menu_type: chisel3
-    menu_section: ports
-  - title: Modules
-    url: chisel3/modules.html
-    menu_type: chisel3
-    menu_section: modules
-  - title: Blackboxes
-    url: chisel3/blackboxes.html
-    menu_type: chisel3
-    menu_section: blackboxes
-  - title: Sequential Circuits
-    url: chisel3/sequential-circuits.html
+      - title: Naming
+        url: chisel3/docs/cookbooks/naming.html
+        menu_type: chisel3
+        menu_section: naming
+  - title: Explanations
+    url: chisel3/explanations.html
     menu_type: chisel3
-    menu_section: sequential-circuits
-  - title: Memories
-    url: chisel3/memories.html
-    menu_type: chisel3
-    menu_section: memories
-  - title: Interfaces and Connections
-    url: chisel3/interfaces-and-connections.html
-    menu_type: chisel3
-    menu_section: interfaces-and-connections
-  - title: Functional Module Creation
-    url: chisel3/functional-module-creation.html
-    menu_type: chisel3
-    menu_section: functional-module-creation
-  - title: Muxes and Input Selection
-    url: chisel3/muxes-and-input-selection.html
-    menu_type: chisel3
-    menu_section: muxes-and-input-selection
-  - title: Polymorphism and Parameterization
-    url: chisel3/polymorphism-and-parameterization.html
-    menu_type: chisel3
-    menu_section: polymorphism-and-parameterization
-  - title: Multiple Clock Domains
-    url: chisel3/multi-clock.html
-    menu_type: chisel3
-    menu_section: multi-clock
-  - title: Printing in Chisel
-    url: chisel3/printing.html
-    menu_type: chisel3
-    menu_section: printing
-  - title: Annotations
-    url: chisel3/annotations.html
-    menu_type: chisel3
-    menu_section: annotations
-  - title: Unconnected Wires
-    url: chisel3/unconnected-wires.html
-    menu_type: chisel3
-    menu_section: unconnected-wires
-  - title: Reset
-    url: chisel3/reset.html
-    menu_type: chisel3
-    menu_section: reset
-  - title: Appendix
-    url: chisel3/chisel3-vs-chisel2.html
+    menu_section: chisel3
+    nested_options:
+      - title: Annotations
+        url: chisel3/docs/explanations/annotations.html
+        menu_type: chisel3
+        menu_section: annotations
+      - title: Blackboxes
+        url: chisel3/docs/explanations/blackboxes.html
+        menu_type: chisel3
+        menu_section: blackboxes
+      - title: Bundles and Vecs
+        url: chisel3/docs/explanations/bundles-and-vecs.html
+        menu_type: chisel3
+        menu_section: bundles-and-vecs
+      - title: Multiple Clock Domains
+        url: chisel3/docs/explanations/multi-clock.html
+        menu_type: chisel3
+        menu_section: multi-clock
+      - title: Naming
+        url: chisel3/docs/explanations/naming.html
+        menu_type: chisel3
+        menu_section: naming
+  - title: Wiki (Deprecated)
     menu_type: chisel3
-    menu_section: appendix
+    menu_section: chisel3
+    url: chisel3/wiki-deprecated.html
     nested_options:
-      - title: Chisel3 vs. Chisel2
-        url: chisel3/chisel3-vs-chisel2.html
-      - title: Experimental Features
-        url: chisel3/experimental-features.html
-      - title: Upgrading From Scala 2.11
-        url: chisel3/upgrading-from-scala-2-11.html
+      - title: Introduction
+        url: chisel3/docs/wiki-deprecated/introduction.html
+        menu_type: chisel3
+        menu_section: introduction
+      - title: Supported Hardware
+        url: chisel3/docs/wiki-deprecated/supported-hardware.html
+        menu_type: chisel3
+        menu_section: supported-hardware
+      - title: Data Types
+        url: chisel3/docs/wiki-deprecated/data-types.html
+        menu_type: chisel3
+        menu_section: data-types
+      - title: Combinational Circuits
+        url: chisel3/docs/wiki-deprecated/combinational-circuits.html
+        menu_type: chisel3
+        menu_section: combinational-circuits
+      - title: Operators
+        url: chisel3/docs/wiki-deprecated/operators.html
+        menu_type: chisel3
+        menu_section: operators
+      - title: Width Inference
+        url: chisel3/docs/wiki-deprecated/width-inference.html
+        menu_type: chisel3
+        menu_section: width-inference
+      - title: Functional Abstraction
+        url: chisel3/docs/wiki-deprecated/functional-abstraction.html
+        menu_type: chisel3
+        menu_section: functional-abstraction
+      - title: Ports
+        url: chisel3/docs/wiki-deprecated/ports.html
+        menu_type: chisel3
+        menu_section: ports
+      - title: Modules
+        url: chisel3/docs/wiki-deprecated/modules.html
+        menu_type: chisel3
+        menu_section: modules
+      - title: Sequential Circuits
+        url: chisel3/docs/wiki-deprecated/sequential-circuits.html
+        menu_type: chisel3
+        menu_section: sequential-circuits
+      - title: Memories
+        url: chisel3/docs/wiki-deprecated/memories.html
+        menu_type: chisel3
+        menu_section: memories
+      - title: Interfaces and Connections
+        url: chisel3/docs/wiki-deprecated/interfaces-and-connections.html
+        menu_type: chisel3
+        menu_section: interfaces-and-connections
+      - title: Functional Module Creation
+        url: chisel3/docs/wiki-deprecated/functional-module-creation.html
+        menu_type: chisel3
+        menu_section: functional-module-creation
+      - title: Muxes and Input Selection
+        url: chisel3/docs/wiki-deprecated/muxes-and-input-selection.html
+        menu_type: chisel3
+        menu_section: muxes-and-input-selection
+      - title: Polymorphism and Parameterization
+        url: chisel3/docs/wiki-deprecated/polymorphism-and-parameterization.html
+        menu_type: chisel3
+        menu_section: polymorphism-and-parameterization
+      - title: Printing in Chisel
+        url: chisel3/docs/wiki-deprecated/printing.html
+        menu_type: chisel3
+        menu_section: printing
+      - title: Unconnected Wires
+        url: chisel3/docs/wiki-deprecated/unconnected-wires.html
+        menu_type: chisel3
+        menu_section: unconnected-wires
+      - title: Reset
+        url: chisel3/docs/wiki-deprecated/reset.html
+        menu_type: chisel3
+        menu_section: reset
+      - title: Appendix
+        url: chisel3/docs/wiki-deprecated/chisel3-vs-chisel2.html
+        menu_type: chisel3
+        menu_section: appendix
+        nested_options:
+          - title: Chisel3 vs. Chisel2
+            url: chisel3/docs/wiki-deprecated/chisel3-vs-chisel2.html
+          - title: Experimental Features
+            url: chisel3/docs/wiki-deprecated/experimental-features.html
+          - title: Upgrading From Scala 2.11
+            url: chisel3/docs/wiki-deprecated/upgrading-from-scala-2-11.html
   - title: Developers
     url: chisel3/developers.html
     menu_type: chisel3
+2 −0		CommonBuild.sc
+184 −0		LICENSE
+13 −13		build.sbt
+14 −14		build.sc
+1 −1		project/build.properties
+4 −4		project/plugins.sbt
+18 −3		src/main/resources/sim_api.h
+63 −0		src/main/resources/utils.fdo
+2 −0		src/main/resources/veri_api.h
+9 −1		src/main/resources/vpi.cpp
+7 −0		src/main/resources/vpi.h
+2 −0		src/main/resources/vpi.tab
+2 −0		src/main/resources/vpi_register.cpp
+1 −1		src/main/scala/chisel3/iotesters/AdvTester.scala
+1 −1		src/main/scala/chisel3/iotesters/Backends.scala
+13 −5		src/main/scala/chisel3/iotesters/ChiselMain.scala
+6 −1		src/main/scala/chisel3/iotesters/ChiselPokeSpec.scala
+1 −1		src/main/scala/chisel3/iotesters/ChiselSpec.scala
+1 −1		src/main/scala/chisel3/iotesters/CommandEditor.scala
+12 −5		src/main/scala/chisel3/iotesters/Driver.scala
+1 −1		src/main/scala/chisel3/iotesters/Exerciser.scala
+6 −3		src/main/scala/chisel3/iotesters/FirrtlTerpBackend.scala
+1 −1		src/main/scala/chisel3/iotesters/HWIOTester.scala
+1 −1		src/main/scala/chisel3/iotesters/IOAccessor.scala
+1 −1		src/main/scala/chisel3/iotesters/IVLBackend.scala
+1 −1		src/main/scala/chisel3/iotesters/OrderedDecoupledHWIOTester.scala
+168 −5		src/main/scala/chisel3/iotesters/PeekPokeTester.scala
+100 −3		src/main/scala/chisel3/iotesters/PeekPokeTesterUtils.scala
+2 −0		src/main/scala/chisel3/iotesters/Pokeable.scala
+1 −1		src/main/scala/chisel3/iotesters/SimApiInterface.scala
+1 −1		src/main/scala/chisel3/iotesters/SteppedHWIOTester.scala
+1 −1		src/main/scala/chisel3/iotesters/TestErrors.scala
+50 −6		src/main/scala/chisel3/iotesters/TesterOptions.scala
+46 −33		src/main/scala/chisel3/iotesters/TreadleBackend.scala
+26 −13		src/main/scala/chisel3/iotesters/VCSBackend.scala
+195 −0		src/main/scala/chisel3/iotesters/VSIMBackend.scala
+9 −6		src/main/scala/chisel3/iotesters/VerilatorBackend.scala
+2 −0		src/main/scala/chisel3/iotesters/compatibility.scala
+2 −0		src/test/resources/AddTwoAddThree.v
+1 −1		src/test/scala/chisel3/iotesters/AggregateOrderingSpec.scala
+1 −1		src/test/scala/chisel3/iotesters/BlackBoxVerilogDeliverySpec.scala
+1 −1		src/test/scala/chisel3/iotesters/ChiselPokeSpec.scala
+1 −1		src/test/scala/chisel3/iotesters/DriverSpec.scala
+2 −0		src/test/scala/chisel3/iotesters/EnumSpec.scala
+56 −0		src/test/scala/chisel3/iotesters/IntervalDshlTest.scala
+2 −2		src/test/scala/chisel3/iotesters/LoggingUsageSpec.scala
+1 −1		src/test/scala/chisel3/iotesters/MemPokeSpec.scala
+3 −3		src/test/scala/chisel3/iotesters/ToolChainSpec.scala
+1 −1		src/test/scala/chisel3/iotesters/VecFillSpec.scala
+1 −1		src/test/scala/chisel3/iotesters/ZeroWidthIOSpec.scala
+1 −1		src/test/scala/examples/ALUTester.scala
+1 −1		src/test/scala/examples/AccumBlackBoxSpec.scala
+1 −1		src/test/scala/examples/Adder.scala
+1 −1		src/test/scala/examples/AdvTesterSpec.scala
+1 −1		src/test/scala/examples/BigNumbers.scala
+36 −0		src/test/scala/examples/BoreSpec.scala
+1 −1		src/test/scala/examples/BundleInitSpec.scala
+1 −1		src/test/scala/examples/ComplexMemoryLoadingSpec.scala
+1 −1		src/test/scala/examples/ConcurrentDecoupledTestingSpec.scala
+1 −1		src/test/scala/examples/CycleTest.scala
+1 −1		src/test/scala/examples/DecoupledAdder.scala
+1 −1		src/test/scala/examples/DecoupledAdvTester.scala
+1 −1		src/test/scala/examples/DynamicMemorySearch.scala
+54 −0		src/test/scala/examples/FixedIsWholeTester.scala
+25 −6		src/test/scala/examples/FixedPointSpec.scala
+1 −1		src/test/scala/examples/GCDSpec.scala
+1 −1		src/test/scala/examples/GCDUnitTest.scala
+1 −1		src/test/scala/examples/Hello.scala
+1 −1		src/test/scala/examples/InterpreterVerilatorConsistencySpec.scala
+108 −0		src/test/scala/examples/IntervalSpec.scala
+1 −1		src/test/scala/examples/LoadMemoryFromFileSpec.scala
+1 −1		src/test/scala/examples/MaxN.scala
+1 −1		src/test/scala/examples/MultiIOModule.scala
+1 −1		src/test/scala/examples/PeekPokeBundleSpec.scala
+1 −1		src/test/scala/examples/RealGCD.scala
+1 −1		src/test/scala/examples/RerunWithoutElaboratonAndCompileSpec.scala
+1 −1		src/test/scala/examples/Router.scala
+2 −0		src/test/scala/examples/SecondClockDrivesRegisterSpec.scala
+1 −1		src/test/scala/examples/SmallOdds3.scala
+1 −1		src/test/scala/examples/SmallOdds4.scala
+1 −1		src/test/scala/examples/Solutions.scala
+66 −0		src/test/scala/examples/SyncReadMemTest.scala
+1 −1		src/test/scala/examples/VecShiftRegister.scala
+2 −0		src/test/scala/verilator/Verilator.scala
+2 −0		src/test/scala/verilator/ZeroWidth.scala
+2 −0		src/test/scala/verilator/doohickey.scala
+2 −0		src/test/scala/verilator/thingamabob.scala
+66 −0		.github/scripts/ExtractBuildDependenciesFromPullRequest.gawk
+29 −0		.github/scripts/generateGitClones.gawk
+21 −0		.github/scripts/generateVersionOverrides.gawk
+106 −0		.github/workflows/test.yml
+3 −0		.scala-steward.conf
+184 −0		LICENSE
+0 −26		LICENSE.txt
+8 −6		build.sbt
+9 −7		build.sc
+1 −1		diagram.sh
+1 −1		project/build.properties
+3 −3		src/main/scala/dotvisualizer/FirrtlDiagrammer.scala
+1 −1		src/main/scala/dotvisualizer/Scope.scala
+1 −1		src/main/scala/dotvisualizer/ToLoFirrtl.scala
+2 −0		src/main/scala/dotvisualizer/dotnodes/DotNode.scala
+1 −1		src/main/scala/dotvisualizer/dotnodes/LiteralNode.scala
+1 −1		src/main/scala/dotvisualizer/dotnodes/MemNode.scala
+1 −1		src/main/scala/dotvisualizer/dotnodes/ModuleNode.scala
+1 −1		src/main/scala/dotvisualizer/dotnodes/MuxNode.scala
+1 −1		src/main/scala/dotvisualizer/dotnodes/NodeNode.scala
+1 −1		src/main/scala/dotvisualizer/dotnodes/PortNode.scala
+1 −1		src/main/scala/dotvisualizer/dotnodes/PrimOpNode.scala
+1 −1		src/main/scala/dotvisualizer/dotnodes/PrintfNode.scala
+1 −1		src/main/scala/dotvisualizer/dotnodes/RegisterNode.scala
+1 −1		src/main/scala/dotvisualizer/dotnodes/ValidIfNode.scala
+1 −1		src/main/scala/dotvisualizer/transforms/MakeDiagramGroup.scala
+3 −3		src/main/scala/dotvisualizer/transforms/MakeOneDiagram.scala
+1 −1		src/main/scala/dotvisualizer/transforms/ModuleLevelDiagrammer.scala
+2 −2		src/main/scala/dotvisualizer/transforms/RemoveTempWires.scala
+5 −4		src/test/scala/dotvisualizer/AttachExample.scala
+5 −4		src/test/scala/dotvisualizer/FirExample.scala
+4 −3		src/test/scala/dotvisualizer/GCD.scala
+5 −3		src/test/scala/dotvisualizer/HierarchicalModulesExample.scala
+7 −6		src/test/scala/dotvisualizer/PrintfSpec.scala
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		These files were used to generate the waveforms used in documentation.
-Original file line number
+Diff line change
@@ -1,3 +1,4 @@
     {
     signal: [
       ['in',
@@ Expand Down @@