/[emacs]/emacs/lispref/variables.texi
ViewVC logotype

Diff of /emacs/lispref/variables.texi

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.54 by nickrob, Fri Apr 22 04:07:29 2005 UTC revision 1.55 by rms, Tue Apr 26 10:55:24 2005 UTC
# Line 1714  of the variable at the end of the chain Line 1714  of the variable at the end of the chain
1714  This function returns @var{base-var}.  This function returns @var{base-var}.
1715  @end defun  @end defun
1716    
1717  Variables aliases are often used prior to replacing an old name for a variable  Variable aliases are convenient for replacing an old name for a
1718  with a new name. To allow some time for existing code to adapt to this change,  variable with a new name.  @code{make-obsolete-variable} declares that
1719  @code{make-obsolete-variable} declares that the old name is obsolete and  the old name is obsolete and therefore that it may be removed at some
1720  therefore that it may be removed at some stage in the future.  stage in the future.
1721    
1722  @defmac make-obsolete-variable variable new &optional when  @defmac make-obsolete-variable variable new &optional when
1723  This macro makes the byte-compiler warn that symbol @var{variable} is  This macro makes the byte-compiler warn that the variable
1724  obsolete and that symbol @var{new} should be used instead.  If  @var{variable} is obsolete.  If @var{new} is a symbol, it is the
1725  @var{new} is a string, this is the message and there is no replacement  variable's new name; the warning messages say to use @var{new}
1726  variable.  If it is provided, @var{when} should be a string indicating  instead of @var{variable}.
1727  when the variable was first made obsolete, for example a date or a  If @var{new} is a string, this is the message and there is no
1728  release number.  replacement variable.
1729    
1730    If provided, @var{when} should be a string indicating when the
1731    variable was first made obsolete---for example, a date or a release
1732    number.
1733  @end defmac  @end defmac
1734    
1735  You can make two variables synonyms and declare one obsolete at the  You can make two variables synonyms and declare one obsolete at the
1736  same time using the macro @code{define-obsolete-variable-alias}.  same time using the macro @code{define-obsolete-variable-alias}.
1737    
1738  @defmac define-obsolete-variable-alias variable new &optional when docstring  @defmac define-obsolete-variable-alias variable new &optional when docstring
1739  This macro defines the symbol @var{variable} as a variable alias for  This macro marks the variable @var{variable} as obsolete and also
1740  symbol @var{new} and warns that @var{variable} is obsolete.  If it is  makes it an alias for the variable @var{new}.
1741  provided, @var{when} should be a string indicating when @var{variable}  
1742  was first made obsolete.  The optional argument @var{docstring}  If provided, @var{when} should be a string indicating when
1743  specifies the documentation string for @var{variable}.  If  @var{variable} was first made obsolete.  The optional argument
1744  @var{docstring} is omitted or nil, @var{variable} uses the  @var{docstring} specifies the documentation string for @var{variable}.
1745  documentation string of @var{new} unless it already has one.  If @var{docstring} is omitted or nil, @var{variable} uses the
1746    documentation string of @var{new} unless it already has one of its
1747    own.
1748  @end defmac  @end defmac
1749    
1750  @defun indirect-variable variable  @defun indirect-variable variable

Legend:
Removed from v.1.54  
changed lines
  Added in v.1.55

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26