]> git.eshelyaron.com Git - emacs.git/commitdiff
(define-obsolete-function-alias): New macro.
authorNick Roberts <nickrob@snap.net.nz>
Tue, 26 Apr 2005 09:03:56 +0000 (09:03 +0000)
committerNick Roberts <nickrob@snap.net.nz>
Tue, 26 Apr 2005 09:03:56 +0000 (09:03 +0000)
lisp/emacs-lisp/byte-run.el

index ab7259b667f7cedc8a9494f4949d2fade0f6f070..5c92f247a0527a98819cb6dba0ffd1181e36360f 100644 (file)
@@ -114,6 +114,18 @@ was first made obsolete, for example a date or a release number."
     (put function 'byte-obsolete-info (list new handler when)))
   function)
 
+(defmacro define-obsolete-function-alias (function new
+                                                  &optional when docstring)
+  "Set FUNCTION's function definition to NEW and warn that FUNCTION is obsolete.
+If provided, WHEN should be a string indicating when FUNCTION was
+first made obsolete, for example a date or a release number.  The
+optional argument DOCSTRING specifies the documentation string
+for FUNCTION; if DOCSTRING is omitted or nil, FUNCTION uses the
+documentation string of NEW unluess it already has one."
+  `(progn
+     (defalias ,function ,new ,docstring)
+     (make-obsolete ,function ,new ,when)))
+
 (defun make-obsolete-variable (variable new &optional when)
   "Make the byte-compiler warn that VARIABLE is obsolete.
 The warning will say that NEW should be used instead.