Mercurial > emacs
comparison lispref/variables.texi @ 46391:5d5a55d8897b
Document third argument of defvaralias.
author | Juanma Barranquero <lekktu@gmail.com> |
---|---|
date | Mon, 15 Jul 2002 15:50:20 +0000 |
parents | 51bf5310b422 |
children | d4d29178fccb |
comparison
equal
deleted
inserted
replaced
46390:4fbc342b5337 | 46391:5d5a55d8897b |
---|---|
1674 variable---either because you realize its old name was not well | 1674 variable---either because you realize its old name was not well |
1675 chosen, or because its meaning has partly changed---it can be useful | 1675 chosen, or because its meaning has partly changed---it can be useful |
1676 to keep the old name as an @emph{alias} of the new one for | 1676 to keep the old name as an @emph{alias} of the new one for |
1677 compatibility. You can do this with @code{defvaralias}. | 1677 compatibility. You can do this with @code{defvaralias}. |
1678 | 1678 |
1679 @defmac defvaralias alias-var base-var | 1679 @defmac defvaralias alias-var base-var [docstring] |
1680 This function defines the symbol @var{alias-var} as a variable alias | 1680 This function defines the symbol @var{alias-var} as a variable alias |
1681 for symbol @var{base-var}. This means that retrieving the value of | 1681 for symbol @var{base-var}. This means that retrieving the value of |
1682 @var{alias-var} returns the value of @var{base-var}, and changing the | 1682 @var{alias-var} returns the value of @var{base-var}, and changing the |
1683 value of @var{alias-var} changes the value of @var{base-var}. | 1683 value of @var{alias-var} changes the value of @var{base-var}. |
1684 | |
1685 If the @var{docstring} argument is present, it specifies the documentation for | |
1686 @var{alias-var}; otherwise, it has the same documentation that @var{base-var}, | |
1687 if any. | |
1684 @end defmac | 1688 @end defmac |
1685 | 1689 |
1686 @defun indirect-variable variable | 1690 @defun indirect-variable variable |
1687 This function returns the variable at the end of the chain of aliases | 1691 This function returns the variable at the end of the chain of aliases |
1688 of @var{variable}. If @var{variable} is not a symbol, or if @var{variable} is | 1692 of @var{variable}. If @var{variable} is not a symbol, or if @var{variable} is |