Do not document subr-x.el in the manuals

[gnu-emacs] / doc / lispref / debugging.texi

diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi
index ef1342ea2899f4f285ce3e51d5f604e9e25dc3dc..774ac594e0da5f6275062f970b6093315779ab7a 100644 (file)
--- a/doc/lispref/debugging.texi
+++ b/doc/lispref/debugging.texi
@@ -1,6 +1,7 @@
 @c -*-texinfo-*-
 @c This is part of the GNU Emacs Lisp Reference Manual.
-@c Copyright (C) 1990-1994, 1998-1999, 2001-2012 Free Software Foundation, Inc.
+@c Copyright (C) 1990-1994, 1998-1999, 2001-2014 Free Software
+@c Foundation, Inc.
 @c See the file elisp.texi for copying conditions.
 @node Debugging
 @chapter Debugging Lisp Programs
@@ -31,7 +32,10 @@ program.
 
 @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}.
+@xref{Top,the ERT manual,, ert, ERT: Emacs Lisp Regression Testing}.
+
+@item
+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
@@ -384,6 +388,7 @@ the same function.  (To do this, visit the source for the function and
 type @kbd{C-M-x} on its definition.)  You cannot use the Lisp debugger
 to step through a primitive function.
 
+@c FIXME: Add @findex for the following commands?  --xfq
   Here is a list of Debugger mode commands:
 
 @table @kbd
@@ -458,6 +463,10 @@ This is a list of functions that are set to break on entry by means of
 @code{debug-on-entry}.  @strong{Warning:} if you redefine such a
 function and thus cancel the effect of @code{debug-on-entry}, it may
 erroneously show up in this list.
+
+@item v
+Display local variables (@pxref{Local Variables}) of the current stack
+frame.  Press @kbd{e} again to hide them.
 @end table
 
 @node Invoking the Debugger
@@ -834,10 +843,20 @@ generate another report later on without erasing previous results.
 When you have finished profiling, type @kbd{M-x profiler-stop} (there
 is a small overhead associated with profiling).
 
-@c FIXME
-@c Basic apperance of 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{=}.
 
-@c The following commands are available in the report buffer:
+@c FIXME reversed calltree?
 
 @cindex @file{elp.el}
 @cindex timing programs
@@ -853,7 +872,7 @@ You can check the speed of individual Emacs Lisp forms using the
 @c Not worth putting in the printed manual.
 @ifnottex
 @cindex --enable-profiling option of configure
-For low-level profiling of Emacs itself, you can build it using the
+To profile Emacs at the level of its C code, you can build it using the
 @option{--enable-profiling} option of @command{configure}.  When Emacs
 exits, it generates a file @file{gmon.out} that you can examine using
 the @command{gprof} utility.  This feature is mainly useful for