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

gc.rst: updated the docs to reflect reality

Browse source
This commit is contained in:
Araq 2020-10-20 15:00:16 +02:00
commit 877d520616
1 changed files with 1 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

3
doc/gc.rst
View file

@ -176,8 +176,7 @@ 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. 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 used types in your program and for every type
the total amount of object instances for this type as well as the total the total amount of object instances for this type as well as the total
amount of bytes these instances take up. This list is currently unsorted! amount of bytes these instances take up.
You need to use external shell script hacking to sort it.
The numbers count the number of objects in all garbage collector heaps, they refer to The numbers count the number of objects in all garbage collector heaps, they refer to
all running threads, not only to the current thread. (The current thread all running threads, not only to the current thread. (The current thread