summaryrefslogtreecommitdiff
path: root/doc/lispref/symbols.texi
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2016-01-16 17:13:16 +0200
committerEli Zaretskii <eliz@gnu.org>2016-01-16 17:13:16 +0200
commit9f493814bb40f1794ab53c84a5397aba1da58cd7 (patch)
tree01be3fb2c27354471ce77ac62d632813b85f38c1 /doc/lispref/symbols.texi
parent964ba0f5261b2de1c5979cef8727cd1663b4438b (diff)
downloademacs-9f493814bb40f1794ab53c84a5397aba1da58cd7.tar.gz
Document 'function-put'
* doc/lispref/symbols.texi (Symbol Plists): Document 'function-put'. Update documentation of 'function-get'.
Diffstat (limited to 'doc/lispref/symbols.texi')
-rw-r--r--doc/lispref/symbols.texi17
1 files changed, 15 insertions, 2 deletions
diff --git a/doc/lispref/symbols.texi b/doc/lispref/symbols.texi
index c99f993e5da..8c1ec3d85e2 100644
--- a/doc/lispref/symbols.texi
+++ b/doc/lispref/symbols.texi
@@ -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