diff options
| author | Juanma Barranquero | 2005-06-15 23:11:14 +0000 |
|---|---|---|
| committer | Juanma Barranquero | 2005-06-15 23:11:14 +0000 |
| commit | 51cd2a8c642a6ade362424bc123f46f5cf6fe338 (patch) | |
| tree | d6b9999eb742f1912228d6b9cf83cb0d2b1fe330 | |
| parent | 1915b9d56ac7b4dc14b02c446f2d8bd4bb8b9900 (diff) | |
| download | emacs-51cd2a8c642a6ade362424bc123f46f5cf6fe338.tar.gz emacs-51cd2a8c642a6ade362424bc123f46f5cf6fe338.zip | |
(Variable Aliases): Update argument names of `defvaralias',
`make-obsolete-variable' and `define-obsolete-variable-alias'.
| -rw-r--r-- | lispref/ChangeLog | 9 | ||||
| -rw-r--r-- | lispref/variables.texi | 37 |
2 files changed, 28 insertions, 18 deletions
diff --git a/lispref/ChangeLog b/lispref/ChangeLog index d1df2e17667..112d6e81ae5 100644 --- a/lispref/ChangeLog +++ b/lispref/ChangeLog | |||
| @@ -1,3 +1,12 @@ | |||
| 1 | 2005-06-16 Juanma Barranquero <lekktu@gmail.com> | ||
| 2 | |||
| 3 | * functions.texi (Obsolete Functions): Update argument names of | ||
| 4 | `make-obsolete' and `define-obsolete-function-alias'. | ||
| 5 | |||
| 6 | * variables.texi (Variable Aliases): Update argument names of | ||
| 7 | `defvaralias', `make-obsolete-variable' and | ||
| 8 | `define-obsolete-variable-alias'. | ||
| 9 | |||
| 1 | 2005-06-15 Kim F. Storm <storm@cua.dk> | 10 | 2005-06-15 Kim F. Storm <storm@cua.dk> |
| 2 | 11 | ||
| 3 | * searching.texi (Entire Match Data): Rephrase warnings about | 12 | * searching.texi (Entire Match Data): Rephrase warnings about |
diff --git a/lispref/variables.texi b/lispref/variables.texi index 27f0f4a7029..0f546af67b9 100644 --- a/lispref/variables.texi +++ b/lispref/variables.texi | |||
| @@ -1785,19 +1785,19 @@ chosen, or because its meaning has partly changed---it can be useful | |||
| 1785 | to keep the old name as an @emph{alias} of the new one for | 1785 | to keep the old name as an @emph{alias} of the new one for |
| 1786 | compatibility. You can do this with @code{defvaralias}. | 1786 | compatibility. You can do this with @code{defvaralias}. |
| 1787 | 1787 | ||
| 1788 | @defun defvaralias alias-var base-var &optional docstring | 1788 | @defun defvaralias new-alias base-variable &optional docstring |
| 1789 | This function defines the symbol @var{alias-var} as a variable alias | 1789 | This function defines the symbol @var{new-alias} as a variable alias |
| 1790 | for symbol @var{base-var}. This means that retrieving the value of | 1790 | for symbol @var{base-variable}. This means that retrieving the value of |
| 1791 | @var{alias-var} returns the value of @var{base-var}, and changing the | 1791 | @var{new-alias} returns the value of @var{base-variable}, and changing the |
| 1792 | value of @var{alias-var} changes the value of @var{base-var}. | 1792 | value of @var{new-alias} changes the value of @var{base-variable}. |
| 1793 | 1793 | ||
| 1794 | If the @var{docstring} argument is non-@code{nil}, it specifies the | 1794 | If the @var{docstring} argument is non-@code{nil}, it specifies the |
| 1795 | documentation for @var{alias-var}; otherwise, the alias gets the same | 1795 | documentation for @var{new-alias}; otherwise, the alias gets the same |
| 1796 | documentation as @var{base-var} has, if any, unless @var{base-var} is | 1796 | documentation as @var{base-variable} has, if any, unless |
| 1797 | itself an alias, in which case @var{alias-var} gets the documentation | 1797 | @var{base-variable} is itself an alias, in which case @var{new-alias} gets |
| 1798 | of the variable at the end of the chain of aliases. | 1798 | the documentation of the variable at the end of the chain of aliases. |
| 1799 | 1799 | ||
| 1800 | This function returns @var{base-var}. | 1800 | This function returns @var{base-variable}. |
| 1801 | @end defun | 1801 | @end defun |
| 1802 | 1802 | ||
| 1803 | Variable aliases are convenient for replacing an old name for a | 1803 | Variable aliases are convenient for replacing an old name for a |
| @@ -1805,12 +1805,12 @@ variable with a new name. @code{make-obsolete-variable} declares that | |||
| 1805 | the old name is obsolete and therefore that it may be removed at some | 1805 | the old name is obsolete and therefore that it may be removed at some |
| 1806 | stage in the future. | 1806 | stage in the future. |
| 1807 | 1807 | ||
| 1808 | @defun make-obsolete-variable variable new &optional when | 1808 | @defun make-obsolete-variable obsolete-name current-name &optional when |
| 1809 | This function makes the byte-compiler warn that the variable | 1809 | This function makes the byte-compiler warn that the variable |
| 1810 | @var{variable} is obsolete. If @var{new} is a symbol, it is the | 1810 | @var{obsolete-name} is obsolete. If @var{current-name} is a symbol, it is |
| 1811 | variable's new name; then the warning message says to use @var{new} | 1811 | the variable's new name; then the warning message says to use |
| 1812 | instead of @var{variable}. If @var{new} is a string, this is the | 1812 | @var{current-name} instead of @var{obsolete-name}. If @var{current-name} |
| 1813 | message and there is no replacement variable. | 1813 | is a string, this is the message and there is no replacement variable. |
| 1814 | 1814 | ||
| 1815 | If provided, @var{when} should be a string indicating when the | 1815 | If provided, @var{when} should be a string indicating when the |
| 1816 | variable was first made obsolete---for example, a date or a release | 1816 | variable was first made obsolete---for example, a date or a release |
| @@ -1820,9 +1820,10 @@ number. | |||
| 1820 | You can make two variables synonyms and declare one obsolete at the | 1820 | You can make two variables synonyms and declare one obsolete at the |
| 1821 | same time using the macro @code{define-obsolete-variable-alias}. | 1821 | same time using the macro @code{define-obsolete-variable-alias}. |
| 1822 | 1822 | ||
| 1823 | @defmac define-obsolete-variable-alias variable new &optional when docstring | 1823 | @defmac define-obsolete-variable-alias obsolete-name current-name &optional when docstring |
| 1824 | This macro marks the variable @var{variable} as obsolete and also | 1824 | This macro marks the variable @var{obsolete-name} as obsolete and also |
| 1825 | makes it an alias for the variable @var{new}. A typical call has the form: | 1825 | makes it an alias for the variable @var{current-name}. A typical call has |
| 1826 | the form: | ||
| 1826 | 1827 | ||
| 1827 | @example | 1828 | @example |
| 1828 | (define-obsolete-variable-alias 'old-var 'new-var "22.1" "Doc.") | 1829 | (define-obsolete-variable-alias 'old-var 'new-var "22.1" "Doc.") |