GNU logs - #52389, boring messages

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#52389: 29.0.50; Imenu does not pop up the Completions eagerly
Resent-From: Protesilaos Stavrou <info@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Thu, 09 Dec 2021 13:33:01 +0000
Resent-Message-ID: <handler.52389.B.163905675511434 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 52389 <at> debbugs.gnu.org
From: Protesilaos Stavrou <info@HIDDEN>
Date: Thu, 09 Dec 2021 15:32:11 +0200
Message-ID: <87bl1pj44k.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="=-=-="
Received-SPF: none client-ip=217.70.183.196; envelope-from=info@HIDDEN;
 helo=relay4-d.mail.gandi.net
X-Spam_score_int: -25
X-Spam_score: -2.6
X-Spam_bar: --
X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_DNSWL_LOW=-0.7,
 RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001,
 SPF_NONE=0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: -2.3 (--)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

--=-=-=
Content-Type: text/plain

Dear maintainers,

I think the current behaviour of 'imenu-eager-completion-buffer' is
counter-intuitive.  Its default value is non-nil, while its doc string
tells us that:

    If non-nil, eagerly popup the completion buffer.

This, however, is not what actually happens.  With 'emacs -Q':

+ Include a demo function in the scratch buffer: (defun test-fn ())
+ M-x imenu
+ Here we expect the Completions' buffer to eagerly pop up, yet it does
  not.
+ M-: (setq imenu-eager-completion-buffer nil)
+ M-x imenu
+ The Completions' buffer now pops up automatically.

Do you agree that this is counter-intuitive?  If so, please find
attached a patch that should fix the issue.  I was not sure this was
NEWSworthy, but I included an entry regardless.

All the best,
Protesilaos

-- 
Protesilaos Stavrou
https://protesilaos.com

--=-=-=
Content-Type: text/x-patch
Content-Disposition: attachment;
 filename=0001-Fix-semantics-of-imenu-eager-completion-buffer.patch

From b4625110cb5b40f079c134a73e9be8240818fa33 Mon Sep 17 00:00:00 2001
Message-Id: <b4625110cb5b40f079c134a73e9be8240818fa33.1639055998.git.info@HIDDEN>
From: Protesilaos Stavrou <info@HIDDEN>
Date: Thu, 9 Dec 2021 15:19:48 +0200
Subject: [PATCH] Fix semantics of imenu-eager-completion-buffer

* etc/NEWS: Document the change.
* lisp/imenu.el (imenu-eager-completion-buffer): Set the default value
to nil, as that was the intended one.
(imenu--completion-buffer): Update the condition to check for a
non-nil value to 'imenu-eager-completion-buffer'.
---
 etc/NEWS      | 7 +++++++
 lisp/imenu.el | 6 +++---
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/etc/NEWS b/etc/NEWS
index b9134d850e..a83f2d2a86 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -706,6 +706,13 @@ the Netscape web browser was released in February, 2008.
 This support has been obsolete since Emacs 25.1.  The final version of
 the Galeon web browser was released in September, 2008.
 
+** Imenu
+The default value of 'imenu-eager-completion-buffer' is set to nil to
+better convey the intended semantics of optionally popping up the
+Completions' buffer automatically after invoking M-x imenu (with the
+default settings from previous versions, the Completions would not pop
+up automatically and the same is true now).
+
 
 * New Modes and Packages in Emacs 29.1
 
diff --git a/lisp/imenu.el b/lisp/imenu.el
index 22412d5f88..bf12e110e5 100644
--- a/lisp/imenu.el
+++ b/lisp/imenu.el
@@ -99,10 +99,10 @@ (defcustom imenu-use-popup-menu 'on-mouse
 		 (const :tag "Never" nil)
                  (other :tag "Always" t)))
 
