From 2d98132dfb849ef6c987ee5f49be596794887a08 Mon Sep 17 00:00:00 2001
From: Adam Izraelevitz
Date: Mon, 26 Oct 2020 14:26:23 -0700
Subject: Added Force Name API (#1634)

* Added forcename transform and tests

* Added documentation and additional error checking

* Added mdoc. Added RunFirrtlTransform trait

* Removed TODO comment

* Addressed reviewer feedback

* Removed trailing comma

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>---
 docs/src/cookbooks/naming.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

(limited to 'docs/src/cookbooks')

diff --git a/docs/src/cookbooks/naming.md b/docs/src/cookbooks/naming.md
index 604843aa..4d87ece7 100644
--- a/docs/src/cookbooks/naming.md
+++ b/docs/src/cookbooks/naming.md
@@ -60,3 +60,36 @@ class ExampleNoPrefix extends MultiIOModule {
 
 println(ChiselStage.emitVerilog(new ExampleNoPrefix))
 ```
+
+### I am still not getting the name I want. For example, inlining an instance changes my name!
+
+In cases where a FIRRTL transform renames a signal/instance, you can use the `forcename` API:
+
+```scala mdoc
+import chisel3.util.experimental.{forceName, InlineInstance}
+
+class WrapperExample extends MultiIOModule {
+  val in = IO(Input(UInt(3.W)))
+  val out = IO(Output(UInt(3.W)))
+  val inst = Module(new Wrapper)
+  inst.in := in
+  out := inst.out
+}
+class Wrapper extends MultiIOModule with InlineInstance {
+  val in = IO(Input(UInt(3.W)))
+  val out = IO(Output(UInt(3.W)))
+  val inst = Module(new MyLeaf)
+  forceName(inst, "inst")
+  inst.in := in
+  out := inst.out
+}
+class MyLeaf extends MultiIOModule {
+  val in = IO(Input(UInt(3.W)))
+  val out = IO(Output(UInt(3.W)))
+  out := in
+}
+
+println(ChiselStage.emitVerilog(new WrapperExample))
+```
+
+This can be used to rename instances and non-aggregate typed signals.
-- 
cgit v1.2.3