Mercurial > emacs
changeset 62098:bc3a702b646e
(Variable Aliases): Change description of `define-obsolete-variable-alias'.
| author | Luc Teirlinck <teirllm@auburn.edu> |
|---|---|
| date | Thu, 05 May 2005 23:19:02 +0000 |
| parents | fc015141b2e5 |
| children | d1245d218964 |
| files | lispref/variables.texi |
| diffstat | 1 files changed, 12 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/lispref/variables.texi Thu May 05 23:17:20 2005 +0000 +++ b/lispref/variables.texi Thu May 05 23:19:02 2005 +0000 @@ -1736,14 +1736,19 @@ @defmac define-obsolete-variable-alias variable new &optional when docstring This macro marks the variable @var{variable} as obsolete and also -makes it an alias for the variable @var{new}. +makes it an alias for the variable @var{new}. A typical call has the form: + +@example +(define-obsolete-variable-alias 'old-var 'new-var "22.1" "Doc.") +@end example -If provided, @var{when} should be a string indicating when -@var{variable} was first made obsolete. The optional argument -@var{docstring} specifies the documentation string for @var{variable}. -If @var{docstring} is omitted or nil, @var{variable} uses the -documentation string of @var{new} unless it already has one of its -own. +@noindent +which is equivalent to the following two lines of code: + +@example +(defvaralias 'oldvar 'newvar "Doc.") +(make-obsolete-variable 'old-var 'new-var "22.1") +@end example @end defmac @defun indirect-variable variable