mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-04 11:00:45 -08:00
Code Issues Projects Releases Wiki Activity

Tweak the documentation for define-obsolete-variable-alias

Browse source 
* doc/lispref/variables.texi (Variable Aliases): Actually describe
the macro parameters (bug#44088).

* lisp/emacs-lisp/byte-run.el (define-obsolete-variable-alias):
Ditto (bug#44088).
This commit is contained in:
Lars Ingebrigtsen 2020-10-20 13:28:29 +02:00
parent e3fa592899
commit 4ef8c4a0f4
2 changed files with 18 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/lispref/variables.texi
View file

@ -2385,6 +2385,14 @@ equivalent to the following:
(defvaralias @var{obsolete-name} @var{current-name} @var{docstring}) (defvaralias @var{obsolete-name} @var{current-name} @var{docstring})
(make-obsolete-variable @var{obsolete-name} @var{current-name} @var{when}) (make-obsolete-variable @var{obsolete-name} @var{current-name} @var{when})
@end example @end example
This macro evaluates all its parameters, and both @var{obsolete-name}
and @var{current-name} should be symbols, so a typical usage would
look like:
@lisp
(define-obsolete-variable-alias 'foo-thing 'bar-thing "27.1")
@end lisp
@end defmac @end defmac
@defun indirect-variable variable @defun indirect-variable variable

14
lisp/emacs-lisp/byte-run.el
View file

@ -432,7 +432,16 @@ ACCESS-TYPE if non-nil should specify the kind of access that will trigger
(defmacro define-obsolete-variable-alias (obsolete-name current-name (defmacro define-obsolete-variable-alias (obsolete-name current-name
&optional when docstring) &optional when docstring)
"Make OBSOLETE-NAME a variable alias for CURRENT-NAME and mark it obsolete. "Make OBSOLETE-NAME a variable alias for CURRENT-NAME and mark it obsolete.
This uses `defvaralias' and `make-obsolete-variable' (which see).
WHEN should be a string indicating when the variable was first
made obsolete, for example a date or a release number.
This macro evaluates all its parameters, and both OBSOLETE-NAME
and CURRENT-NAME should be symbols, so a typical usage would look like:
(define-obsolete-variable-alias 'foo-thing 'bar-thing \"27.1\")
This macro uses `defvaralias' and `make-obsolete-variable' (which see).
See the Info node `(elisp)Variable Aliases' for more details. See the Info node `(elisp)Variable Aliases' for more details.
If CURRENT-NAME is a defcustom or a defvar (more generally, any variable If CURRENT-NAME is a defcustom or a defvar (more generally, any variable
@ -446,9 +455,6 @@ dumped with Emacs). This is so that any user customizations are
applied before the defcustom tries to initialize the applied before the defcustom tries to initialize the
variable (this is due to the way `defvaralias' works). variable (this is due to the way `defvaralias' works).
WHEN should be a string indicating when the variable was first
made obsolete, for example a date or a release number.
For the benefit of Customize, if OBSOLETE-NAME has For the benefit of Customize, if OBSOLETE-NAME has
any of the following properties, they are copied to any of the following properties, they are copied to
CURRENT-NAME, if it does not already have them: CURRENT-NAME, if it does not already have them: