From 3084e597f4586b0a075dfe3eb56f1c729406266b Mon Sep 17 00:00:00 2001 From: Stefan Monnier Date: Thu, 4 Sep 2014 11:43:06 -0400 Subject: * doc/lispref/functions.texi (Core Advising Primitives): Add a note about the confusing treatment of `interactive' for :filter-args. Fixes: debbugs:18399 --- doc/lispref/ChangeLog | 5 +++++ doc/lispref/functions.texi | 24 +++++++++++++++--------- 2 files changed, 20 insertions(+), 9 deletions(-) diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 7a88fd456d3..e8efcaa923c 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,8 @@ +2014-09-04 Stefan Monnier + + * functions.texi (Core Advising Primitives): Add a note about the + confusing treatment of `interactive' for :filter-args (bug#18399). + 2014-08-19 Eli Zaretskii * display.texi (Bidirectional Display): Update the Emacs's class diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi index 019c75ba021..a5e81547d9a 100644 --- a/doc/lispref/functions.texi +++ b/doc/lispref/functions.texi @@ -1220,15 +1220,6 @@ ways to do it. The added function is also called an @emph{advice}. This macro is the handy way to add the advice @var{function} to the function stored in @var{place} (@pxref{Generalized Variables}). -If @var{function} is not interactive, then the combined function will inherit -the interactive spec, if any, of the original function. Else, the combined -function will be interactive and will use the interactive spec of -@var{function}. One exception: if the interactive spec of @var{function} -is a function (rather than an expression or a string), then the interactive -spec of the combined function will be a call to that function with as sole -argument the interactive spec of the original function. To interpret the spec -received as argument, use @code{advice-eval-interactive-spec}. - @var{where} determines how @var{function} is composed with the existing function, e.g. whether @var{function} should be called before, or after the original function. @xref{Advice combinators}, for the list of @@ -1271,6 +1262,21 @@ original function and other advices will apply to it, whereas an outermost @code{:override} advice will override not only the original function but all other advices applied to it as well. @end table + +If @var{function} is not interactive, then the combined function will inherit +the interactive spec, if any, of the original function. Else, the combined +function will be interactive and will use the interactive spec of +@var{function}. One exception: if the interactive spec of @var{function} +is a function (rather than an expression or a string), then the interactive +spec of the combined function will be a call to that function with as sole +argument the interactive spec of the original function. To interpret the spec +received as argument, use @code{advice-eval-interactive-spec}. + +Note: The interactive spec of @var{function} will apply to the combined +function and should hence obey the calling convention of the combined function +rather than that of @var{function}. In many cases, it makes no difference +since they are identical, but it does matter for @code{:around}, +@code{:filter-args}, and @code{filter-return}, where @var{function}. @end defmac @defmac remove-function place function -- cgit v1.2.1