[Emacs-diffs] emacs-24 r117481: * doc/lispref/functions.texi (Core Advising Primitives): Add a note about the

[Stefan Monnier]

------------------------------------------------------------
revno: 117481
revision-id: address@hidden
parent: address@hidden
fixes bug: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=18399
committer: Stefan Monnier <address@hidden>
branch nick: emacs-24
timestamp: Thu 2014-09-04 11:43:06 -0400
message:
  * doc/lispref/functions.texi (Core Advising Primitives): Add a note about the
  confusing treatment of `interactive' for :filter-args.
modified:
  doc/lispref/ChangeLog          changelog-20091113204419-o5vbwnq5f7feedwu-6155
  doc/lispref/functions.texi     
functions.texi-20091113204419-o5vbwnq5f7feedwu-6182

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2014-08-19 18:56:29 +0000
+++ b/doc/lispref/ChangeLog     2014-09-04 15:43:06 +0000
@@ -1,3 +1,8 @@
+2014-09-04  Stefan Monnier  <address@hidden>
+
+       * functions.texi (Core Advising Primitives): Add a note about the
+       confusing treatment of `interactive' for :filter-args (bug#18399).
+
 2014-08-19  Eli Zaretskii  <address@hidden>
 
        * display.texi (Bidirectional Display): Update the Emacs's class

=== modified file 'doc/lispref/functions.texi'
--- a/doc/lispref/functions.texi        2014-05-27 01:09:45 +0000
+++ b/doc/lispref/functions.texi        2014-09-04 15:43:06 +0000
@@ -1220,15 +1220,6 @@
 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
address@hidden  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 @@
 @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
address@hidden  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},
address@hidden:filter-args}, and @code{filter-return}, where @var{function}.
 @end defmac
 
 @defmac remove-function place function