diff options
| author | Lars Ingebrigtsen <larsi@gnus.org> | 2020-10-20 13:28:29 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen <larsi@gnus.org> | 2020-10-20 13:28:29 +0200 |
| commit | 4ef8c4a0f4e26f6ea2186a2b80c068b8d93e4993 (patch) | |
| tree | 53c4d79934bb5fce1dd92b01e995286442a78f46 /doc | |
| parent | e3fa592899f6999fda9fdaaab3929f346ce67f66 (diff) | |
| download | emacs-4ef8c4a0f4e26f6ea2186a2b80c068b8d93e4993.tar.gz | |
Tweak the documentation for define-obsolete-variable-alias
* 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).
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/variables.texi | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi index 6c0b3b5be1b..394fb96acbe 100644 --- a/doc/lispref/variables.texi +++ b/doc/lispref/variables.texi @@ -2385,6 +2385,14 @@ equivalent to the following: (defvaralias @var{obsolete-name} @var{current-name} @var{docstring}) (make-obsolete-variable @var{obsolete-name} @var{current-name} @var{when}) @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 @defun indirect-variable variable |