branch: externals/emacs-gc-stats
commit 073b137f67c55a63a42aad687b7f31744c73dd86
Author: Ihor Radchenko <yanta...@posteo.net>
Commit: Ihor Radchenko <yanta...@posteo.net>
README: Clarify what is being collected
---
README.md | 10 ++++++++++
README.org | 9 +++++++++
2 files changed, 19 insertions(+)
diff --git a/README.md b/README.md
index 325f379dbc..f6443497ab 100644
--- a/README.md
+++ b/README.md
@@ -27,3 +27,13 @@ and then share the saved `emacs-gc-stats-file` (defaults to
You can use `M-x emacs-gc-stats-clear` to clear the currently collected
session data.
+The following data is being collected after every command:
+
+- GC settings `gc-cons-threshold` and `gc-cons-percentage`
+- Emacs version and whether Emacs framework (Doom, Prelude, etc) is used
+- Whether `gcmh-mode` is used
+- Idle time and Emacs uptime
+- Available OS memory (see `memory-info`)
+- Emacs memory allocation/GC stats
+- Current command
+
diff --git a/README.org b/README.org
index d92f8bc104..7a4a916c16 100644
--- a/README.org
+++ b/README.org
@@ -28,3 +28,12 @@ mailto:emacs-gc-st...@gnu.org.
You can use =M-x emacs-gc-stats-clear= to clear the currently collected
session data.
+
+The following data is being collected after every command:
+- GC settings ~gc-cons-threshold~ and ~gc-cons-percentage~
+- Emacs version and whether Emacs framework (Doom, Prelude, etc) is used
+- Whether ~gcmh-mode~ is used
+- Idle time and Emacs uptime
+- Available OS memory (see ~memory-info~)
+- Emacs memory allocation/GC stats
+- Current command
