Include plugin in instructions since it will be required in 3.5.
Also make sure the example actually works.

* Bugfix - definition name index skipping with D/I

* Add tests to DefinitionSpec

* Add failing test

* Fix failing test

* Update core/src/main/scala/chisel3/internal/Builder.scala

Co-authored-by: Jack Koenig <jack.koenig3@gmail.com>

* whitespace

* revert package private val

Co-authored-by: Jack Koenig <jack.koenig3@gmail.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>

This fixes CI which fails with current firrtl 1.5-SNAPSHOT.

These were not actually deprecated but any APIs using them were long
since deprecated and more recently removed.

They also depend on long deprecated APIs in FIRRTL that will soon be
removed.

Co-authored-by: Jiuyang Liu <liu@jiuyang.me>

Also remove as many deprecated APIs as possible by inlining
implementations of old deprecated/removed code from firrtl

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Update sbt-mdoc to 2.2.24

Update sbt-scoverage to 1.9.2

* refactor Queue.hasFlush: Boolean to Queue.flush: Option[Bool].

Using factory Queue(..., hasFlush = true) won't take effects, since in the Queue.apply API, Queue Module is not exposed, thus even user defines hasFlush = true, there is no place for them to give the flush signal.
This commit fix this, refactor Queue.hasFlush: Boolean to Queue.flush: Option[Bool], makes user be able to pass the flush signal into Queue Module.

* use zip to connect.

* refactor docs.

Co-authored-by: Megan Wachs <megan@sifive.com>

Remove toBools

Update sbt-unidoc to 0.5.0

Update sbt-scalafix to 0.9.32

* Update Arbiter.scala

* Update src/main/scala/chisel3/util/Arbiter.scala

changed group name

Co-authored-by: Megan Wachs <megan@sifive.com>

* minor changes on grouping ArbiterIO

* removed unmatched closing brace

* Remove groupdesc from Arbiter.scala

* Added groupdesc to Aggregate.scala

* Update Arbiter.scala

* Update core/src/main/scala/chisel3/Aggregate.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update Arbiter.scala

* Update src/main/scala/chisel3/util/Arbiter.scala

Added suugestions.

Co-authored-by: Megan Wachs <megan@sifive.com>

* added suggestions from review

* added suggestions from review

* Resolved conflicts

* update Arbiter.scala

* Update core/src/main/scala/chisel3/Aggregate.scala

deleted groudesc for ArbiterIO

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update Scaladoc syntax

* removed some lines

* Better documentation

* Removed @param and @gen

* Update core/src/main/scala/chisel3/Aggregate.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update src/main/scala/chisel3/util/Arbiter.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

* Added groupdesc to ArbiterIO

* Update src/main/scala/chisel3/util/Arbiter.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update core/src/main/scala/chisel3/Aggregate.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update Arbiter.scala

* Update src/main/scala/chisel3/util/Arbiter.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update Arbiter.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

* Add field grouping scaladocs for DecoupledIo

* Added groupdesc to DecoupledIO

* Added groupings for IrrevocableIO

* Add groupings for ValidIO

* Add field grouping scaladoc for PRNGIO

* Add field grouping scaladoc for QueueIO

* Added groupings for PipeIO

* Update src/main/scala/chisel3/util/Decoupled.scala

Commited Sugestion

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update src/main/scala/chisel3/util/Decoupled.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update src/main/scala/chisel3/util/Decoupled.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update src/main/scala/chisel3/util/Decoupled.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update src/main/scala/chisel3/util/Decoupled.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update src/main/scala/chisel3/util/Valid.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update src/main/scala/chisel3/util/Valid.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update src/main/scala/chisel3/util/Valid.scala

Co-authored-by: Megan Wachs <megan@sifive.com>

Co-authored-by: Megan Wachs <megan@sifive.com>

It can be set as default 2.13 build version later.

Exposing more internals of D/I, which are required for supporting D/I with more powerful Chisel libraries:

- Exposing IsClone[_]
- Exposing InstantiableClone[_]
- Gated builders for Instance/Definition
- Unsealing Lookupable, with protected accessors for proto and cloned

Previously, the example had an extra wrapping module that led
to the interesting example getting optimized away.

* Add Hierarchy trait

* Add Hierarchy trait

* Add Hierarchy scaladoc

* Add license

* Add isA and tests

* Add back isA

* Add new Select APIs for hierarchy package

* Update scaladoc

* Write outlines for tests

* Add tests and fixes to new Select functions

* Make calculate via lazy val

* Apply suggestions from code review

Co-authored-by: Megan Wachs <megan@sifive.com>

* Apply suggestions from code review

Co-authored-by: Megan Wachs <megan@sifive.com>

* Clean up scaladoc

* Add shouldNot compile

* Apply suggestions from code review

Co-authored-by: Megan Wachs <megan@sifive.com>

* Bugfix all funcs should analyze root too

* Add mdoc, bugfix toDefinition

* Make func private, add scaladoc

* Update src/test/scala/chiselTests/experimental/hierarchy/InstanceSpec.scala

Co-authored-by: Jack Koenig <koenig@sifive.com>

* Made protected vals private

* Apply suggestions from code review

Co-authored-by: Jack Koenig <koenig@sifive.com>

* Address code review comments

* Added additional null check

Co-authored-by: Megan Wachs <megan@sifive.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>

* Add Hierarchy trait

* Add Hierarchy trait

* Add Hierarchy scaladoc

* Add license

* Add isA and tests

* Add back isA

* Make calculate via lazy val

* Apply suggestions from code review

Co-authored-by: Megan Wachs <megan@sifive.com>

* Add shouldNot compile

* Update src/test/scala/chiselTests/experimental/hierarchy/InstanceSpec.scala

Co-authored-by: Jack Koenig <koenig@sifive.com>

* Made protected vals private

Co-authored-by: Megan Wachs <megan@sifive.com>
Co-authored-by: Jack Koenig <koenig@sifive.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* Update bundles-and-vecs.md

* Update docs/src/explanations/bundles-and-vecs.md

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update naming.md

Added a title to the cookbook

* Add name to Multiple Clock Domain page

* Update multi-clock.md

Co-authored-by: Megan Wachs <megan@sifive.com>

* add scastie links (#2185)

* add scastie version (#2185)

Co-authored-by: Megan Wachs <megan@sifive.com>

* Create CONTRIBUTING.md

* Update README.md

Added guide for new contributors

* Update CONTRIBUTING.md

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update CONTRIBUTING.md

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update README.md

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update CONTRIBUTING.md

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update CONTRIBUTING.md

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update CONTRIBUTING.md

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update README.md

updated link to CONTRIBUTING.md

* Update README.md

updated link to CONTRIBUTING.md

* Update README.md

* Update README.md

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update README.md

Reposition contributing guide

* Update CONTRIBUTING.md

removed verilog guide

Co-authored-by: Megan Wachs <megan@sifive.com>

* Update README.md

Added verilog tutorial link to useful resources area.

Co-authored-by: Megan Wachs <megan@sifive.com>