Mercurial > emacs
changeset 94023:1841ac94b011
(define-obsolete-variable-alias): Doc fix.
| author | Glenn Morris <rgm@gnu.org> |
|---|---|
| date | Sat, 12 Apr 2008 03:13:27 +0000 |
| parents | 0f09322aedec |
| children | 9addbbd02f71 |
| files | lisp/emacs-lisp/byte-run.el |
| diffstat | 1 files changed, 9 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/emacs-lisp/byte-run.el Sat Apr 12 03:12:29 2008 +0000 +++ b/lisp/emacs-lisp/byte-run.el Sat Apr 12 03:13:27 2008 +0000 @@ -161,6 +161,15 @@ \(defvaralias 'old-var 'new-var \"old-var's doc.\") \(make-obsolete-variable 'old-var 'new-var \"22.1\") +If CURRENT-NAME is a defcustom (more generally, any variable +where OBSOLETE-NAME may be set, e.g. in a .emacs file, before the +alias is defined), then the define-obsolete-variable-alias +statement should be placed before the defcustom. This is so that +any user customizations are applied before the defcustom tries to +initialize the variable (this is due to the way `defvaralias' works). +Exceptions to this rule occur for define-obsolete-variable-alias +statements that are autoloaded, or in files dumped with Emacs. + See the docstrings of `defvaralias' and `make-obsolete-variable' or Info node `(elisp)Variable Aliases' for more details." (declare (doc-string 4))