GNU logs - #79979, boring messages

Message sent to karthikchikmagalur@HIDDEN, bug-gnu-emacs@HIDDEN:

Subject: bug#79979: timeout-throttle initial return value
Resent-From: Juri Linkov <juri@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: karthikchikmagalur@HIDDEN, bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 10 Dec 2025 07:18:02 +0000
Resent-Message-ID: <handler.79979.B.176535103022808 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 79979 <at> debbugs.gnu.org
Cc: Karthik Chikmagalur <karthikchikmagalur@HIDDEN>
From: Juri Linkov <juri@HIDDEN>
Organization: LINKOV.NET
Date: Wed, 10 Dec 2025 09:16:04 +0200
Message-ID: <87qzt2n867.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="=-=-="
Received-SPF: pass client-ip=2001:67c:2050:0:465::202;
 envelope-from=juri@HIDDEN; helo=mout-p-202.mailbox.org
X-Spam_score_int: -27
X-Spam_score: -2.8
X-Spam_bar: --
X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1,
 RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_PASS=-0.001,
 SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: 1.0 (+)
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: -0.0 (/)

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

This recipe demonstrates that unexpectedly 'timeout-throttle'
returns nil on the first call, contrary to its specification:

  (require 'timeout)
  (setq func (timeout-throttled-func (lambda () 1) 10))
  (funcall func) => nil
  (funcall func) => 1

This is because 'prog1' in 'timeout-throttled-func' causes it
to return nil on the first call.  Here is the fix:


--=-=-=
Content-Type: text/x-diff
Content-Disposition: inline; filename=timeout-throttle-result.patch

diff --git a/lisp/emacs-lisp/timeout.el b/lisp/emacs-lisp/timeout.el
index 2b90650f02a..cf8a81a4f44 100644
--- a/lisp/emacs-lisp/timeout.el
+++ b/lisp/emacs-lisp/timeout.el
@@ -82,7 +82,7 @@ timeout--throttle-advice
         (result))
     (lambda (orig-fn &rest args)
       "Throttle calls to this function."
-      (prog1 result
+      (progn
         (unless (and throttle-timer (timerp throttle-timer))
           (setq result (apply orig-fn args))
           (setq throttle-timer
@@ -90,7 +90,8 @@ timeout--throttle-advice
                  (timeout--eval-value timeout-value) nil
                  (lambda ()
                    (cancel-timer throttle-timer)
-                   (setq throttle-timer nil)))))))))
+                   (setq throttle-timer nil)))))
+        result))))
 
 (defun timeout--debounce-advice (&optional delay default)
   "Return a function that debounces its argument function.
@@ -182,7 +183,7 @@ timeout-throttled-func
             "\n\nThrottle calls to this function"))
           (interactive (advice-eval-interactive-spec
                         (cadr (interactive-form func))))
