changeset 46391:5d5a55d8897b

Document third argument of defvaralias.

--- a/etc/NEWS	Mon Jul 15 15:39:02 2002 +0000
+++ b/etc/NEWS	Mon Jul 15 15:50:20 2002 +0000
@@ -1517,13 +1517,16 @@
 
 ** Variable aliases have been implemented:
 
-- Macro: defvaralias ALIAS-VAR BASE-VAR
+- Macro: defvaralias ALIAS-VAR BASE-VAR [DOCSTRING]
 
 This defines the symbol ALIAS-VAR as a variable alias for symbol
 BASE-VAR.  This means that retrieving the value of ALIAS-VAR returns
 the value of BASE-VAR, and changing the value of ALIAS-VAR changes the
 value of BASE-VAR.
 
+DOCSTRING, if present, is the documentation for ALIAS-VAR; else it has
+the same documentation as BASE-VAR.
+
 - Function: indirect-variable VARIABLE
 
 This function returns the variable at the end of the chain of aliases

--- a/lispref/variables.texi	Mon Jul 15 15:39:02 2002 +0000
+++ b/lispref/variables.texi	Mon Jul 15 15:50:20 2002 +0000
@@ -1676,11 +1676,15 @@
 to keep the old name as an @emph{alias} of the new one for
 compatibility.  You can do this with @code{defvaralias}.
 
-@defmac defvaralias alias-var base-var
+@defmac defvaralias alias-var base-var [docstring]
 This function defines the symbol @var{alias-var} as a variable alias
-for symbol @var{base-var}.  This means that retrieving the value of
+for symbol @var{base-var}. This means that retrieving the value of
 @var{alias-var} returns the value of @var{base-var}, and changing the
 value of @var{alias-var} changes the value of @var{base-var}.
+
+If the @var{docstring} argument is present, it specifies the documentation for
+@var{alias-var}; otherwise, it has the same documentation that @var{base-var},
+if any.
 @end defmac
 
 @defun indirect-variable variable