aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref/customize.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/lispref/customize.texi')
-rw-r--r--doc/lispref/customize.texi13
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi
index 364edf63031..705af15e4e2 100644
--- a/doc/lispref/customize.texi
+++ b/doc/lispref/customize.texi
@@ -372,12 +372,15 @@ added by calls to @code{custom-add-frequent-value} (see below).
372@item :set @var{setfunction} 372@item :set @var{setfunction}
373Specify @var{setfunction} as the way to change the value of this 373Specify @var{setfunction} as the way to change the value of this
374option when using the Customize interface. The function 374option when using the Customize interface. The function
375@var{setfunction} should take two arguments, a symbol (the option 375@var{setfunction} should take two or three arguments, a symbol (the option
376name) and the new value, and should do whatever is necessary to update 376name), the new value, and an optional @var{buffer-local} indicator.
377@var{setfunction} should do whatever is necessary to update
377the value properly for this option (which may not mean simply setting 378the value properly for this option (which may not mean simply setting
378the option as a Lisp variable); preferably, though, it should not 379the option as a Lisp variable); preferably, though, it should not
379modify its value argument destructively. The default for 380modify its value argument destructively. If optional @var{buffer-local}
380@var{setfunction} is @code{set-default-toplevel-value}. 381is non-nil, the new value should be set buffer locally and not affect its
382global or default values. The default for @var{setfunction} is
383@code{set-default-toplevel-value}.
381 384
382If defined, @var{setfunction} will also be called when evaluating a 385If defined, @var{setfunction} will also be called when evaluating a
383@code{defcustom} form with @kbd{C-M-x} in Emacs Lisp mode and when the 386@code{defcustom} form with @kbd{C-M-x} in Emacs Lisp mode and when the
@@ -387,7 +390,7 @@ If defined, @var{setfunction} will also be called when evaluating a
387If you specify this keyword, the variable's documentation string 390If you specify this keyword, the variable's documentation string
388should describe how to do the same job in hand-written Lisp code, 391should describe how to do the same job in hand-written Lisp code,
389either by invoking @var{setfunction} directly or by using 392either by invoking @var{setfunction} directly or by using
390@code{setopt}. 393@code{setopt} or @code{setopt-local}.
391 394
392@kindex get@r{, @code{defcustom} keyword} 395@kindex get@r{, @code{defcustom} keyword}
393@item :get @var{getfunction} 396@item :get @var{getfunction}