Skip to content

Commit

Permalink
[FIRRTL][SpecializeLayers] Update doc with proper attribute name (#7199)
Browse files Browse the repository at this point in the history
  • Loading branch information
youngar authored Jun 18, 2024
1 parent 6b68559 commit a49e31d
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions include/circt/Dialect/FIRRTL/Passes.td
Original file line number Diff line number Diff line change
Expand Up @@ -885,13 +885,13 @@ def SpecializeLayers : Pass<"firrtl-specialize-layers", "firrtl::CircuitOp"> {
This pass performs specialization of layers, layerblocks, and probe
operations by permanantly enabling or disabling layers. The layers are
specified by attributes on the `firrtl.circuit` operation in the
`firrtl.enable_layers` and `firrtl.disable_layers` attributes which are both
lists of SymbolRefAttrs. When a layer is specialized, it will be removed
from the circuit and all references to it should be cleaned up. If a layer
is disabled, all layerblock are referencing that layer will be deleted, and
all probe colored by that layer will be removed. When a layer is enabled,
all contents of the layer will be inlined in to the outer context, and
probes colored by that layer will no longer be colored.
`enable_layers` and `disable_layers` attributes which are both lists of
SymbolRefAttrs. When a layer is specialized, it will be removed from the
circuit and all references to it should be cleaned up. If a layer is
disabled, all layerblock are referencing that layer will be deleted, and all
probe colored by that layer will be removed. When a layer is enabled, all
contents of the layer will be inlined in to the outer context, and probes
colored by that layer will no longer be colored.
}];
let constructor = "circt::firrtl::createSpecializeLayersPass()";
}
Expand Down

0 comments on commit a49e31d

Please sign in to comment.