aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--lisp/emacs-lisp/byte-run.el9
1 files changed, 9 insertions, 0 deletions
diff --git a/lisp/emacs-lisp/byte-run.el b/lisp/emacs-lisp/byte-run.el
index 855111b9f9b..06b28beab7e 100644
--- a/lisp/emacs-lisp/byte-run.el
+++ b/lisp/emacs-lisp/byte-run.el
@@ -161,6 +161,15 @@ is equivalent to the following two lines of code:
161\(defvaralias 'old-var 'new-var \"old-var's doc.\") 161\(defvaralias 'old-var 'new-var \"old-var's doc.\")
162\(make-obsolete-variable 'old-var 'new-var \"22.1\") 162\(make-obsolete-variable 'old-var 'new-var \"22.1\")
163 163
164If CURRENT-NAME is a defcustom (more generally, any variable
165where OBSOLETE-NAME may be set, e.g. in a .emacs file, before the
166alias is defined), then the define-obsolete-variable-alias
167statement should be placed before the defcustom. This is so that
168any user customizations are applied before the defcustom tries to
169initialize the variable (this is due to the way `defvaralias' works).
170Exceptions to this rule occur for define-obsolete-variable-alias
171statements that are autoloaded, or in files dumped with Emacs.
172
164See the docstrings of `defvaralias' and `make-obsolete-variable' or 173See the docstrings of `defvaralias' and `make-obsolete-variable' or
165Info node `(elisp)Variable Aliases' for more details." 174Info node `(elisp)Variable Aliases' for more details."
166 (declare (doc-string 4)) 175 (declare (doc-string 4))