branch: externals/emacs-gc-stats
commit 4504beaba25263d27e883229248744bda5e457d7
Author: Ihor Radchenko <yanta...@posteo.net>
Commit: Ihor Radchenko <yanta...@posteo.net>
emacs-gc-stats-gc-defaults: Add more details to the docstring
---
emacs-gc-stats.el | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/emacs-gc-stats.el b/emacs-gc-stats.el
index a520778c93..82dd83b873 100644
--- a/emacs-gc-stats.el
+++ b/emacs-gc-stats.el
@@ -54,7 +54,9 @@
:type 'file)
(defcustom emacs-gc-stats-gc-defaults nil
- "GC strategy to be active in `emacs-gc-stats-mode'."
+ "GC strategy to be active in `emacs-gc-stats-mode'.
+This setting, when non-nil, will override the existing values of
+`gc-cons-threshold' and `gc-cons-percentage'."
:type '(choice
(const :tag "Do not change existing GC settings" nil)
(const :tag "Force emacs defaults" emacs-defaults)))
