[Emacs-diffs] /srv/bzr/emacs/emacs-24 r110931: Add a bit more about profiling to the lispref

[Glenn Morris]

------------------------------------------------------------
revno: 110931
committer: Glenn Morris <address@hidden>
branch nick: emacs-24
timestamp: Tue 2012-11-20 20:52:03 -0500
message:
  Add a bit more about profiling to the lispref
  
  * doc/lispref/debugging.texi (Profiling):
  Add some basic information about the profile report buffer.
  (Debugging): Mention profiling in the introduction.
modified:
  doc/lispref/ChangeLog
  doc/lispref/debugging.texi

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2012-11-21 01:32:09 +0000
+++ b/doc/lispref/ChangeLog     2012-11-21 01:52:03 +0000
@@ -1,6 +1,8 @@
 2012-11-21  Glenn Morris  <address@hidden>
 
-       * debugging.texi (Profiling) [!tex]: Mention --enable-profiling.
+       * debugging.texi (Profiling): Mention --enable-profiling (if !tex).
+       Add some basic information about the profile report buffer.
+       (Debugging): Mention profiling in the introduction.
 
 2012-11-20  Glenn Morris  <address@hidden>
 

=== modified file 'doc/lispref/debugging.texi'
--- a/doc/lispref/debugging.texi        2012-11-21 01:32:09 +0000
+++ b/doc/lispref/debugging.texi        2012-11-21 01:52:03 +0000
@@ -32,6 +32,9 @@
 @item
 You can use the ERT package to write regression tests for the program.
 @xref{Top,the ERT manual,, ERT, ERT: Emacs Lisp Regression Testing}.
+
address@hidden
+You can profile the program to get hints about how to make it more efficient.
 @end itemize
 
   Other useful tools for debugging input and output problems are the
@@ -834,10 +837,20 @@
 When you have finished profiling, type @kbd{M-x profiler-stop} (there
 is a small overhead associated with profiling).
 
address@hidden FIXME
address@hidden Basic apperance of the report buffer:
-
address@hidden The following commands are available in the report buffer:
+The profiler report buffer shows, on each line, a function that was
+called, followed by how much resource (processor or memory) it used in
+absolute and percentage times since profiling started.  If a given
+line has a @samp{+} symbol at the left-hand side, you can expand that
+line by typing @key{RET}, in order to see the function(s) called by
+the higher-level function.  Pressing @key{RET} again will collapse
+back to the original state.
+
+Press @kbd{j} or @kbd{mouse-2} to jump to the definition of a function.
+Press @kbd{d} to view a function's documentation.
+You can save a profile to a file using @kbd{C-x C-w}.
+You can compare two profiles using @kbd{=}.
+
address@hidden FIXME reversed calltree?
 
 @cindex @file{elp.el}
 @cindex timing programs