emacs/gnu.emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2026-09-10 07:46:51 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

; Further explain WHEN argument to marking functions obsolete.

Browse source
This commit is contained in:
Sean Whitton 2026-08-31 10:04:04 +01:00
parent c4d50ea097
commit e420d0d978
1 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
lisp/emacs-lisp/byte-run.el
View file

@ -561,7 +561,13 @@ 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."
was first made obsolete, for example a date or a release number.
If OBSOLETE-NAME is a command, and WHEN is a release number, then it
also determines whether Emacs offers the command as a completion
candidate in `execute-extended-command' and similar commands: Emacs
includes only obsolete commands that were first obsoleted in the running
version of Emacs."
(byte-run--constant-obsolete-warning obsolete-name)
(put obsolete-name 'byte-obsolete-info
;; The second entry used to hold the `byte-compile' handler, but
@ -581,8 +587,13 @@ is equivalent to the following two lines of code:
\(defalias \\='old-fun \\='new-fun \"old-fun's doc.\")
\(make-obsolete \\='old-fun \\='new-fun \"28.1\")
WHEN should be a string indicating when the function was first
made obsolete, for example a date or a release number.
WHEN should be a string indicating when the function was first made
obsolete, for example a date or a release number.
If OBSOLETE-NAME is a command, and WHEN is a release number, then it
also determines whether Emacs offers the command as a completion
candidate in `execute-extended-command' and similar commands: Emacs
includes only obsolete commands that were first obsoleted in the running
version of Emacs.
See the docstrings of `defalias' and `make-obsolete' for more details."
(declare (doc-string 4) (indent defun))