* Previously, this test failed whenever InlineCasts was run

* Make RenameTop DependencyAPI-compliant

Nuclear Option (-Xfatal-warnings) for Scaladoc Build

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

Turn on -Xfatal-warnings when building documentation.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

Co-authored-by: Jim Lawson <ucbjrl@berkeley.edu>

* Eliminate warnings on `sbt doc` and `sbt unidoc`
- removed toFirrtl reference on MultiTargetAnnotation
- lots of places where package path has to be added to comment references
- Change to use `/** text starts here` convention when wrong in comment with a doc fix.
  - Did not exhaustively change these
- Wrestled doc example in RenderDiGraph#renderNode, not sure if I won
- Cleaned up InferWidths & CatchExceptions imports
- Added missing license message to a couple of files.
- fixed a couple of stale parameter names in scaladoc
- Added @unchecked to stop erasure warning in Emitting where emission annotations are collected
- Change types to [_] on match in RenameMap#recordAll to fix erasure warning

* Where  possible change [[firrtl.ir.X]] to [[firrtl.ir.X X]] for better display in scaladoc

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

* Fixes #1464

* Removed unused imports in src/test/

* Update ScalaTest deprecations.

* Update scalatest from 3.0.8 to 3.1.0; apply auto fix for deprecations

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

* Link to Java API Documentation

This adds a build.sbt apiMappings to allow for Scaladoc/Unidoc linking
to Java API documentation. This uses the exact strategy that Scala
upstream uses for linking.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

* Add example of Java and Scala API docs linking

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

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

* Remove toNamed (and friends) deprecation.

* Add inadvertently deleted leading double quote.

* Remove commented out deprecations.

* Explicitly initialize firrtl.stage.Forms to prevent multi-thread collisions
See https://github.com/freechipsproject/firrtl/issues/1462.
Convert `lazy val` members of firrtl.stage.Forms to plan `val`s.
Reference firrtl.stage.Forms in sufficient locations to ensure the object is initialized before its members are accessed.

* Respond to comments - make _dummyForms private.

* Move Forms initialization to package object.

* Merge with master

* Change from log-level debug to trace
* Serialize as JSON rather than .serialize on each annotation

Co-Authored-By: Chick Markley <chick@qrhino.com>

* Pull out common test utilities into a separate package

* Project a fat jar for test utilities

Co-authored-by: Albert Magyar <albert.magyar@gmail.com>

Check for name collisions of Modules

* Fixes #1096

* Fixes #1436

Make InlineInstances invalidate ResolveKinds

Fixes #1453

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

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

Introduce Preset Register Specialized Emission
- Introduce EmissionOption trait
- Introduce PresetAnnotation & PresetRegAnnotation
- Enable the collection of Annotations in the Emitter
- Introduce collection mechanism for EmissionOptions in the Emitter
- Add PropagatePresetAnnotation transform to annotate register for emission and clean-up the useless reset tree (no DCE involved)
- Add corresponding tests spec and tester

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

* Fixes #1214

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

- Use Dependency API for transform scheduling
- Add tests that old order/behavior is preserved

Or: "Now you're thinking with dependencies."

Co-authored-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
Co-authored-by: Albert Magyar <albert.magyar@gmail.com>
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

Co-authored-by: Albert Magyar <albert.magyar@gmail.com>

* Provide an annotation mix-in that marks RTs as dontTouch

* Update src/main/scala/firrtl/transforms/OptimizationAnnotations.scala

Co-Authored-By: Albert Magyar <albert.magyar@gmail.com>

* Update src/test/scala/firrtlTests/DCETests.scala

Co-Authored-By: Albert Magyar <albert.magyar@gmail.com>

* Update src/main/scala/firrtl/transforms/OptimizationAnnotations.scala

* Update OptimizationAnnotations.scala

Co-authored-by: Albert Magyar <albert.magyar@gmail.com>

Make mergify open backport PRs & signal on failed cherry-picks