From: Noam Postavsky <npostavs@gmail.com>
Date: Wed, 23 May 2018 00:08:01 +0000 (-0400)
Subject: Clarify when to use advice-add vs add-function
X-Git-Tag: emacs-26.1~15
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=e3f00f5637a2790923a9c4c1d4b7dbf65027d8ce;p=emacs.git

Clarify when to use advice-add vs add-function

* lisp/emacs-lisp/nadvice.el (add-function): Note in docstring that
advice-add should be used for named functions.
---

diff --git a/lisp/emacs-lisp/nadvice.el b/lisp/emacs-lisp/nadvice.el
index e2e68250575..e20cc6570db 100644
--- a/lisp/emacs-lisp/nadvice.el
+++ b/lisp/emacs-lisp/nadvice.el
@@ -288,6 +288,9 @@ a special meaning:
 If PLACE is a symbol, its `default-value' will be affected.
 Use (local \\='SYMBOL) if you want to apply FUNCTION to SYMBOL buffer-locally.
 Use (var VAR) if you want to apply FUNCTION to the (lexical) VAR.
+If you are trying to modify an existing named function rather
+than a function value, you probably want to use `advice-add'
+instead (see Info node `(elisp) Advising Named Functions').
 
 If one of FUNCTION or OLDFUN is interactive, then the resulting function
 is also interactive.  There are 3 cases: