aboutsummaryrefslogtreecommitdiffstats
path: root/manual/CHAPTER_Overview.tex
diff options
context:
space:
mode:
authorwhitequark <whitequark@whitequark.org>2020-06-09 06:26:02 +0000
committerGitHub <noreply@github.com>2020-06-09 06:26:02 +0000
commit4351194e8ce94e7078b67a20e5fc92777d6cb3e6 (patch)
tree7d2027cda96eeb6c16506ca8b1c9df2fe475efa7 /manual/CHAPTER_Overview.tex
parent83f84afc0b617fe78fb7cfa31fb9d1cd202e22f2 (diff)
parent53688a24b531adcc99c091f728e9657d16010467 (diff)
downloadyosys-4351194e8ce94e7078b67a20e5fc92777d6cb3e6.tar.gz
yosys-4351194e8ce94e7078b67a20e5fc92777d6cb3e6.tar.bz2
yosys-4351194e8ce94e7078b67a20e5fc92777d6cb3e6.zip
Merge pull request #2107 from whitequark/flatten-hdlname
flatten: preserve original object names
Diffstat (limited to 'manual/CHAPTER_Overview.tex')
-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