document 'nim' defines prefix

(cherry picked from commit 13253f4154)
2026-04-22 23:35:22 +00:00 · 2019-07-12 10:48:07 +02:00
parent 8eb66f6c6b
commit 5a11ae85b1
1 changed files with 3 additions and 0 deletions
--- 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
 -------------------