[Emacs-diffs] Changes to emacs/lispref/variables.texi

[Richard M . Stallman]

Index: emacs/lispref/variables.texi
diff -c emacs/lispref/variables.texi:1.54 emacs/lispref/variables.texi:1.55
*** emacs/lispref/variables.texi:1.54   Fri Apr 22 04:07:29 2005
--- emacs/lispref/variables.texi        Tue Apr 26 10:55:24 2005
***************
*** 1714,1744 ****
  This function returns @var{base-var}.
  @end defun
  
! Variables aliases are often used prior to replacing an old name for a variable
! with a new name. To allow some time for existing code to adapt to this change,
! @code{make-obsolete-variable} declares that the old name is obsolete and
! therefore that it may be removed at some stage in the future.
  
  @defmac make-obsolete-variable variable new &optional when
! This macro makes the byte-compiler warn that symbol @var{variable} is
! obsolete and that symbol @var{new} should be used instead.  If
! @var{new} is a string, this is the message and there is no replacement
! variable.  If it is provided, @var{when} should be a string indicating
! when the variable was first made obsolete, for example a date or a
! release number.
  @end defmac
  
  You can make two variables synonyms and declare one obsolete at the
  same time using the macro @code{define-obsolete-variable-alias}.
  
  @defmac define-obsolete-variable-alias variable new &optional when docstring
! This macro defines the symbol @var{variable} as a variable alias for
! symbol @var{new} and warns that @var{variable} is obsolete.  If it is
! 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.
  @end defmac
  
  @defun indirect-variable variable
--- 1714,1750 ----
  This function returns @var{base-var}.
  @end defun
  
! Variable aliases are convenient for replacing an old name for a
! variable with a new name.  @code{make-obsolete-variable} declares that
! the old name is obsolete and therefore that it may be removed at some
! stage in the future.
  
  @defmac make-obsolete-variable variable new &optional when
! This macro makes the byte-compiler warn that the variable
! @var{variable} is obsolete.  If @var{new} is a symbol, it is the
! variable's new name; the warning messages say to use @var{new}
! instead of @var{variable}.
! If @var{new} is a string, this is the message and there is no
! replacement variable.
! 
! If provided, @var{when} should be a string indicating when the
! variable was first made obsolete---for example, a date or a release
! number.
  @end defmac
  
  You can make two variables synonyms and declare one obsolete at the
  same time using the macro @code{define-obsolete-variable-alias}.
  
  @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}.
! 
! 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.
  @end defmac
  
  @defun indirect-variable variable