Function: make-obsolete-variable

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

Signature

(make-obsolete-variable OBSOLETE-NAME CURRENT-NAME WHEN &optional ACCESS-TYPE)

Documentation

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

The warning will say that CURRENT-NAME should be used instead. If CURRENT-NAME is a string, that is the use instead message. WHEN should be a string indicating when the variable was first made obsolete, for example a date or a release number. ACCESS-TYPE if non-nil should specify the kind of access that will trigger
  obsolescence warnings; it can be either get or set.

View in manual

Probably introduced at or before Emacs version 22.1.

Aliases

mh-make-obsolete-variable (obsolete since 29.1) erc-make-obsolete-variable (obsolete since 28.1)

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/byte-run.el.gz
(defun make-obsolete-variable ( obsolete-name current-name when
                                &optional access-type)
  "Make the byte-compiler warn that OBSOLETE-NAME is obsolete.
The warning will say that CURRENT-NAME should be used instead.
If CURRENT-NAME is a string, that is the `use instead' message.
WHEN should be a string indicating when the variable
was first made obsolete, for example a date or a release number.
ACCESS-TYPE if non-nil should specify the kind of access that will trigger
  obsolescence warnings; it can be either `get' or `set'."
  (byte-run--constant-obsolete-warning obsolete-name)
  (put obsolete-name 'byte-obsolete-variable
       (purecopy (list current-name access-type when)))
  obsolete-name)