summaryrefslogtreecommitdiff
path: root/lisp/profiler.el
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2021-06-19 08:17:47 -0700
committerGlenn Morris <rgm@gnu.org>2021-06-19 08:17:47 -0700
commit510458a9f1e7e5a4924e80ceafbaf35e73cfac02 (patch)
tree21b617fc6facb241189eded559ad5f53e5a25ac0 /lisp/profiler.el
parentf8e5871c16a7b36b46833485dbe198ce90922ea5 (diff)
parent7722b510aae119162a20cfc67d3057152835a4ba (diff)
downloademacs-510458a9f1e7e5a4924e80ceafbaf35e73cfac02.tar.gz
Merge from origin/emacs-27
7722b510aa (origin/emacs-27) Another improvement in documentation of ... 8d5c70d73a Improve documentation of profiler 0ffef0b46b Document 'ispell-program-name' 7be610f911 Fix documentation of 'face-extend-p' # Conflicts: # doc/lispref/debugging.texi
Diffstat (limited to 'lisp/profiler.el')
-rw-r--r--lisp/profiler.el8
1 files changed, 6 insertions, 2 deletions
diff --git a/lisp/profiler.el b/lisp/profiler.el
index 64d71f4aab2..8145e51d75d 100644
--- a/lisp/profiler.el
+++ b/lisp/profiler.el
@@ -822,8 +822,12 @@ below entry at point."
(defun profiler-start (mode)
"Start/restart profilers.
MODE can be one of `cpu', `mem', or `cpu+mem'.
-If MODE is `cpu' or `cpu+mem', time-based profiler will be started.
-Also, if MODE is `mem' or `cpu+mem', then memory profiler will be started."
+If MODE is `cpu' or `cpu+mem', start the time-based profiler,
+ whereby CPU is sampled periodically using the SIGPROF signal.
+If MODE is `mem' or `cpu+mem', start profiler that samples CPU
+ whenever memory-allocation functions are called -- this is useful
+ if SIGPROF is not supported, or is unreliable, or is not sampling
+ at a high enough frequency."
(interactive
(list (if (not (fboundp 'profiler-cpu-start)) 'mem
(intern (completing-read (format-prompt "Mode" "cpu")