masscollaborationlabs/emacs
2
0
Fork 0
mirror of https://github.com/masscollaborationlabs/emacs.git synced 2025-07-13 15:39:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve documentation of profiler

Browse source 
* doc/lispref/debugging.texi (Profiling): Stop misleading users
about what "memory" profiling really is.
This commit is contained in:
Eli Zaretskii 2021-06-19 15:39:11 +03:00
parent 0ffef0b46b
commit 8d5c70d73a
1 changed files with 7 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

13
doc/lispref/debugging.texi
View file

@ -997,11 +997,12 @@ start looking for ways to optimize that piece.
@findex profiler-report @findex profiler-report
@findex profiler-stop @findex profiler-stop
Emacs has built-in support for this. To begin profiling, type Emacs has built-in support for this. To begin profiling, type
@kbd{M-x profiler-start}. You can choose to profile by processor @w{@kbd{M-x profiler-start}}. You can choose to sample CPU usage
usage, memory usage, or both. Then run the code you'd like to speed periodically (@code{cpu}), when memory is allocated (@code{memory}),
up. After that, type @kbd{M-x profiler-report} to display a summary or both. Then run the code you'd like to speed up. After that, type
buffer for each resource (cpu and memory) that you chose to profile. @kbd{M-x profiler-report} to display a summary buffer for CPU usage
The names of the report buffers include the times at which the reports sampled by each type (cpu and memory) that you chose to profile. The
names of the report buffers include the times at which the reports
were generated, so you can generate another report later on without were generated, so you can generate another report later on without
erasing previous results. When you have finished profiling, type erasing previous results. When you have finished profiling, type
@kbd{M-x profiler-stop} (there is a small overhead associated with @kbd{M-x profiler-stop} (there is a small overhead associated with
@ -1009,7 +1010,7 @@ profiling, so we don't recommend leaving it active except when you are
actually running the code you want to examine). actually running the code you want to examine).
The profiler report buffer shows, on each line, a function that was The profiler report buffer shows, on each line, a function that was
called, followed by how much resources (cpu or memory) it used in called, followed by how much CPU resources it used in
absolute and percentage terms since profiling started. If a given absolute and percentage terms since profiling started. If a given
line has a @samp{+} symbol at the left-hand side, you can expand that line has a @samp{+} symbol at the left-hand side, you can expand that
line by typing @kbd{@key{RET}}, in order to see the function(s) called line by typing @kbd{@key{RET}}, in order to see the function(s) called