Declare mwheel-install obsolete (Bug#36553)

* lisp/mwheel.el: Update `Commentary' section.
(mwheel-install): Declare obsolete in favor of mouse-wheel-mode.
* etc/NEWS: Announce it.

diff --git a/etc/NEWS b/etc/NEWS
index afdcf56b6c0233e7659afed1e20d39256c029343..c875fc693c8d87f14367aedd2a193b74e5792a7f 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1701,6 +1701,13 @@ needing to advice 'ispell-change-dictionary'.
 This command is bound to 'S-down' and scrolls the buffer up in
 particular when the end of the buffer is visible in the window.
 
+** mwheel.el
+
+---
+*** 'mwheel-install' is now obsolete.
+Use 'mouse-wheel-mode' instead.  Note that 'mouse-wheel-mode' is
+already enabled by default on most graphical displays.
+
 \f
 * New Modes and Packages in Emacs 27.1
 

diff --git a/lisp/mwheel.el b/lisp/mwheel.el
index eb665632ffe2d4af6decee6fe7451d92a0214f65..dfea55374b010e5685bce3c10f3c41ea0e532c80 100644 (file)
--- a/lisp/mwheel.el
+++ b/lisp/mwheel.el
@@ -21,22 +21,22 @@
 
 ;;; Commentary:
 
-;; This code will enable the use of the infamous 'wheel' on the new
-;; crop of mice.  Under XFree86 and the XSuSE X Servers, the wheel
-;; events are sent as button4/button5 events.
+;; This enables the use of the mouse wheel (or scroll wheel) in Emacs.
+;; Under X11/X.Org, the wheel events are sent as button4/button5
+;; events.
 
+;; It is already enabled by default on most graphical displays.  You
+;; can toggle it with M-x mouse-wheel-mode.
+
+;;; Code:
+
+;; Implementation note:
+;;
 ;; I for one would prefer some way of converting the button4/button5
 ;; events into different event types, like 'mwheel-up' or
 ;; 'mwheel-down', but I cannot find a way to do this very easily (or
 ;; portably), so for now I just live with it.
 
-;; To enable this code, simply put this at the top of your .emacs
-;; file:
-;;
-;; (mouse-wheel-mode 1)
-
-;;; Code:
-
 (require 'custom)
 (require 'timer)
 
@@ -334,6 +334,7 @@ non-Windows systems."
 ;; preloaded ;;;###autoload
 (defun mwheel-install (&optional uninstall)
   "Enable mouse wheel support."
+  (declare (obsolete mouse-wheel-mode "27.1"))
   (mouse-wheel-mode (if uninstall -1 1)))
 
 (provide 'mwheel)