procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Describe WHEN in all the define-obsolete- macros

Browse source 
* lisp/emacs-lisp/byte-run.el (define-obsolete-face-alias):
Say more verbosely what WHEN is (bug#21225).
(define-obsolete-function-alias): Describe the WHEN parameter.
(define-obsolete-variable-alias): Ditto.

(cherry picked from commit 247c388f16)
This commit is contained in:
Lars Ingebrigtsen 2016-04-30 23:52:19 +02:00
parent 6b39501612
commit 25b4cf33dd
1 changed files with 8 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -362,6 +362,9 @@ is equivalent to the following two lines of code:
\(defalias \\='old-fun \\='new-fun \"old-fun's doc.\")
\(make-obsolete \\='old-fun \\='new-fun \"22.1\")
If provided, WHEN should be a string indicating when the function
was first made obsolete, for example a date or a release number.
See the docstrings of `defalias' and `make-obsolete' for more details."
(declare (doc-string 4)
(advertised-calling-convention
@ -404,6 +407,9 @@ dumped with Emacs). This is so that any user customizations are
applied before the defcustom tries to initialize the
variable (this is due to the way `defvaralias' works).
If provided, WHEN should be a string indicating when the function
was first made obsolete, for example a date or a release number.
For the benefit of `custom-set-variables', if OBSOLETE-NAME has
any of the following properties, they are copied to
CURRENT-NAME, if it does not already have them:
@ -428,8 +434,8 @@ CURRENT-NAME, if it does not already have them:
;; It only really affects M-x describe-face output.
(defmacro define-obsolete-face-alias (obsolete-face current-face when)
"Make OBSOLETE-FACE a face alias for CURRENT-FACE and mark it obsolete.
The string WHEN gives the Emacs version where OBSOLETE-FACE became
obsolete."
If provided, WHEN should be a string indicating when the function
was first made obsolete, for example a date or a release number."
`(progn
(put ,obsolete-face 'face-alias ,current-face)
;; Used by M-x describe-face.