Improve documentation for custom :options

* doc/lispref/customize.texi (Variable Definitions):
Mention that re-evaluating a defcustom form doesn't reset custom
options (bug#30101).
This commit is contained in:
Mauro Aranda 2020-09-01 16:59:58 +02:00 committed by Lars Ingebrigtsen
parent ed8dd99884
commit 0996047476

View file

@ -358,6 +358,10 @@ This is meaningful only for certain types, currently including
@code{hook}, @code{plist} and @code{alist}. See the definition of the
individual types for a description of how to use @code{:options}.
Re-evaluating a @code{defcustom} form with a different @code{:options}
value does not clear the values added by previous evaluations, or
added by calls to @code{custom-add-frequent-value} (see below).
@item :set @var{setfunction}
@kindex set@r{, @code{defcustom} keyword}
Specify @var{setfunction} as the way to change the value of this
@ -485,6 +489,10 @@ list of reasonable values.
The precise effect of adding a value depends on the customization type
of @var{symbol}.
Since evaluating a @code{defcustom} form does not clear values added
previously, Lisp programs can use this function to add values for user
options not yet defined.
@end defun
Internally, @code{defcustom} uses the symbol property