diff --git a/src/main/scala/firrtl/stage/FirrtlAnnotations.scala b/src/main/scala/firrtl/stage/FirrtlAnnotations.scala index 805777efac..9e6fefcae9 100644 --- a/src/main/scala/firrtl/stage/FirrtlAnnotations.scala +++ b/src/main/scala/firrtl/stage/FirrtlAnnotations.scala @@ -314,7 +314,11 @@ object DisableFold extends HasShellOptions { } -/** Indicate to the FIRRTL compiler that specific transforms +/** Indicate to the FIRRTL compiler that specific transforms have already been run. + * + * The intended use of this is for advanced users who want to skip specific transforms in the FIRRTL compiler. It is + * far safer for users to use the command line options to the FIRRTL compiler via `--start-from =
`. + * @param currentState a sequence of transforms that have already been run on the circuit */ case class CurrentFirrtlStateAnnotation(currentState: Seq[TransformDependency]) extends NoTargetAnnotation