bug#36553: [PATCH] Declare mwheel-install obsolete

bug#36553: [PATCH] Declare mwheel-install obsolete

[Stefan Kangas]

`mwheel-install' have been redundant for almost 20 years (see commit
f4cbc7a).  I think it's time to retire it.

This patch declares mwheel-install as obsolete in favor of
mouse-wheel-mode and updates the Commentary section and NEWS to
reflect this.

(I'll send the patch in a separate message once this is assigned a bug
number.)

Thanks,
Stefan Kangas

bug#36553: [PATCH] Declare mwheel-install obsolete

[Stefan Kangas]

[-- Attachment #1: Type: text/plain, Size: 159 bytes --]

Stefan Kangas <stefan@marxist.se>:
> (I'll send the patch in a separate message once this is assigned a bug
> number.)

Patch attached.

Thanks,
Stefan Kangas

[-- Attachment #2: 0001-Declare-mwheel-install-obsolete-Bug-36553.patch --]
[-- Type: text/x-patch, Size: 2343 bytes --]

From 4bfd9477675a9d0fa37093d26aacc6c432a262df Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas@gmail.com>
Date: Mon, 8 Jul 2019 17:59:51 +0200
Subject: [PATCH] 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.
---
 etc/NEWS       |  7 +++++++
 lisp/mwheel.el | 21 +++++++++++----------
 2 files changed, 18 insertions(+), 10 deletions(-)

diff --git a/etc/NEWS b/etc/NEWS
index 852b6e4948..450076320a 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1644,6 +1644,13 @@ This runs after changing the dictionary and could be used to
 automatically spellcheck a buffer when changing language without
 needing to advice 'ispell-change-dictionary'.
 
+** 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 eb665632ff..dfea55374b 100644
--- 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 @@ mouse-wheel-mode
 ;; 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)
-- 
2.11.0

bug#36553: [PATCH] Declare mwheel-install obsolete

[Noam Postavsky]

tags 36553 fixed
close 36553 27.1
quit

> Subject: [PATCH] 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.

Pushed to master.

bba80faf87 2019-07-18T20:06:27-04:00 "Declare mwheel-install obsolete (Bug#36553)"
https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=bba80faf87a6a732a648a629381a51ec8164b7e0