1157 |
You can use @code{make-obsolete} to declare a function obsolete. This |
You can use @code{make-obsolete} to declare a function obsolete. This |
1158 |
indicates that the function may be removed at some stage in the future. |
indicates that the function may be removed at some stage in the future. |
1159 |
|
|
1160 |
@defun make-obsolete function new &optional when |
@defun make-obsolete obsolete-name current-name &optional when |
1161 |
This function makes the byte compiler warn that the function |
This function makes the byte compiler warn that the function |
1162 |
@var{function} is obsolete. If @var{new} is a symbol, the warning |
@var{obsolete-name} is obsolete. If @var{current-name} is a symbol, the |
1163 |
message says to use @var{new} instead of @var{function}. @var{new} |
warning message says to use @var{current-name} instead of |
1164 |
does not need to be an alias for @var{function}; it can be a different |
@var{obsolete-name}. @var{current-name} does not need to be an alias for |
1165 |
function with similar functionality. If @var{new} is a string, it is |
@var{obsolete-name}; it can be a different function with similar |
1166 |
the warning message. |
functionality. If @var{current-name} is a string, it is the warning |
1167 |
|
message. |
1168 |
|
|
1169 |
If provided, @var{when} should be a string indicating when the function |
If provided, @var{when} should be a string indicating when the function |
1170 |
was first made obsolete---for example, a date or a release number. |
was first made obsolete---for example, a date or a release number. |
1173 |
You can define a function as an alias and declare it obsolete at the |
You can define a function as an alias and declare it obsolete at the |
1174 |
same time using the macro @code{define-obsolete-function-alias}. |
same time using the macro @code{define-obsolete-function-alias}. |
1175 |
|
|
1176 |
@defmac define-obsolete-function-alias function new &optional when docstring |
@defmac define-obsolete-function-alias obsolete-name current-name &optional when docstring |
1177 |
This macro marks the function @var{function} obsolete and also defines |
This macro marks the function @var{obsolete-name} obsolete and also defines |
1178 |
it as an alias for the function @var{new}. A typical call has the form: |
it as an alias for the function @var{current-name}. A typical call has the |
1179 |
|
form: |
1180 |
|
|
1181 |
@example |
@example |
1182 |
(define-obsolete-function-alias 'old-fun 'new-fun "22.1" "Doc.") |
(define-obsolete-function-alias 'old-fun 'new-fun "22.1" "Doc.") |