summary refs log tree commit diff stats
path: root/doc/nimc.rst
diff options
context:
space:
mode:
authorAraq <rumpf_a@web.de>2019-07-12 10:48:07 +0200
committerAraq <rumpf_a@web.de>2019-07-12 10:48:07 +0200
commit13253f41544404c614e70d7ad312b54d0e424e55 (patch)
tree6be0b01ce579f11482a06c05db6176260c59c3bf /doc/nimc.rst
parent5bf3734984c7a488b38e0b5fe48a298af40d7d03 (diff)
downloadNim-13253f41544404c614e70d7ad312b54d0e424e55.tar.gz
document 'nim' defines prefix
Diffstat (limited to 'doc/nimc.rst')
-rw-r--r--doc/nimc.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/nimc.rst b/doc/nimc.rst
index e750a5b12..a7cee7f59 100644
--- a/doc/nimc.rst
+++ b/doc/nimc.rst
@@ -144,6 +144,9 @@ to override symbols during build time.
 Compile time symbols are completely **case insensitive** and underscores are
 ignored too. ``--define:FOO`` and ``--define:foo`` are identical.
 
+Compile time symbols starting with the ``nim`` prefix are reserved for the
+implementation and should not be used elsewhere.
+
 
 Configuration files
 -------------------