aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAlan Mackenzie2016-05-07 06:42:29 +0000
committerAlan Mackenzie2016-05-07 06:42:29 +0000
commited5282d239b4304bcc6274dd06e1ce2b5e575053 (patch)
treecee75575e047eadccdf270f6199a215188bb4f6a /doc
parentbf7fc7a8047752b6b1cff65dc8b8e2bc8173f626 (diff)
downloademacs-ed5282d239b4304bcc6274dd06e1ce2b5e575053.tar.gz
emacs-ed5282d239b4304bcc6274dd06e1ce2b5e575053.zip
Add an option in Edebug to prevent pauses after `h', 'f', and `o'.
Requested by Paul Pogonyshev. Also add in documentation for Edebug config variables which was missing. * lisp/emacs-lisp/edebug.el (edebug-sit-on-break): New customizable option. (edebug--display-1): Test edebug-sit-on-break before pausing 1 second. * doc/lispref/edebug.texi (Jumping): Document the effect of the new option. (Edebug Options): Document the new option. Also add documentation for edebug-eval-macro-args, edebug-print-length, edebug-print-level, edebug-print-circle, edebug-sit-for-seconds. * etc/NEWS: Note the new feature.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/edebug.texi39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/lispref/edebug.texi b/doc/lispref/edebug.texi
index 47fe02a4a57..65ccb646909 100644
--- a/doc/lispref/edebug.texi
+++ b/doc/lispref/edebug.texi
@@ -384,6 +384,11 @@ now, it returns from the function and then stops. In other words, this
384command does not exit the currently executing function unless you are 384command does not exit the currently executing function unless you are
385positioned after the last sexp. 385positioned after the last sexp.
386 386
387Normally, the @kbd{h}, @kbd{f}, and @kbd{o} commands display ``Break''
388and pause for @code{edebug-sit-for-seconds} before showing the result
389of the form just evaluated. You can avoid this pause by setting
390@code{edebug-sit-on-break} to @code{nil}. @xref{Edebug Options}.
391
387The @kbd{i} command steps into the function or macro called by the list 392The @kbd{i} command steps into the function or macro called by the list
388form after point, and stops at its first stop point. Note that the form 393form after point, and stops at its first stop point. Note that the form
389need not be the one about to be evaluated. But if the form is a 394need not be the one about to be evaluated. But if the form is a
@@ -1543,6 +1548,14 @@ Use the command @kbd{M-x edebug-all-forms} to toggle the value of this
1543option. @xref{Instrumenting}. 1548option. @xref{Instrumenting}.
1544@end defopt 1549@end defopt
1545 1550
1551@defopt edebug-eval-macro-args
1552When this is non-@code{nil}, all macro arguments will be instrumented
1553in the generated code. For any macro, an @code{edebug-form-spec}
1554overrides this option. So to specify exceptions for macros that have
1555some arguments evaluated and some not, use @code{def-edebug-spec} to
1556specify an @code{edebug-form-spec}.
1557@end defopt
1558
1546@defopt edebug-save-windows 1559@defopt edebug-save-windows
1547If this is non-@code{nil}, Edebug saves and restores the window 1560If this is non-@code{nil}, Edebug saves and restores the window
1548configuration. That takes some time, so if your program does not care 1561configuration. That takes some time, so if your program does not care
@@ -1601,6 +1614,21 @@ debugged.
1601@xref{Edebug Execution Modes}. 1614@xref{Edebug Execution Modes}.
1602@end defopt 1615@end defopt
1603 1616
1617@defopt edebug-print-length
1618If non-@code{nil}, the default value of @code{print-length} for
1619printing results in Edebug. @xref{Output Variables}.
1620@end defopt
1621
1622@defopt edebug-print-level
1623If non-@code{nil}, the default value of @code{print-level} for
1624printing results in Edebug. @xref{Output Variables}.
1625@end defopt
1626
1627@defopt edebug-print-circle
1628If non-@code{nil}, the default value of @code{print-circle} for
1629printing results in Edebug. @xref{Output Variables}.
1630@end defopt
1631
1604@defopt edebug-unwrap-results 1632@defopt edebug-unwrap-results
1605If non-@code{nil}, Edebug tries to remove any of its own 1633If non-@code{nil}, Edebug tries to remove any of its own
1606instrumentation when showing the results of expressions. This is 1634instrumentation when showing the results of expressions. This is
@@ -1647,3 +1675,14 @@ If non-@code{nil}, an expression to test for at every stop point. If
1647the result is non-@code{nil}, then break. Errors are ignored. 1675the result is non-@code{nil}, then break. Errors are ignored.
1648@xref{Global Break Condition}. 1676@xref{Global Break Condition}.
1649@end defopt 1677@end defopt
1678
1679@defopt edebug-sit-for-seconds
1680Number of seconds to pause when a breakpoint is reached and the execution
1681mode is trace or continue. @xref{Edebug Execution Modes}.
1682@end defopt
1683
1684@defopt edebug-sit-on-break
1685Whether or not to pause for @code{edebug-sit-for-seconds} on reaching
1686a breakpoint. Set to @code{nil} to prevent the pause, non-@code{nil}
1687to allow it.
1688@end defopt