(Variable Aliases): Clarify that aliases vars always have the same value.

This commit is contained in:
Richard M. Stallman 2007-01-02 20:58:29 +00:00
parent 9e7166c8f4
commit babe03d6a9

View file

@ -1777,9 +1777,11 @@ compatibility. You can do this with @code{defvaralias}.
@defun defvaralias new-alias base-variable &optional docstring
This function defines the symbol @var{new-alias} as a variable alias
for symbol @var{base-variable}. This means that retrieving the value of
@var{new-alias} returns the value of @var{base-variable}, and changing the
value of @var{new-alias} changes the value of @var{base-variable}.
for symbol @var{base-variable}. This means that retrieving the value
of @var{new-alias} returns the value of @var{base-variable}, and
changing the value of @var{new-alias} changes the value of
@var{base-variable}. The two aliased variable names always share the
same value and the same bindings.
If the @var{docstring} argument is non-@code{nil}, it specifies the
documentation for @var{new-alias}; otherwise, the alias gets the same