-(defcustom imenu-eager-completion-buffer t
+(defcustom imenu-eager-completion-buffer nil
   "If non-nil, eagerly popup the completion buffer."
   :type 'boolean
-  :version "22.1")
+  :version "29.1")
 
 (defcustom imenu-after-jump-hook nil
   "Hooks called after jumping to a place in the buffer.
@@ -727,7 +727,7 @@ (defun imenu--completion-buffer (index-alist &optional prompt)
                          name))))
     (let ((minibuffer-setup-hook minibuffer-setup-hook))
       ;; Display the completion buffer.
-      (if (not imenu-eager-completion-buffer)
+      (when imenu-eager-completion-buffer
 	  (add-hook 'minibuffer-setup-hook 'minibuffer-completion-help))
       (setq name (completing-read prompt
 				  prepared-index-alist
-- 
2.34.1


--=-=-=--

Message sent:

Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-Mailer: MIME-tools 5.505 (Entity 5.505)
Content-Type: text/plain; charset=utf-8
X-Loop: help-debbugs@HIDDEN
From: help-debbugs@HIDDEN (GNU bug Tracking System)
To: Protesilaos Stavrou <info@HIDDEN>
Subject: bug#52389: Acknowledgement (29.0.50; Imenu does not pop up the
 Completions eagerly)
Message-ID: <handler.52389.B.163905675511434.ack <at> debbugs.gnu.org>
References: <87bl1pj44k.fsf@HIDDEN>
X-Gnu-PR-Message: ack 52389
X-Gnu-PR-Package: emacs
Reply-To: 52389 <at> debbugs.gnu.org
Date: Thu, 09 Dec 2021 13:33:02 +0000

Thank you for filing a new bug report with debbugs.gnu.org.

This is an automatically generated reply to let you know your message
has been received.

Your message is being forwarded to the package maintainers and other
interested parties for their attention; they will reply in due course.

Your message has been sent to the package maintainer(s):
 bug-gnu-emacs@HIDDEN

If you wish to submit further information on this problem, please
send it to 52389 <at> debbugs.gnu.org.

Please do not send mail to help-debbugs@HIDDEN unless you wish
to report a problem with the Bug-tracking system.

--=20
52389: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D52389
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#52389: 29.0.50; Imenu does not pop up the Completions eagerly
Resent-From: Lars Ingebrigtsen <larsi@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Fri, 10 Dec 2021 11:52:02 +0000
Resent-Message-ID: <handler.52389.B52389.163913709217570 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Protesilaos Stavrou <info@HIDDEN>
Cc: 52389 <at> debbugs.gnu.org
From: Lars Ingebrigtsen <larsi@HIDDEN>
References: <87bl1pj44k.fsf@HIDDEN>
Date: Fri, 10 Dec 2021 12:51:18 +0100
In-Reply-To: <87bl1pj44k.fsf@HIDDEN> (Protesilaos Stavrou's message
 of "Thu, 09 Dec 2021 15:32:11 +0200")
Message-ID: <87mtl8znih.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux)
MIME-Version: 1.0
Content-Type: text/plain
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

Protesilaos Stavrou <info@HIDDEN> writes:

> * lisp/imenu.el (imenu-eager-completion-buffer): Set the default value
> to nil, as that was the intended one.
> (imenu--completion-buffer): Update the condition to check for a
> non-nil value to 'imenu-eager-completion-buffer'.

But you're reversing the logic, so that people who have set this to nil
now won't get an eager pop up?

I don't think we can do that.  The documentation (and indeed the name of
the variable) seems to be wrong, though.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#52389: 29.0.50; Imenu does not pop up the Completions eagerly
Resent-From: Daniel =?UTF-8?Q?Mart=C3=ADn?= <mardani29@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Fri, 10 Dec 2021 15:18:02 +0000
Resent-Message-ID: <handler.52389.B52389.163914942210864 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Lars Ingebrigtsen <larsi@HIDDEN>
Cc: Protesilaos Stavrou <info@HIDDEN>, 52389 <at> debbugs.gnu.org
From: Daniel =?UTF-8?Q?Mart=C3=ADn?= <mardani29@HIDDEN>
References: <87bl1pj44k.fsf@HIDDEN> <87mtl8znih.fsf@HIDDEN>
Date: Fri, 10 Dec 2021 16:16:47 +0100
In-Reply-To: <87mtl8znih.fsf@HIDDEN> (Lars Ingebrigtsen's message of "Fri,
 10 Dec 2021 12:51:18 +0100")
Message-ID: <m1lf0strq8.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (darwin)
MIME-Version: 1.0
Content-Type: text/plain
Content-Length: 767
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

Lars Ingebrigtsen <larsi@HIDDEN> writes:

> Protesilaos Stavrou <info@HIDDEN> writes:
>
>> * lisp/imenu.el (imenu-eager-completion-buffer): Set the default value
>> to nil, as that was the intended one.
>> (imenu--completion-buffer): Update the condition to check for a
>> non-nil value to 'imenu-eager-completion-buffer'.
>
> But you're reversing the logic, so that people who have set this to nil
> now won't get an eager pop up?
>
> I don't think we can do that.  The documentation (and indeed the name of
> the variable) seems to be wrong, though.

I think the safest way to solve this long-standing problem without
surprising users is to introduce a new variable whose logic is handled
correctly, and mark imenu-eager-completion-buffer as deprecated.

Message sent to bug-gnu-emacs@HIDDEN:

X-Loop: help-debbugs@HIDDEN
Subject: bug#52389: 29.0.50; Imenu does not pop up the Completions eagerly
Resent-From: Lars Ingebrigtsen <larsi@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Sat, 11 Dec 2021 03:26:02 +0000
Resent-Message-ID: <handler.52389.B52389.16391931381829 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
X-GNU-PR-Message: followup 52389
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: 
To: Daniel =?UTF-8?Q?Mart=C3=ADn?= <mardani29@HIDDEN>
Cc: Protesilaos Stavrou <info@HIDDEN>, 52389 <at> debbugs.gnu.org
Received: via spool by 52389-submit <at> debbugs.gnu.org id=B52389.16391931381829
          (code B ref 52389); Sat, 11 Dec 2021 03:26:02 +0000
Received: (at 52389) by debbugs.gnu.org; 11 Dec 2021 03:25:38 +0000
Received: from localhost ([127.0.0.1]:48305 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1mvt10-0000TR-20
	for submit <at> debbugs.gnu.org; Fri, 10 Dec 2021 22:25:38 -0500
Received: from quimby.gnus.org ([95.216.78.240]:33500)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <larsi@HIDDEN>) id 1mvt0y-0000TD-2D
 for 52389 <at> debbugs.gnu.org; Fri, 10 Dec 2021 22:25:36 -0500
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnus.org;
 s=20200322; h=Content-Transfer-Encoding:Content-Type:MIME-Version:Message-ID
 :In-Reply-To:Date:References:Subject:Cc:To:From:Sender:Reply-To:Content-ID:
 Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc
 :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe:
 List-Post:List-Owner:List-Archive;
 bh=N9CF/zR+oYDP2XsW79QZoiFPY1wOhzMPr966kYvShUQ=; b=CsKDsp0PZy+vrlGB130K4N5unn
 7UDVrNYHVwUci/gduksg40bWpEtg0NiAUMrcb2W6v7bGuISdwsaox1w2yok2lymxMeXn/nuSWeI6m
 wgQ91uUlQ/C0BUKX3NyhylSBZIYC5LrCo4MLMVNm0tjKEvN/Yx0zMqBLJ6YlnUMvNAeQ=;
Received: from [84.212.220.105] (helo=xo)
 by quimby.gnus.org with esmtpsa (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.92) (envelope-from <larsi@HIDDEN>)
 id 1mvt0o-0000MF-GU; Sat, 11 Dec 2021 04:25:29 +0100
From: Lars Ingebrigtsen <larsi@HIDDEN>
References: <87bl1pj44k.fsf@HIDDEN> <87mtl8znih.fsf@HIDDEN>
 <m1lf0strq8.fsf@HIDDEN>
Face: iVBORw0KGgoAAAANSUhEUgAAADAAAAAwBAMAAAClLOS0AAAABGdBTUEAALGPC/xhBQAAACBj
 SFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAFVBMVEXq8fnAqLegeX9e
 OEAjFBucVUH///8QE4DzAAAAAWJLR0QGYWa4fQAAAAd0SU1FB+UMCg0iAI96+IcAAAGdSURBVDjL
 1VNBbsNACNzkBbHzgtjtvTLwAsgHgvn/Vzqw2ciVUqnXcshGMzALw7q1fx8T4i28LLTc3sArmSm1
 H9RpmomAI5peDtnzShVJ2DSYeSnQO9V4/ur4lY5hjeatejvzC3RSIhAkt0s78TE/CQMhy3TNRBsE
 o107K3iKz2NFEQtwY5MoSJBTVIvsz1AlLhEumATnKs17Kco8hlI4oyvxrTe4i2DknIGcrUUKoMEt
 b+yixRQRXSRSXnoCPQnom7o8hlU8iEdyTttHZUHZn0TFA832+meFD8ZjM+1X9q7oRRDb2ikMqAPN
 YHUtsVZWUNboaJzvOJtSCKokk7OMlctRmChlSMRu+LnvyorXw628wVwibpmZQzA8aUDZcq8SBpPz
 QoWV0RIDsmLB+c7QExJRWvvAAn2TYFgrNIiczg1dMS6BICzjkso11xxQhx8Ch1JS63JsAbALtLIJ
 VCjeLoaoJZpIIrh8r9fONVx5IfUByI52jdGuvExcOdW4+IY/MKAeLJDCuBO/xB8JpeeZ32CenhOb
 YKB8AjDE+RtdBtpHyoFRdQAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyMS0xMi0xMFQxMzozNDowMCsw
 MDowMD0NvwUAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjEtMTItMTBUMTM6MzQ6MDArMDA6MDBMUAe5
 AAAAAElFTkSuQmCC
X-Now-Playing: Section 25's _From The Hip_: "Back To Wonder (12" Version)"
Date: Sat, 11 Dec 2021 04:25:25 +0100
In-Reply-To: <m1lf0strq8.fsf@HIDDEN> ("Daniel =?UTF-8?Q?Mart=C3=ADn?="'s
 message of "Fri, 10 Dec 2021 16:16:47 +0100")
Message-ID: <87h7bfx1p6.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux)
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
X-Spam-Report: Spam detection software, running on the system "quimby.gnus.org",
 has NOT identified this incoming email as spam.  The original
 message has been attached to this so you can view it or label
 similar future email.  If you have any questions, see
 @@CONTACT_ADDRESS@@ for details.
 
 Content preview:  Daniel =?UTF-8?Q?Mart=C3=ADn?= <mardani29@HIDDEN> writes: > I think the
   safest way to solve this long-standing problem without > surprising users
   is to introduce a new variable whose logic is handled > correctly, and mark
    imenu-eager-completion-buffer as dep [...] 
 
 Content analysis details:   (-2.9 points, 5.0 required)
 
  pts rule name              description
 ---- ---------------------- --------------------------------------------------
 -1.0 ALL_TRUSTED            Passed through trusted hosts only via SMTP
 -1.9 BAYES_00               BODY: Bayes spam probability is 0 to 1%
                             [score: 0.0000]
X-Spam-Score: -2.3 (--)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)

Daniel Mart=C3=ADn <mardani29@HIDDEN> writes:

> I think the safest way to solve this long-standing problem without
> surprising users is to introduce a new variable whose logic is handled
> correctly, and mark imenu-eager-completion-buffer as deprecated.

Sounds good to me.  (The new variable could be an alias of the old name,
but have a name with the opposite meaning, and then things would
continue to work for everybody.)

--=20
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Last modified: Sat, 11 Dec 2021 03:30:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.