aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman2003-10-13 19:23:30 +0000
committerRichard M. Stallman2003-10-13 19:23:30 +0000
commit89f6de49f51624fb5aefe8fbc6594c3b4ff8add7 (patch)
tree17bb50969350c7e36b77c6b11f31eb9ad5a98d73
parent9543c58ce2a307609ca4179b95382f4398db8955 (diff)
downloademacs-89f6de49f51624fb5aefe8fbc6594c3b4ff8add7.tar.gz
emacs-89f6de49f51624fb5aefe8fbc6594c3b4ff8add7.zip
(Edebug Execution Modes): Clarify t.
Document edebug-sit-for-seconds. (Coverage Testing): Document C-x X = and =. (Instrumenting Macro Calls): Fix typo. (Specification List): Don't index the specification keywords.
-rw-r--r--lispref/edebug.texi27
1 files changed, 18 insertions, 9 deletions
diff --git a/lispref/edebug.texi b/lispref/edebug.texi
index 051a7467ebc..30e5602c274 100644
--- a/lispref/edebug.texi
+++ b/lispref/edebug.texi
@@ -257,7 +257,8 @@ Next: stop at the next stop point encountered after an expression
257@ref{Edebug Misc}. 257@ref{Edebug Misc}.
258 258
259@item t 259@item t
260Trace: pause one second at each Edebug stop point (@code{edebug-trace-mode}). 260Trace: pause (normally one second) at each Edebug stop point
261(@code{edebug-trace-mode}).
261 262
262@item T 263@item T
263Rapid trace: update the display at each stop point, but don't actually 264Rapid trace: update the display at each stop point, but don't actually
@@ -307,6 +308,10 @@ specifies step mode. Note that you may reenter the same Edebug level
307several times if, for example, an instrumented function is called 308several times if, for example, an instrumented function is called
308several times from one command. 309several times from one command.
309 310
311@defopt edebug-sit-for-seconds
312This option specifies how many seconds to wait between execution steps
313in trace mode. The default is 1 second.
314@end defvar
310 315
311@node Jumping 316@node Jumping
312@subsection Jumping 317@subsection Jumping
@@ -871,8 +876,12 @@ performed for all execution of an instrumented function, even if the
871execution mode is Go-nonstop, and regardless of whether coverage testing 876execution mode is Go-nonstop, and regardless of whether coverage testing
872is enabled. 877is enabled.
873 878
874 Use @kbd{M-x edebug-display-freq-count} to display both the 879@kindex C-x X =
875coverage information and the frequency counts for a definition. 880@findex edebug-temp-display-freq-count
881 Use @kbd{C-x X =} (@code{edebug-display-freq-count}) to display both
882the coverage information and the frequency counts for a definition.
883Just @kbd{=} (@code{edebug-temp-display-freq-count}) displays the same
884information temporarily, only until you type another key.
876 885
877@deffn Command edebug-display-freq-count 886@deffn Command edebug-display-freq-count
878This command displays the frequency count data for each line of the 887This command displays the frequency count data for each line of the
@@ -1077,7 +1086,7 @@ For example, (for i from 1 to 10 do (print i))."
1077 ...) 1086 ...)
1078@end example 1087@end example
1079 1088
1080 The Edebug specifation says which parts of a call to the macro are 1089 The Edebug specification says which parts of a call to the macro are
1081forms to be evaluated. For simple macros, the @var{specification} 1090forms to be evaluated. For simple macros, the @var{specification}
1082often looks very similar to the formal argument list of the macro 1091often looks very similar to the formal argument list of the macro
1083definition, but specifications are much more general than macro 1092definition, but specifications are much more general than macro
@@ -1184,7 +1193,7 @@ either way.
1184A lambda expression with no quoting. 1193A lambda expression with no quoting.
1185 1194
1186@item &optional 1195@item &optional
1187@kindex &optional @r{(Edebug)} 1196@c @kindex &optional @r{(Edebug)}
1188All following elements in the specification list are optional; as soon 1197All following elements in the specification list are optional; as soon
1189as one does not match, Edebug stops matching at this level. 1198as one does not match, Edebug stops matching at this level.
1190 1199
@@ -1194,7 +1203,7 @@ elements must all match or none, use @code{&optional
1194[@var{specs}@dots{}]}. See the @code{defun} example below. 1203[@var{specs}@dots{}]}. See the @code{defun} example below.
1195 1204
1196@item &rest 1205@item &rest
1197@kindex &rest @r{(Edebug)} 1206@c @kindex &rest @r{(Edebug)}
1198All following elements in the specification list are repeated zero or 1207All following elements in the specification list are repeated zero or
1199more times. In the last repetition, however, it is not a problem if the 1208more times. In the last repetition, however, it is not a problem if the
1200expression runs out before matching all of the elements of the 1209expression runs out before matching all of the elements of the
@@ -1205,7 +1214,7 @@ To specify several elements that must all match on every repetition, use
1205@code{&rest [@var{specs}@dots{}]}. 1214@code{&rest [@var{specs}@dots{}]}.
1206 1215
1207@item &or 1216@item &or
1208@kindex &or @r{(Edebug)} 1217@c @kindex &or @r{(Edebug)}
1209Each of the following elements in the specification list is an 1218Each of the following elements in the specification list is an
1210alternative. One of the alternatives must match, or the @code{&or} 1219alternative. One of the alternatives must match, or the @code{&or}
1211specification fails. 1220specification fails.
@@ -1215,14 +1224,14 @@ group two or more list elements as a single alternative, enclose them in
1215@code{[@dots{}]}. 1224@code{[@dots{}]}.
1216 1225
1217@item &not 1226@item &not
1218@kindex &not @r{(Edebug)} 1227@c @kindex &not @r{(Edebug)}
1219Each of the following elements is matched as alternatives as if by using 1228Each of the following elements is matched as alternatives as if by using
1220@code{&or}, but if any of them match, the specification fails. If none 1229@code{&or}, but if any of them match, the specification fails. If none
1221of them match, nothing is matched, but the @code{&not} specification 1230of them match, nothing is matched, but the @code{&not} specification
1222succeeds. 1231succeeds.
1223 1232
1224@item &define 1233@item &define
1225@kindex &define @r{(Edebug)} 1234@c @kindex &define @r{(Edebug)}
1226Indicates that the specification is for a defining form. The defining 1235Indicates that the specification is for a defining form. The defining
1227form itself is not instrumented (that is, Edebug does not stop before and 1236form itself is not instrumented (that is, Edebug does not stop before and
1228after the defining form), but forms inside it typically will be 1237after the defining form), but forms inside it typically will be