Commit 93304e31 authored by Gemini Lasswell's avatar Gemini Lasswell
Browse files

Improve documentation of Edebug and macros

* doc/lispref/edebug.texi (Instrumenting Macro Calls): Improve
discussion of when it might be necessary to find and evaluate macro
specifications before instrumenting.
(Specification List): Clarify what "defining form" means to Edebug
and when 'def-form' or 'def-body' should be used instead of 'form'
or 'body'.
parent 79108894
...@@ -1144,9 +1144,12 @@ the @code{declare} form. ...@@ -1144,9 +1144,12 @@ the @code{declare} form.
@c automatically load the entire source file containing the function @c automatically load the entire source file containing the function
@c being instrumented. That would avoid this. @c being instrumented. That would avoid this.
Take care to ensure that the specifications are known to Edebug when Take care to ensure that the specifications are known to Edebug when
you instrument code. If you are instrumenting a function from a file you instrument code. If you are instrumenting a function which uses a
that uses @code{eval-when-compile} to require another file containing macro defined in another file, you may first need to either evaluate
macro definitions, you may need to explicitly load that file. the @code{require} forms in the file containing your function, or
explicitly load the file containing the macro. If the definition of a
macro is wrapped by @code{eval-when-compile}, you may need to evaluate
it.
You can also define an edebug specification for a macro separately You can also define an edebug specification for a macro separately
from the macro definition with @code{def-edebug-spec}. Adding from the macro definition with @code{def-edebug-spec}. Adding
...@@ -1231,13 +1234,17 @@ A single unevaluated Lisp object, which is not instrumented. ...@@ -1231,13 +1234,17 @@ A single unevaluated Lisp object, which is not instrumented.
@c an "expression" is not necessarily intended for evaluation. @c an "expression" is not necessarily intended for evaluation.
@item form @item form
A single evaluated expression, which is instrumented. A single evaluated expression, which is instrumented. If your macro
wraps the expression with @code{lambda} before it is evaluated, use
@code{def-form} instead. See @code{def-form} below.
@item place @item place
A generalized variable. @xref{Generalized Variables}. A generalized variable. @xref{Generalized Variables}.
@item body @item body
Short for @code{&rest form}. See @code{&rest} below. Short for @code{&rest form}. See @code{&rest} below. If your macro
wraps its body of code with @code{lambda} before it is evaluated, use
@code{def-body} instead. See @code{def-body} below.
@item function-form @item function-form
A function form: either a quoted function symbol, a quoted lambda A function form: either a quoted function symbol, a quoted lambda
...@@ -1292,11 +1299,16 @@ succeeds. ...@@ -1292,11 +1299,16 @@ succeeds.
@item &define @item &define
@c @kindex &define @r{(Edebug)} @c @kindex &define @r{(Edebug)}
Indicates that the specification is for a defining form. The defining
form itself is not instrumented (that is, Edebug does not stop before and Indicates that the specification is for a defining form. Edebug's
after the defining form), but forms inside it typically will be definition of a defining form is a form containing one or more code
instrumented. The @code{&define} keyword should be the first element in forms which are saved and executed later, after the execution of the
a list specification. defining form.
The defining form itself is not instrumented (that is, Edebug does not
stop before and after the defining form), but forms inside it
typically will be instrumented. The @code{&define} keyword should be
the first element in a list specification.
@item nil @item nil
This is successful when there are no more arguments to match at the This is successful when there are no more arguments to match at the
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment