procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Another improvement in documentation of "memory" profiler

Browse source 
* lisp/profiler.el (profiler-start): Fix the doc string to better
explain what is "memory" profiler.
This commit is contained in:
Eli Zaretskii 2021-06-19 16:08:50 +03:00
parent 8d5c70d73a
commit 7722b510aa
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
lisp/profiler.el
View file

@ -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): "