Skip to content

Commit 44364dc

Browse files
committed
[docs] Minor cleanup to layer docs
Make some small modifications to improve the documentation of layers. Signed-off-by: Schuyler Eldridge <[email protected]>
1 parent 4985fa8 commit 44364dc

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/src/explanations/layers.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ section: "chisel3"
99
Layers describe functionality of a Chisel generator that a user would like to
1010
_optionally_ include at Verilog elaboration time. Pragmatically, they are a
1111
feature to access SystemVerilog's `bind` construct and `` `ifdef `` preprocessor
12-
macros. Layers are typically used to describe design verification code or
12+
macros. The optional functionality of layers, by construction, is not allowed
13+
to affect logic outside the layer.
14+
15+
Layers are typically used to describe design verification code or
1316
debugging logic that a user would like to be able to later disable (for
1417
performance, verbosity, or cleanliness reasons) or use internally, but exclude
1518
from delivery to a customer.
@@ -176,8 +179,7 @@ after a design is compiled to SystemVerilog.
176179

177180
:::info
178181

179-
For the exact definition of the FIRRTL ABI for layers, see the [latest version
180-
of the FIRRTL ABI
182+
For the exact definition of the FIRRTL ABI for layers, see the [FIRRTL ABI
181183
Specification](https://github.com/chipsalliance/firrtl-spec/releases/latest/download/abi.pdf).
182184

183185
:::

0 commit comments

Comments
 (0)