From: Chong Yidong <cyd@gnu.org>
Date: Sat, 28 Jan 2012 05:02:02 +0000 (+0800)
Subject: Mark tooltip-use-echo-area as obsolete.
X-Git-Tag: emacs-pretest-24.0.93~31
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=f823b8caacfc66957b5936fae989bd609d557a47;p=emacs.git

Mark tooltip-use-echo-area as obsolete.

* lisp/tooltip.el (tooltip-mode): Doc fix.
(tooltip-use-echo-area): Mark as obsolete.

Fixes: debbugs:6595
---

diff --git a/etc/NEWS b/etc/NEWS
index 4de92e8a394..bbe4ab19c4d 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -436,6 +436,10 @@ been shown in a specific window.
 This is handy for minibuffer-only frames, and is also used for the "mouse-1
 pops up *Messages*" feature, which can now easily be changed.
 
+---
+** `tooltip-use-echo-area' is obsolete.
+Rather than setting this to t, disable Tooltip mode instead.
+
 
 * Editing Changes in Emacs 24.1
 
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index c683f94444b..e94120f566e 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,8 @@
 2012-01-28  Chong Yidong  <cyd@gnu.org>
 
+	* tooltip.el (tooltip-mode): Doc fix.
+	(tooltip-use-echo-area): Mark as obsolete (Bug#6595).
+
 	* frame.el (set-cursor-color): Doc fix (Bug#352).
 
 	* mail/rmail.el (rmail-start-mail): Add send-action again (Bug#10625).
diff --git a/lisp/tooltip.el b/lisp/tooltip.el
index 76ae62d88e2..50ae682d42d 100644
--- a/lisp/tooltip.el
+++ b/lisp/tooltip.el
@@ -39,18 +39,15 @@
 ;;; Switching tooltips on/off
 
 (define-minor-mode tooltip-mode
-  "Toggle use of graphical tooltips (Tooltip mode).
-With a prefix argument ARG, enable Tooltip mode if ARG is
-positive, and disable it otherwise.  If called from Lisp, enable
-it if ARG is omitted or nil.
-
-When Tooltip mode is enabled, Emacs displays help text in a
-pop-up window for buttons and menu items that you put the mouse
-on.  \(However, if `tooltip-use-echo-area' is non-nil, this and
-all pop-up help appears in the echo area.)
-
-When Tooltip mode is disabled, Emacs displays one line of
-the help text in the echo area, and does not make a pop-up window."
+  "Toggle Tooltip mode.
+With ARG, turn Tooltip mode on if and only if ARG is positive.
+
+When this global minor mode is enabled, Emacs displays help
+text (e.g. for buttons and menu items that you put the mouse on)
+in a pop-up window.
+
+When Tooltip mode is disabled, Emacs displays help text in the
+echo area, instead of making a pop-up window."
   :global t
   ;; Even if we start on a text-only terminal, make this non-nil by
   ;; default because we can open a graphical frame later (multi-tty).
@@ -144,11 +141,14 @@ of the `tooltip' face are used instead."
 
 (defcustom tooltip-use-echo-area nil
   "Use the echo area instead of tooltip frames for help and GUD tooltips.
-To display multi-line help text in the echo area, set this to t
-and enable `tooltip-mode'."
+This variable is obsolete; instead of setting it to t, disable
+`tooltip-mode' (which has a similar effect)."
   :type 'boolean
   :group 'tooltip)
 
+(make-obsolete-variable 'tooltip-use-echo-area
+			"disable Tooltip mode instead" "24.1")
+
 
 ;;; Variables that are not customizable.