summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorJuan Carlos <juancarlospaco@gmail.com>2020-06-09 10:43:42 -0300
committerGitHub <noreply@github.com>2020-06-09 15:43:42 +0200
commit881fa94b57d6d0ebd661ad21340c8e75f173809d (patch)
tree2ab1eb4c3e7a7d084fb26edf86e8b1e80d02b377 /doc
parentaa70cfdea282e717a41f7dbfec32d739f7b2e08a (diff)
downloadNim-881fa94b57d6d0ebd661ad21340c8e75f173809d.tar.gz
Documentation Fix Typo, Add Table (#14609)
Diffstat (limited to 'doc')
-rw-r--r--doc/gc.rst14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/gc.rst b/doc/gc.rst
index 01e6b347f..39d6d0484 100644
--- a/doc/gc.rst
+++ b/doc/gc.rst
@@ -36,13 +36,25 @@ To choose the memory management strategy use the ``--gc:`` switch.
   cause memory leaks, beware.
 
 - ``--gc:orc``. Same as ``-gc:arc`` but adds a cycle collector based on "trial deletion".
-  Unforunately that makes its performance profile hard to reason about so it is less
+  Unfortunately that makes its performance profile hard to reason about so it is less
   useful for hard realtime systems.
 
 - ``--gc:none``. No memory management strategy nor garbage collector. Allocated memory is
   simply never freed. You should use ``--gc:arc`` instead.
 
 
+================== ======== ================= ======================
+Memory Management  Heap     Reference Cycles  Command line switch
+================== ======== ================= ======================
+RefC               Local    Cycle Collector   ``--gc:refc``
+Mark & Sweep       Local    Cycle Collector   ``--gc:markAndSweep``
+ARC                Shared   Leak              ``--gc:arc``
+ORC                Shared   Cycle Collector   ``--gc:orc``
+Boehm              Shared   Cycle Collector   ``--gc:boehm``
+Go                 Shared   Cycle Collector   ``--gc:go``
+None               Manual   Manual            ``--gc:none``
+================== ======== ================= ======================
+
 JavaScript's garbage collector is used for the `JavaScript and NodeJS
 <backends.html#backends-the-javascript-target>`_ compilation targets.
 The `NimScript <nims.html>`_ target uses the memory management strategy built into