aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuanma Barranquero2005-06-15 23:09:44 +0000
committerJuanma Barranquero2005-06-15 23:09:44 +0000
commit1915b9d56ac7b4dc14b02c446f2d8bd4bb8b9900 (patch)
tree79024c0bd6e8cd0a2d4a5914ffd684d813acfb02
parent665ed61ac2142bc0d36d1201146d5512b57701e5 (diff)
downloademacs-1915b9d56ac7b4dc14b02c446f2d8bd4bb8b9900.tar.gz
emacs-1915b9d56ac7b4dc14b02c446f2d8bd4bb8b9900.zip
(Obsolete Functions): Update argument names of `make-obsolete' and
`define-obsolete-function-alias'.
-rw-r--r--lispref/functions.texi20
1 files changed, 11 insertions, 9 deletions
diff --git a/lispref/functions.texi b/lispref/functions.texi
index bcdfc95cc1c..409f0125ad8 100644
--- a/lispref/functions.texi
+++ b/lispref/functions.texi
@@ -1157,13 +1157,14 @@ a function defined by another package, it is cleaner to use
1157You can use @code{make-obsolete} to declare a function obsolete. This 1157You can use @code{make-obsolete} to declare a function obsolete. This
1158indicates that the function may be removed at some stage in the future. 1158indicates that the function may be removed at some stage in the future.
1159 1159
1160@defun make-obsolete function new &optional when 1160@defun make-obsolete obsolete-name current-name &optional when
1161This function makes the byte compiler warn that the function 1161This function makes the byte compiler warn that the function
1162@var{function} is obsolete. If @var{new} is a symbol, the warning 1162@var{obsolete-name} is obsolete. If @var{current-name} is a symbol, the
1163message says to use @var{new} instead of @var{function}. @var{new} 1163warning message says to use @var{current-name} instead of
1164does not need to be an alias for @var{function}; it can be a different 1164@var{obsolete-name}. @var{current-name} does not need to be an alias for
1165function with similar functionality. If @var{new} is a string, it is 1165@var{obsolete-name}; it can be a different function with similar
1166the warning message. 1166functionality. If @var{current-name} is a string, it is the warning
1167message.
1167 1168
1168If provided, @var{when} should be a string indicating when the function 1169If provided, @var{when} should be a string indicating when the function
1169was first made obsolete---for example, a date or a release number. 1170was first made obsolete---for example, a date or a release number.
@@ -1172,9 +1173,10 @@ was first made obsolete---for example, a date or a release number.
1172You can define a function as an alias and declare it obsolete at the 1173You can define a function as an alias and declare it obsolete at the
1173same time using the macro @code{define-obsolete-function-alias}. 1174same time using the macro @code{define-obsolete-function-alias}.
1174 1175
1175@defmac define-obsolete-function-alias function new &optional when docstring 1176@defmac define-obsolete-function-alias obsolete-name current-name &optional when docstring
1176This macro marks the function @var{function} obsolete and also defines 1177This macro marks the function @var{obsolete-name} obsolete and also defines
1177it as an alias for the function @var{new}. A typical call has the form: 1178it as an alias for the function @var{current-name}. A typical call has the
1179form:
1178 1180
1179@example 1181@example
1180(define-obsolete-function-alias 'old-fun 'new-fun "22.1" "Doc.") 1182(define-obsolete-function-alias 'old-fun 'new-fun "22.1" "Doc.")