aboutsummaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorwhitequark <whitequark@whitequark.org>2020-06-04 10:46:54 +0000
committerwhitequark <whitequark@whitequark.org>2020-06-08 20:19:41 +0000
commitfbb346ea91a04f2feaf6fa96770fe0cd57020e75 (patch)
tree9cf9e3b9020ae24cc9f8219f9b985c8e3589f7a1 /manual
parent8d821dbbdb3ba68d4cd0fdb0d5857e77725275b9 (diff)
downloadyosys-fbb346ea91a04f2feaf6fa96770fe0cd57020e75.tar.gz
yosys-fbb346ea91a04f2feaf6fa96770fe0cd57020e75.tar.bz2
yosys-fbb346ea91a04f2feaf6fa96770fe0cd57020e75.zip
flatten: preserve original object names via hdlname attribute.
Diffstat (limited to 'manual')
-rw-r--r--manual/CHAPTER_Overview.tex7
1 files changed, 7 insertions, 0 deletions
diff --git a/manual/CHAPTER_Overview.tex b/manual/CHAPTER_Overview.tex
index ac0f48e47..83cfa5cc4 100644
--- a/manual/CHAPTER_Overview.tex
+++ b/manual/CHAPTER_Overview.tex
@@ -193,6 +193,13 @@ Violating these rules results in a runtime error.
All RTLIL identifiers are case sensitive.
+Some transformations, such as flattening, may have to change identifiers provided by the user
+to avoid name collisions. When that happens, attribute ``{\tt hdlname}`` is attached to the object
+with the changed identifier. This attribute contains one name (if emitted directly by the frontend,
+or is a result of disambiguation) or multiple names separated by spaces (if a result of flattening).
+All names specified in the ``{\tt hdlname}`` attribute are public and do not include the leading
+``\textbackslash``.
+
\subsection{RTLIL::Design and RTLIL::Module}
The RTLIL::Design object is basically just a container for RTLIL::Module objects. In addition to