diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2021-06-19 16:08:50 +0300 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2021-06-19 16:08:50 +0300 |
| commit | 7722b510aae119162a20cfc67d3057152835a4ba (patch) | |
| tree | d1e7b21b86ea9689260fcfc309e764b49eedd4bc /lisp/profiler.el | |
| parent | 8d5c70d73acf2fe05494dde5fdffa13e257bf819 (diff) | |
| download | emacs-7722b510aae119162a20cfc67d3057152835a4ba.tar.gz | |
Another improvement in documentation of "memory" profiler
* lisp/profiler.el (profiler-start): Fix the doc string to better
explain what is "memory" profiler.
Diffstat (limited to 'lisp/profiler.el')
| -rw-r--r-- | lisp/profiler.el | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/lisp/profiler.el b/lisp/profiler.el index eb0e2c94e24..7cdd3511277 100644 --- a/lisp/profiler.el +++ b/lisp/profiler.el @@ -812,8 +812,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 "Mode (default cpu): " |