Merge pull request #155 from ivanyu/ivanyu/gh-141-update-readme

Update README
ivanyu · Nov 13, 2022 · 93bdd44 · 93bdd44
2 parents 5a6031d + fd385a2
commit 93bdd44
Show file tree

Hide file tree

Showing 5 changed files with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -126,6 +126,8 @@ When the break point is hit by one of the threads, the Python script `injector.p
 
 The dumper script uses the Python standard modules `gc` and `sys` to collect some information about heap objects and their sizes. It does some job to avoid irrelevant garbage created by itself to appear in the heap dump, but some traces of it will be there.
 
+A dump is not a fair snapshot in time as some threads and the garbage collector continue working while it's being done.
+
 ### What Objects Are Dumped
 
 Currently, the dumper sees objects traced by the CPython garbage collector and the objects they reference to (more precisely, the ones they return in their [`tp_traverse`](https://docs.python.org/3/c-api/typeobj.html#c.PyTypeObject.tp_traverse)).

diff --git a/doc/screenshot1.png b/doc/screenshot1.png
diff --git a/doc/screenshot2.png b/doc/screenshot2.png
diff --git a/doc/screenshot3.png b/doc/screenshot3.png
diff --git a/doc/screenshot4.png b/doc/screenshot4.png