diff options
author | Tim Smith <69870077+timscodebase@users.noreply.github.com> | 2020-10-28 09:56:56 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-28 17:56:56 +0100 |
commit | 485d4ff802c361f363d2f455b98abc5db1a7082d (patch) | |
tree | 4ebfbe00564f5f41e5e4a4dc41aa5cac78e58304 /doc | |
parent | 94e2b9e83725d8bcaa43f4bb3e64b8c79d3bec95 (diff) | |
download | Nim-485d4ff802c361f363d2f455b98abc5db1a7082d.tar.gz |
Spelling and Grammer fixes (#15719)
Co-authored-by: Tim Smith <tim.smith.hdg@gmail.com> Co-authored-by: Miran <narimiran@disroot.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/gc.rst | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/gc.rst b/doc/gc.rst index 23c4f64cf..804481cd9 100644 --- a/doc/gc.rst +++ b/doc/gc.rst @@ -102,10 +102,14 @@ These two procs are the two modus operandi of the real-time garbage collector: To bind all garbage collector activity to a ``GC_step`` call, deactivate the garbage collector with ``GC_disable`` at program startup. If ``strongAdvice`` is set to ``true``, - then the garbage collector will be forced to perform collection cycle. + then the garbage collector will be forced to perform the collection cycle. Otherwise, the garbage collector may decide not to do anything, if there is not much garbage to collect. You may also specify the current stack size via ``stackSize`` parameter. + It can improve performance when you know that there are no unique Nim references + below a certain point on the stack. Make sure the size you specify is greater + than the potential worst-case size. + It can improve performance when you know that there are no unique Nim references below a certain point on the stack. Make sure the size you specify is greater than the potential worst-case size. @@ -174,7 +178,7 @@ Heap dump The heap dump feature is still in its infancy, but it already proved useful for us, so it might be useful for you. To get a heap dump, compile with ``-d:nimTypeNames`` and call ``dumpNumberOfInstances`` at a strategic place in your program. -This produces a list of used types in your program and for every type +This produces a list of the used types in your program and for every type the total amount of object instances for this type as well as the total amount of bytes these instances take up. |