summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorAndreas Rumpf <rumpf_a@web.de>2014-06-12 16:39:20 +0200
committerAndreas Rumpf <rumpf_a@web.de>2014-06-12 16:39:20 +0200
commitd927eb5854e9c6c005344bc81d4632ffc8f5d975 (patch)
tree145a26a74dd4b93f67f5a1ae70602133df12960d /doc
parentd3c8f1ab25a810516baccc2b1bff761dbbc2d011 (diff)
parentaf6abac4911be18bd92a9190ccbe39aa72ab1a79 (diff)
downloadNim-d927eb5854e9c6c005344bc81d4632ffc8f5d975.tar.gz
Merge pull request #1251 from gradha/pr_misc_docs
Misc docs suggestions
Diffstat (limited to 'doc')
-rw-r--r--doc/nimrodc.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/nimrodc.txt b/doc/nimrodc.txt
index e4f1c41dc..fea1037da 100644
--- a/doc/nimrodc.txt
+++ b/doc/nimrodc.txt
@@ -87,6 +87,18 @@ Level  Description
        for compiler developers.
 =====  ============================================
 
+
+Compile time symbols
+--------------------
+
+Through the ``-d:x`` or ``--define:x`` switch you can define compile time
+symbols for conditional compilation. The defined switches can be checked in
+source code with the `when statement <manual.html#when-statement>`_ and
+`defined proc <system.html#defined>`_. The typical use of this switch is to
+enable builds in release mode (``-d:release``) where certain safety checks are
+omitted for better performance. Another common use is the ``-d:ssl`` switch to
+activate `SSL sockets <sockets.html>`_.
+
 

 Configuration files

 -------------------