-          (prog1 result
+          (progn
             (unless (and throttle-timer (timerp throttle-timer))
               (setq result (apply func args))
               (setq throttle-timer
@@ -190,14 +191,15 @@ timeout-throttled-func
                      (timeout--eval-value throttle-value) nil
                      (lambda ()
                        (cancel-timer throttle-timer)
-                       (setq throttle-timer nil)))))))
+                       (setq throttle-timer nil)))))
+            result))
       ;; NON-INTERACTIVE version
       (lambda (&rest args)
         (:documentation
          (concat
           (documentation func)
           "\n\nThrottle calls to this function"))
-        (prog1 result
+        (progn
           (unless (and throttle-timer (timerp throttle-timer))
             (setq result (apply func args))
             (setq throttle-timer
@@ -205,7 +207,8 @@ timeout-throttled-func
                    (timeout--eval-value throttle-value) nil
                    (lambda ()
                      (cancel-timer throttle-timer)
-                     (setq throttle-timer nil))))))))))
+                     (setq throttle-timer nil)))))
+          result)))))
 
 (defun timeout-debounced-func (func &optional delay default)
   "Return a debounced version of function FUNC.

--=-=-=--

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: Juri Linkov <juri@HIDDEN>
Subject: bug#79979: Acknowledgement (timeout-throttle initial return value)
Message-ID: <handler.79979.B.176535103022808.ack <at> debbugs.gnu.org>
References: <87qzt2n867.fsf@HIDDEN>
X-Gnu-PR-Message: ack 79979
X-Gnu-PR-Package: emacs
Reply-To: 79979 <at> debbugs.gnu.org
Date: Wed, 10 Dec 2025 07:18:03 +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.

As you requested using X-Debbugs-CC, your message was also forwarded to
  Karthik Chikmagalur <karthikchikmagalur@HIDDEN>
(after having been given a bug report number, if it did not have one).

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 79979 <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
79979: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D79979
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#79979: timeout-throttle initial return value
Resent-From: Karthik Chikmagalur <karthikchikmagalur@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 10 Dec 2025 08:03:03 +0000
Resent-Message-ID: <handler.79979.B79979.17653537551116 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Juri Linkov <juri@HIDDEN>, 79979 <at> debbugs.gnu.org
From: Karthik Chikmagalur <karthikchikmagalur@HIDDEN>
In-Reply-To: <87qzt2n867.fsf@HIDDEN>
References: <87qzt2n867.fsf@HIDDEN>
Date: Wed, 10 Dec 2025 00:02:23 -0800
Message-ID: <875xaeg3xs.fsf@HIDDEN>
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>

> This is because 'prog1' in 'timeout-throttled-func' causes it
> to return nil on the first call.  Here is the fix:

Thank you Juri.  I have tested and applied the fix upstream, at
https://github.com/karthink/timeout.

Karthik

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#79979: timeout-throttle initial return value
Resent-From: Juri Linkov <juri@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 10 Dec 2025 17:41:02 +0000
Resent-Message-ID: <handler.79979.B79979.17653884104374 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Karthik Chikmagalur <karthikchikmagalur@HIDDEN>
Cc: 79979 <at> debbugs.gnu.org
From: Juri Linkov <juri@HIDDEN>
In-Reply-To: <875xaeg3xs.fsf@HIDDEN>
Organization: LINKOV.NET
References: <87qzt2n867.fsf@HIDDEN> <875xaeg3xs.fsf@HIDDEN>
Date: Wed, 10 Dec 2025 19:38:19 +0200
Message-ID: <874ipyi6es.fsf@HIDDEN>
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>

close 79979 31.0.50
thanks

>> This is because 'prog1' in 'timeout-throttled-func' causes it
>> to return nil on the first call.  Here is the fix:
>
> Thank you Juri.  I have tested and applied the fix upstream, at
> https://github.com/karthink/timeout.

Thanks for confirming.  So now pushed to the Emacs repo as well.

BTW, I also added ###autoload to 4 entry points of the package.

Message received at control <at> debbugs.gnu.org:

Received: (at control) by debbugs.gnu.org; 10 Dec 2025 17:40:11 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Wed Dec 10 12:40:11 2025
Received: from localhost ([127.0.0.1]:35663 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1vTOAc-00019B-Tu
	for submit <at> debbugs.gnu.org; Wed, 10 Dec 2025 12:40:11 -0500
Received: from mout-p-202.mailbox.org ([80.241.56.172]:60976)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.84_2) (envelope-from <juri@HIDDEN>)
 id 1vTOAX-000145-DN; Wed, 10 Dec 2025 12:40:05 -0500
Received: from smtp102.mailbox.org (smtp102.mailbox.org
 [IPv6:2001:67c:2050:b231:465::102])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256)
 (No client certificate requested)
 by mout-p-202.mailbox.org (Postfix) with ESMTPS id 4dRNJs43P1z9sqV;
 Wed, 10 Dec 2025 18:39:57 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linkov.net; s=MBO0001; 
 t=1765388397;
 h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
 to:to:cc:cc:mime-version:mime-version:content-type:content-type:
 in-reply-to:in-reply-to:references:references;
 bh=m85amXgBXJRqisvoU3CGa5Pq933MRrMi7DZ0hPBYRfc=;
 b=AlUzP4iuF3JZmuYATXgFVnI1Lj4HU+d+99dUdoONc5bYyHez1HlZeT5JpagccYu6SQSbaW
 wjvvn7UJf6THrKBfBUVLYKbOQHf6XOoaiZhFoRlRykf5srJEcoqbbWR2UCiygsS1vNQ8xe
 kN4q2KPGaVRfN3RgREXw+vRyCpgUWwTTIbs9LOa5EZNiLsmGXcoayLvjfOETBd4WbxGl75
 89RwoPRiUw9yKyCltk2VxNZ60JdRCOgq9jSDD3T1zViv8vXo8wWRH2xIzVBrarGgEyWN33
 szwIZa2F7wNVbQtnEB4e/zUdS4ju9fKde6PVym/cDUzAGNQvCUytabdHHUGA+A==
Authentication-Results: outgoing_mbo_mout; dkim=none;
 spf=pass (outgoing_mbo_mout: domain of juri@HIDDEN designates
 2001:67c:2050:b231:465::102 as permitted sender)
 smtp.mailfrom=juri@HIDDEN
From: Juri Linkov <juri@HIDDEN>
To: Karthik Chikmagalur <karthikchikmagalur@HIDDEN>
Subject: Re: bug#79979: timeout-throttle initial return value
In-Reply-To: <875xaeg3xs.fsf@HIDDEN>
Organization: LINKOV.NET
References: <87qzt2n867.fsf@HIDDEN> <875xaeg3xs.fsf@HIDDEN>
Date: Wed, 10 Dec 2025 19:38:19 +0200
Message-ID: <874ipyi6es.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain
X-Rspamd-Queue-Id: 4dRNJs43P1z9sqV
X-Spam-Score: -0.7 (/)
X-Debbugs-Envelope-To: control
Cc: 79979 <at> debbugs.gnu.org
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.7 (-)

close 79979 31.0.50
thanks

>> This is because 'prog1' in 'timeout-throttled-func' causes it
>> to return nil on the first call.  Here is the fix:
>
> Thank you Juri.  I have tested and applied the fix upstream, at
> https://github.com/karthink/timeout.

Thanks for confirming.  So now pushed to the Emacs repo as well.

BTW, I also added ###autoload to 4 entry points of the package.

Last modified: Wed, 10 Dec 2025 17:45:02 UTC

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