aboutsummaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorclairexen <claire@symbioticeda.com>2020-05-29 16:31:44 +0200
committerGitHub <noreply@github.com>2020-05-29 16:31:44 +0200
commitaf36afe722dc35b129351af592ef340e512e0292 (patch)
treec2bd330880c5e443d69ac51fb4a2e45eebeb4016 /manual
parent5874a14d659068acbf04aa381a782ea8c0a5adce (diff)
parentefa7424fb93943d746a344d08e5e879d983709e9 (diff)
downloadyosys-af36afe722dc35b129351af592ef340e512e0292.tar.gz
yosys-af36afe722dc35b129351af592ef340e512e0292.tar.bz2
yosys-af36afe722dc35b129351af592ef340e512e0292.zip
Merge pull request #2092 from whitequark/rtlil-no-space-control
Restrict RTLIL::IdString to not contain whitespace or control chars
Diffstat (limited to 'manual')
-rw-r--r--manual/CHAPTER_Overview.tex9
1 files changed, 6 insertions, 3 deletions
diff --git a/manual/CHAPTER_Overview.tex b/manual/CHAPTER_Overview.tex
index be37d8d39..ac0f48e47 100644
--- a/manual/CHAPTER_Overview.tex
+++ b/manual/CHAPTER_Overview.tex
@@ -184,9 +184,12 @@ may hold important information for Yosys developers can be used without
disturbing external tools. For example the Verilog backend assigns names in the form {\tt \_{\it integer}\_}.
\end{itemize}
-In order to avoid programming errors, the RTLIL data structures check if all
-identifiers start with either a backslash or a dollar sign and generate a
-runtime error if this rule is violated.
+Whitespace and control characters (any character with an ASCII code 32 or less) are not allowed
+in RTLIL identifiers; most frontends and backends cannot support these characters in identifiers.
+
+In order to avoid programming errors, the RTLIL data structures check if all identifiers start
+with either a backslash or a dollar sign, and contain no whitespace or control characters.
+Violating these rules results in a runtime error.
All RTLIL identifiers are case sensitive.