]> code.delx.au - gnu-emacs/commitdiff
Document 'function-put'
authorEli Zaretskii <eliz@gnu.org>
Sat, 16 Jan 2016 15:13:16 +0000 (17:13 +0200)
committerEli Zaretskii <eliz@gnu.org>
Sat, 16 Jan 2016 15:13:16 +0000 (17:13 +0200)
* doc/lispref/symbols.texi (Symbol Plists): Document
'function-put'.  Update documentation of 'function-get'.

doc/lispref/symbols.texi
etc/NEWS

index c99f993e5daebdd21f915d4856f6aed1b328c021..8c1ec3d85e230f17622e44d50e1ee80d2632af64 100644 (file)
@@ -461,10 +461,23 @@ You could define @code{put} in terms of @code{setplist} and
 @end example
 @end defun
 
-@defun function-get symbol property
+@defun function-get symbol property &optional autoload
 This function is identical to @code{get}, except that if @var{symbol}
 is the name of a function alias, it looks in the property list of the
-symbol naming the actual function.  @xref{Defining Functions}.
+symbol naming the actual function.  @xref{Defining Functions}.  If the
+optional argument @var{autoload} is non-@code{nil}, and @var{symbol}
+is auto-loaded, this function will try to autoload it, since
+autoloading might set @var{property} of @var{symbol}.  If
+@var{autoload} is the symbol @code{macro}, only try autoloading if
+@var{symbol} is an auto-loaded macro.
+@end defun
+
+@defun function-put function property value
+This function sets @var{property} of @var{function} to @var{value}.
+@var{function} should be a symbol.  This function is preferred to
+calling @code{put} for setting properties of a function, because it
+will allow us some day to implement remapping of old properties to new
+ones.
 @end defun
 
 @node Standard Properties
index 6735718b63c51c452f89d355d41fd519009872a3..9dba4e58bed8a33c06a2c58d0f5586eb4dc0e31b 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1472,6 +1472,7 @@ MS-Windows doesn't support UTF-8 as codeset in its locales.
 but makes `called-interactively-p' treat the function as (you guessed it)
 called interactively.
 
++++
 ** New function `function-put' to use instead of `put' for function properties.
 
 +++