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

document Nim's signal handling briefly; closes #8224

Browse source
This commit is contained in:
Araq 2018-09-03 12:02:56 +02:00
commit d1e3a7c827
1 changed files with 45 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

19
doc/nimc.rst
View file

@ -326,9 +326,9 @@ The standard library supports a growing number of ``useX`` conditional defines
affecting how some features are implemented. This section tries to give a affecting how some features are implemented. This section tries to give a
complete list. complete list.
================== ========================================================= ====================== =========================================================
Define Effect Define Effect
================== ========================================================= ====================== =========================================================
``release`` Turns off runtime checks and turns on the optimizer. ``release`` Turns off runtime checks and turns on the optimizer.
``useWinAnsi`` Modules like ``os`` and ``osproc`` use the Ansi versions ``useWinAnsi`` Modules like ``os`` and ``osproc`` use the Ansi versions
of the Windows API. The default build uses the Unicode of the Windows API. The default build uses the Unicode
@ -358,8 +358,9 @@ Define Effect
``useShPath`` This symbol takes a string as its value, like ``useShPath`` This symbol takes a string as its value, like
``--define:useShPath:/opt/sh/bin/sh`` to override the ``--define:useShPath:/opt/sh/bin/sh`` to override the
path for the ``sh`` binary, in cases where it is not path for the ``sh`` binary, in cases where it is not
located in the default location ``/bin/sh`` located in the default location ``/bin/sh``.
================== ========================================================= ``noSignalHandler`` Disable the crash handler from ``system.nim``.
====================== =========================================================
@ -529,6 +530,16 @@ See the documentation of Nim's soft realtime `GC <gc.html>`_ for further
information. information.
Signal handling in Nim
======================
The Nim programming language has no concept of Posix's signal handling
mechanisms. However, the standard library offers some rudimentary support
for signal handling, in particular, segmentation faults are turned into
fatal errors that produce a stack trace. This can be disabled with the
``-d:noSignalHandler`` switch.
Debugging with Nim Debugging with Nim
================== ==================