emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: obsolete comment in tool-bar.el


From: Luc Teirlinck
Subject: Re: obsolete comment in tool-bar.el
Date: Sun, 10 Jul 2005 22:21:42 -0500 (CDT)

This concerns the documentation for the two new :initialize functions.
They are kind of internal and hence I believe that maybe they do not
need to be mentioned in the already very long NEWS.  On the other
hand, maybe it might be useful to mention them in the Elisp manual,
for instance because people experimenting with changing the defcustoms
in question need to be aware of their subtleties.

The patch below documents them.  The small unrelated change in the
patch appears necessary regardless.

===File ~/customize.texi-diff===============================
*** customize.texi      18 Jun 2005 08:44:38 -0500      1.45
--- customize.texi      10 Jul 2005 21:52:01 -0500      
***************
*** 270,275 ****
--- 270,290 ----
  Use the @code{:set} function to initialize the variable, if it is
  already set or has been customized; otherwise, just use
  @code{set-default}.
+ 
+ @item custom-initialize-safe-set
+ @itemx custom-initialize-safe-default
+ These functions behave like @code{custom-initialize-set}
+ (@code{custom-initialize-default}, respectively), but catch errors.
+ If an error occurs during initialization, they set the variable to
+ @code{nil} using @code{set-default}, and throw no error.
+ 
+ These two functions are only meant for options defined in pre-loaded
+ files, where some variables or functions used to compute the option's
+ value may not yet be defined.  The option normally gets updated in
+ @file{startup.el}, ignoring the previously computed value.  Because of
+ this typical usage, the value which these two functions compute
+ normally only matters when, after startup, one unsets the option's
+ value and then reevaluates the defcustom.
  @end table
  
  @item :set-after @var{variables}
***************
*** 318,325 ****
  Internally, @code{defcustom} uses the symbol property
  @code{standard-value} to record the expression for the default value,
  and @code{saved-value} to record the value saved by the user with the
! customization buffer.  The @code{saved-value} property is actually a
! list whose car is an expression which evaluates to the value.
  
  @node Customization Types
  @section Customization Types
--- 333,340 ----
  Internally, @code{defcustom} uses the symbol property
  @code{standard-value} to record the expression for the default value,
  and @code{saved-value} to record the value saved by the user with the
! customization buffer.  Both properties are actually lists whose car is
! an expression which evaluates to the value.
  
  @node Customization Types
  @section Customization Types
============================================================




reply via email to

[Prev in Thread] Current Thread [Next in Thread]