]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve documentation of 'defcustom's :set keyword
authorEli Zaretskii <eliz@gnu.org>
Thu, 30 Mar 2023 06:09:43 +0000 (09:09 +0300)
committerEli Zaretskii <eliz@gnu.org>
Thu, 30 Mar 2023 06:09:43 +0000 (09:09 +0300)
* lisp/custom.el (defcustom):
* doc/lispref/customize.texi (Variable Definitions): Improve the
documentation of the :set keyword in 'defcustom'.

doc/lispref/customize.texi
lisp/custom.el

index 308145def55482d8d7695001598e4f3ab2bb2070..6015c134d21373b8e219f267afe8a7adcdcb923e 100644 (file)
@@ -378,8 +378,15 @@ the option as a Lisp variable); preferably, though, it should not
 modify its value argument destructively.  The default for
 @var{setfunction} is @code{set-default-toplevel-value}.
 
+If defined, @var{setfunction} will also be called when evaluating a
+@code{defcustom} form with @kbd{C-M-x} in Emacs Lisp mode and when the
+@var{option}'s value is changed via the @code{setopt} macro
+(@pxref{Setting Variables, setopt}).
+
 If you specify this keyword, the variable's documentation string
-should describe how to do the same job in hand-written Lisp code.
+should describe how to do the same job in hand-written Lisp code,
+either by invoking @var{setfunction} directly or by using
+@code{setopt}.
 
 @item :get @var{getfunction}
 @kindex get@r{, @code{defcustom} keyword}
index 0522bdd447be65abfbe56511c3c793b802e01d89..df6db181615a35c01b25be01a62b6ec8aef13d99 100644 (file)
@@ -280,7 +280,9 @@ The following keywords are meaningful:
        when using the Customize user interface.  It takes two arguments,
        the symbol to set and the value to give it.  The function should
        not modify its value argument destructively.  The default choice
-       of function is `set-default-toplevel-value'.
+       of function is `set-default-toplevel-value'.  If this keyword is
+       defined, modifying the value of SYMBOL via `setopt' will call the
+       function specified by VALUE to install the new value.
 :get   VALUE should be a function to extract the value of symbol.
        The function takes one argument, a symbol, and should return
        the current value for that symbol.  The default choice of function