summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp/byte-run.el
diff options
context:
space:
mode:
authorKaroly Lorentey <lorentey@elte.hu>2005-05-06 21:06:31 +0000
committerKaroly Lorentey <lorentey@elte.hu>2005-05-06 21:06:31 +0000
commitc25b55138a36cf5f334070baf79ce61c1e956eed (patch)
tree74ec7f847395839fae3acd0179f1a779c5ebc3b9 /lisp/emacs-lisp/byte-run.el
parent97c57fb2b8d271b2beba317c6213ab34190bfac7 (diff)
parent31640842b6cd2970ced612a422fa785d2d718dc0 (diff)
downloademacs-c25b55138a36cf5f334070baf79ce61c1e956eed.tar.gz
emacs-c25b55138a36cf5f334070baf79ce61c1e956eed.tar.bz2
emacs-c25b55138a36cf5f334070baf79ce61c1e956eed.zip
Merged from miles@gnu.org--gnu-2005 (patch 68, 286-291)
Patches applied: * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-286 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-287 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-288 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-289 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-290 Update from CVS * miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-291 Merge from gnus--rel--5.10 * miles@gnu.org--gnu-2005/gnus--rel--5.10--patch-68 Update from CVS git-archimport-id: lorentey@elte.hu--2004/emacs--multi-tty--0--patch-341
Diffstat (limited to 'lisp/emacs-lisp/byte-run.el')
-rw-r--r--lisp/emacs-lisp/byte-run.el33
1 files changed, 21 insertions, 12 deletions
diff --git a/lisp/emacs-lisp/byte-run.el b/lisp/emacs-lisp/byte-run.el
index 5c92f247a05..1472d576e49 100644
--- a/lisp/emacs-lisp/byte-run.el
+++ b/lisp/emacs-lisp/byte-run.el
@@ -116,12 +116,16 @@ was first made obsolete, for example a date or a release number."
(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."
+ "Set FUNCTION's function definition to NEW and mark it obsolete.
+
+\(define-obsolete-function-alias 'old-fun 'new-fun \"22.1\" \"old-fun's doc.\")
+
+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\")
+
+See the docstrings of `defalias' and `make-obsolete' for more details."
`(progn
(defalias ,function ,new ,docstring)
(make-obsolete ,function ,new ,when)))
@@ -143,12 +147,17 @@ was first made obsolete, for example a date or a release number."
(defmacro define-obsolete-variable-alias (variable new
&optional when docstring)
- "Make VARIABLE a variable alias for NEW and warn that VARIABLE is obsolete.
-If provided, WHEN should be a string indicating when VARIABLE was
-first made obsolete, for example a date or a release number. The
-optional argument DOCSTRING specifies the documentation string
-for VARIABLE; if DOCSTRING is omitted or nil, VARIABLE uses the
-documentation string of NEW unless it already has one."
+ "Make VARIABLE a variable alias for NEW and mark it obsolete.
+
+\(define-obsolete-variable-alias 'old-var 'new-var \"22.1\" \"old-var's doc.\")
+
+is equivalent to the following two lines of code:
+
+\(defvaralias 'old-var 'new-var \"old-var's doc.\")
+\(make-obsolete-variable 'old-var 'new-var \"22.1\")
+
+See the docstrings of `defvaralias' and `make-obsolete-variable' or
+Info node `(elisp)Variable Aliases' for more details."
`(progn
(defvaralias ,variable ,new ,docstring)
(make-obsolete-variable ,variable ,new ,when)))