Function: make-obsolete

make-obsolete is a byte-compiled function defined in byte-run.el.gz.

Signature

(make-obsolete OBSOLETE-NAME CURRENT-NAME WHEN)

Documentation

Make the byte-compiler warn that function OBSOLETE-NAME is obsolete.

OBSOLETE-NAME should be a function name or macro name (a symbol).

The warning will say that CURRENT-NAME should be used instead. If CURRENT-NAME is a string, that is the use instead message
(it should end with a period, and not start with a capital).
WHEN should be a string indicating when the function was first made obsolete, for example a date or a release number.

View in manual

Probably introduced at or before Emacs version 21.1.

Aliases

erc-make-obsolete (obsolete since 28.1)

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/byte-run.el.gz
(defun make-obsolete (obsolete-name current-name when)
  "Make the byte-compiler warn that function OBSOLETE-NAME is obsolete.
OBSOLETE-NAME should be a function name or macro name (a symbol).

The warning will say that CURRENT-NAME should be used instead.
If CURRENT-NAME is a string, that is the `use instead' message
\(it should end with a period, and not start with a capital).
WHEN should be a string indicating when the function
was first made obsolete, for example a date or a release number."
  (byte-run--constant-obsolete-warning obsolete-name)
  (put obsolete-name 'byte-obsolete-info
       ;; The second entry used to hold the `byte-compile' handler, but
       ;; is not used any more nowadays.
       (list current-name nil when))
  obsolete-name)