]> code.delx.au - gnu-emacs/commitdiff
Document third argument of defvaralias.
authorJuanma Barranquero <lekktu@gmail.com>
Mon, 15 Jul 2002 15:50:20 +0000 (15:50 +0000)
committerJuanma Barranquero <lekktu@gmail.com>
Mon, 15 Jul 2002 15:50:20 +0000 (15:50 +0000)
etc/NEWS
lispref/variables.texi

index bd29f3e3b48f863abe42e9ebf123b4fb025860e1..b6babdcf61f2352e0c71aa43effedd98cfe2e3fd 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1517,13 +1517,16 @@ searching for an executable resp. an elisp file.
 
 ** 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
index d7a5929bcfb5657afa71996544ef2aa51e3df566..197390e0b7d889ba8769eef2005e24b8e08e1ba2 100644 (file)
@@ -1676,11 +1676,15 @@ chosen, or because its meaning has partly changed---it can be useful
 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