jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update the nimc.rst document about the release/danger split [bugfix]

Browse source
This commit is contained in:
Andreas Rumpf 2019-06-08 00:13:57 +02:00
commit bf63d83a97
1 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/nimc.rst
View file

@ -132,8 +132,8 @@ Through the ``-d:x`` or ``--define:x`` switch you can define compile time
symbols for conditional compilation. The defined switches can be checked in symbols for conditional compilation. The defined switches can be checked in
source code with the `when statement <manual.html#when-statement>`_ and source code with the `when statement <manual.html#when-statement>`_ and
`defined proc <system.html#defined>`_. The typical use of this switch is to `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 enable builds in release mode (``-d:release``) where optimizations are
omitted for better performance. Another common use is the ``-d:ssl`` switch to enabled for better performance. Another common use is the ``-d:ssl`` switch to
activate SSL sockets. activate SSL sockets.
Additionally, you may pass a value along with the symbol: ``-d:x=y`` Additionally, you may pass a value along with the symbol: ``-d:x=y``
@ -169,6 +169,10 @@ The default build of a project is a `debug build`:idx:. To compile a
nim c -d:release myproject.nim nim c -d:release myproject.nim
To compile a `dangerous release build`:idx: define the ``danger`` symbol::
nim c -d:danger myproject.nim
Search path handling Search path handling
-------------------- --------------------
@ -344,10 +348,10 @@ complete list.
====================== ========================================================= ====================== =========================================================
Define Effect Define Effect
====================== ========================================================= ====================== =========================================================
``release`` Turns off runtime checks and turns on the optimizer. ``release`` Turns on the optimizer.
More aggressive optimizations are possible, eg: More aggressive optimizations are possible, eg:
``--passC:-ffast-math`` (but see issue #10305) ``--passC:-ffast-math`` (but see issue #10305)
``--stacktrace:off`` ``danger`` Turns off all runtime checks and turns on the optimizer.
``useFork`` Makes ``osproc`` use ``fork`` instead of ``posix_spawn``. ``useFork`` Makes ``osproc`` use ``fork`` instead of ``posix_spawn``.
``useNimRtl`` Compile and link against ``nimrtl.dll``. ``useNimRtl`` Compile and link against ``nimrtl.dll``.
``useMalloc`` Makes Nim use C's `malloc`:idx: instead of Nim's ``useMalloc`` Makes Nim use C's `malloc`:idx: instead of Nim's