From unknown Sat Aug 16 11:33:53 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#27230 <27230@debbugs.gnu.org> To: bug#27230 <27230@debbugs.gnu.org> Subject: Status: eldoc doc Reply-To: bug#27230 <27230@debbugs.gnu.org> Date: Sat, 16 Aug 2025 18:33:53 +0000 retitle 27230 eldoc doc reassign 27230 emacs submitter 27230 "Charles A. Roelli" severity 27230 minor tag 27230 patch thanks From debbugs-submit-bounces@debbugs.gnu.org Sun Jun 04 06:38:58 2017 Received: (at submit) by debbugs.gnu.org; 4 Jun 2017 10:38:58 +0000 Received: from localhost ([127.0.0.1]:54628 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dHSvy-00072Y-BI for submit@debbugs.gnu.org; Sun, 04 Jun 2017 06:38:58 -0400 Received: from eggs.gnu.org ([208.118.235.92]:39074) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dHSvw-00072K-9j for submit@debbugs.gnu.org; Sun, 04 Jun 2017 06:38:56 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dHSvq-00012X-Gq for submit@debbugs.gnu.org; Sun, 04 Jun 2017 06:38:51 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-0.5 required=5.0 tests=BAYES_05 autolearn=disabled version=3.3.2 Received: from lists.gnu.org ([2001:4830:134:3::11]:53097) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dHSvq-00012I-DL for submit@debbugs.gnu.org; Sun, 04 Jun 2017 06:38:50 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:58273) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dHSvp-0005BR-GL for bug-gnu-emacs@gnu.org; Sun, 04 Jun 2017 06:38:50 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dHSvl-0000zY-Kq for bug-gnu-emacs@gnu.org; Sun, 04 Jun 2017 06:38:49 -0400 Received: from [195.159.176.226] (port=57061 helo=blaine.gmane.org) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dHSvl-0000yd-CK for bug-gnu-emacs@gnu.org; Sun, 04 Jun 2017 06:38:45 -0400 Received: from list by blaine.gmane.org with local (Exim 4.84_2) (envelope-from ) id 1dHSvc-0006VV-Ha for bug-gnu-emacs@gnu.org; Sun, 04 Jun 2017 12:38:36 +0200 X-Injected-Via-Gmane: http://gmane.org/ To: bug-gnu-emacs@gnu.org From: "Charles A. Roelli" Subject: eldoc doc Date: Sun, 4 Jun 2017 12:38:36 +0200 Lines: 17 Message-ID: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit X-Complaints-To: usenet@blaine.gmane.org User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.6; rv:45.0) Gecko/20100101 Thunderbird/45.8.0 X-Mozilla-News-Host: news://news.gmane.org:119 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-Received-From: 2001:4830:134:3::11 X-Spam-Score: -5.0 (-----) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -5.0 (-----) From the top of eldoc.el: ;; One useful way to enable this minor mode is to put the following in your ;; .emacs: ;; ;; (add-hook 'emacs-lisp-mode-hook 'eldoc-mode) ;; (add-hook 'lisp-interaction-mode-hook 'eldoc-mode) ;; (add-hook 'ielm-mode-hook 'eldoc-mode) ;; (add-hook 'eval-expression-minibuffer-setup-hook 'eldoc-mode) In 25.2, none of these lines are needed. Maybe these lines could be replaced with a mention of global-eldoc-mode, and how the "globalized" minor mode and eldoc-mode interact (not sure how they do). Also, most of the functions in eldoc have no docstring (seems ironic). Would there be any interest in a patch to fix that? From debbugs-submit-bounces@debbugs.gnu.org Mon Jun 05 18:08:14 2017 Received: (at 27230) by debbugs.gnu.org; 5 Jun 2017 22:08:14 +0000 Received: from localhost ([127.0.0.1]:58198 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dI0AY-0006vb-Gk for submit@debbugs.gnu.org; Mon, 05 Jun 2017 18:08:14 -0400 Received: from mail-wr0-f175.google.com ([209.85.128.175]:35832) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dI0AW-0006vM-Eg for 27230@debbugs.gnu.org; Mon, 05 Jun 2017 18:08:12 -0400 Received: by mail-wr0-f175.google.com with SMTP id q97so45177307wrb.2 for <27230@debbugs.gnu.org>; Mon, 05 Jun 2017 15:08:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:subject:to:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=t+vsd/kccp9ohep9x2wSojK7jrJEDLtr7N71pSWTW2M=; b=pfTDzDRqjlN1wT5zJv8zKDC9ByTwt8VRLQ2Ylhg56sEKiDdIVsY+uHr/5bMo+qx6zs ipy6vc0N2iL2uXrxYnBQ+VEhy++hSvzDWvWxJoTlbbm68oljaDTZrdM7hfUh92V65E9p b0FklOlP3xUaCsAe13AsiACijifW/msLIFtiEQuhjfen9B9v1U0FmXaBh726HbdU4Q8P BKwBqWGc4O8UXq8DiTMYnBpjsUU27uojdmbskWMT+mqS9rHdL6sQXS7a+/LovduLJyzc sPfayiG7a+9Sg+6crlItmDWalLJIRzna4Yz+c+IC0qE8LAzjT+i1exnvwd0dbczfzaS1 FxMA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:subject:to:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=t+vsd/kccp9ohep9x2wSojK7jrJEDLtr7N71pSWTW2M=; b=Altvva8UmkSjf/zjGDYuGENK8vqibixgejVFTSzXI11JswhPZmimJvNsPBxw/zXwb3 GZsYNbh+YZdWWAl5J0yU5S1YrDtBNAE447Z4nauRqadqIC+eLbGHLr0wUn42IqkssLEQ XeQ9svPoZrW5d7lW/FHkvlKxSvYZ2JQepGk8sVYIXloHmrViZS7ZFGizgfe9v5N+gmiy EaBOuX+mHGbtrAtEVmug0yMXs/Eh9EOYR4GvyVZVjHL3x+CQHWTISxzzpZGu3BBLEGU2 BIhMaFSkDH4uoBH6cYRpjGwe6yvl5v4pLv1JLS5wpUcltwua9sST1HQTsyO0N5Zv9iwu 1lzg== X-Gm-Message-State: AODbwcAqwx46JIgteMAAp28SDtGw6aDOR+Iho4jB2gTDIZdYqDRFtB36 6jenoCTzQSdpQD8bFH4= X-Received: by 10.223.176.25 with SMTP id f25mr14692926wra.74.1496700486601; Mon, 05 Jun 2017 15:08:06 -0700 (PDT) Received: from [192.168.1.3] ([185.105.174.193]) by smtp.googlemail.com with ESMTPSA id p17sm25447920wrc.66.2017.06.05.15.08.04 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 05 Jun 2017 15:08:06 -0700 (PDT) Subject: Re: bug#27230: eldoc doc To: "Charles A. Roelli" , 27230@debbugs.gnu.org References: From: Dmitry Gutov Message-ID: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> Date: Tue, 6 Jun 2017 01:08:02 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:54.0) Gecko/20100101 Thunderbird/54.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Score: -2.6 (--) X-Debbugs-Envelope-To: 27230 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.6 (--) On 6/4/17 1:38 PM, Charles A. Roelli wrote: > From the top of eldoc.el: > > ;; One useful way to enable this minor mode is to put the following in your > ;; .emacs: > ;; > ;; (add-hook 'emacs-lisp-mode-hook 'eldoc-mode) > ;; (add-hook 'lisp-interaction-mode-hook 'eldoc-mode) > ;; (add-hook 'ielm-mode-hook 'eldoc-mode) > ;; (add-hook 'eval-expression-minibuffer-setup-hook 'eldoc-mode) > > In 25.2, none of these lines are needed. Maybe > these lines could be replaced with a mention of global-eldoc-mode, > and how the "globalized" minor mode and eldoc-mode interact (not sure > how they do). Do you mean that how define-globalized-minor-mode works is unclear to you, or some aspects of how it applies to eldoc-mode? > Also, most of the functions in eldoc have no docstring (seems ironic). > Would there be any interest in a patch to fix that? Sure! From debbugs-submit-bounces@debbugs.gnu.org Tue Jun 06 14:33:19 2017 Received: (at 27230) by debbugs.gnu.org; 6 Jun 2017 18:33:19 +0000 Received: from localhost ([127.0.0.1]:59851 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dIJI7-0000r2-Cs for submit@debbugs.gnu.org; Tue, 06 Jun 2017 14:33:19 -0400 Received: from sinyavsky.aurox.ch ([37.35.109.145]:34969) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dIJI5-0000qm-Jf for 27230@debbugs.gnu.org; Tue, 06 Jun 2017 14:33:18 -0400 Received: from sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) by sinyavsky.aurox.ch (Postfix) with ESMTP id 9F5CD2245D for <27230@debbugs.gnu.org>; Tue, 6 Jun 2017 18:28:33 +0000 (UTC) Authentication-Results: sinyavsky.aurox.ch (amavisd-new); dkim=pass (1024-bit key) reason="pass (just generated, assumed good)" header.d=aurox.ch DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=aurox.ch; h= content-transfer-encoding:content-type:content-type:in-reply-to :mime-version:user-agent:date:date:message-id:from:from :references:to:subject:subject; s=dkim; t=1496773712; x= 1497637713; bh=fG8eltQ0c98LhL7soZ6YfsGww5C1dsyStkhRZ5HIYok=; b=G 2d8/AXJuKdNB2ugSLgd472kiv3wY6ehlIA2TpCfZfzy9J8C1/EcNKiKcdmfTMiZk 6NhDlp0sii+su80PkHu0W96dLPEt1HbjxE0XjVL8ffU9mMHt/SQP22a5ermK1u1C n1V+pPlJ4tHfxfZhxHhIWarKDh31I29+3xJMxZPDYs= X-Virus-Scanned: Debian amavisd-new at test.virtualizor.com Received: from sinyavsky.aurox.ch ([127.0.0.1]) by sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id B0iN2eFI6MRw for <27230@debbugs.gnu.org>; Tue, 6 Jun 2017 18:28:32 +0000 (UTC) Received: from [192.168.1.121] (125.85.192.178.dynamic.wline.res.cust.swisscom.ch [178.192.85.125]) by sinyavsky.aurox.ch (Postfix) with ESMTPSA id E7A0622456; Tue, 6 Jun 2017 18:28:31 +0000 (UTC) Subject: Re: bug#27230: eldoc doc To: Dmitry Gutov , 27230@debbugs.gnu.org References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> From: "Charles A. Roelli" Message-ID: Date: Tue, 6 Jun 2017 20:33:09 +0200 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.6; rv:45.0) Gecko/20100101 Thunderbird/45.8.0 MIME-Version: 1.0 In-Reply-To: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 27230 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.7 (/) I'm confused about how the command `define-globalized-minor-mode' defines will handle buffers that already have the minor mode turned on. Say buffers A and B have simple `eldoc-mode' switched on, and buffers C and D don't (and global-eldoc-mode is off). If I then switch global-eldoc-mode on, is every buffer's value of eldoc-mode now /on/, or do the values get toggled instead (leaving A and B off, C and D on)? And after that, if I toggle global-eldoc-mode off again, are the previous values remembered and restored, or does every buffer now have eldoc-mode switched off? Thanks for your help with this. I've probably missed a paragraph in the docs somewhere. On 06/06/2017 00:08, Dmitry Gutov wrote: > On 6/4/17 1:38 PM, Charles A. Roelli wrote: >> From the top of eldoc.el: >> >> ;; One useful way to enable this minor mode is to put the following >> in your >> ;; .emacs: >> ;; >> ;; (add-hook 'emacs-lisp-mode-hook 'eldoc-mode) >> ;; (add-hook 'lisp-interaction-mode-hook 'eldoc-mode) >> ;; (add-hook 'ielm-mode-hook 'eldoc-mode) >> ;; (add-hook 'eval-expression-minibuffer-setup-hook 'eldoc-mode) >> >> In 25.2, none of these lines are needed. Maybe >> these lines could be replaced with a mention of global-eldoc-mode, >> and how the "globalized" minor mode and eldoc-mode interact (not sure >> how they do). > > Do you mean that how define-globalized-minor-mode works is unclear to > you, or some aspects of how it applies to eldoc-mode? > >> Also, most of the functions in eldoc have no docstring (seems ironic). >> Would there be any interest in a patch to fix that? > > Sure! From debbugs-submit-bounces@debbugs.gnu.org Tue Jun 06 16:19:57 2017 Received: (at 27230) by debbugs.gnu.org; 6 Jun 2017 20:19:57 +0000 Received: from localhost ([127.0.0.1]:59918 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dIKxJ-0003Zq-KA for submit@debbugs.gnu.org; Tue, 06 Jun 2017 16:19:57 -0400 Received: from mail-wm0-f41.google.com ([74.125.82.41]:35928) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dIKxH-0003Zc-QQ for 27230@debbugs.gnu.org; Tue, 06 Jun 2017 16:19:56 -0400 Received: by mail-wm0-f41.google.com with SMTP id 7so105186113wmo.1 for <27230@debbugs.gnu.org>; Tue, 06 Jun 2017 13:19:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:subject:to:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=I4LCeo4Fhs5Y7qdkVPS86crTj59vHC5dgrc9kgyPBV0=; b=dy6FPLnqmFGa2CG6hdjho7U/MQ3vvMeArWQTh2wu/YyVr3FOiY4MVEl2zxZsx56JtH 2VnatbS7Wod7osrDDdrfDP0DpqZ6Qx/q3VsIpM9bHz5s607VnhQy3/wZaPM5Yyq8NX4G YOxIX7xzAfwlJv17OmN+tiGN5rp3Nq0EqTDYAwQg1d2Kx+hsKZr9cx66bSYQA3VSFjCR Viqyreyq6CkrI6l27dVhBBP+URgoqGLdYpVIAqwZUh31rr2lml78Nts7YTBJrLFYOpj7 fBeVatoWx+z3qNt43jnKq2jKWxrSnMoFSp5iPZIj3i2ztsKnIDD6jvE2JGEC6X/FUjIT SSsA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:subject:to:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=I4LCeo4Fhs5Y7qdkVPS86crTj59vHC5dgrc9kgyPBV0=; b=dl5lQpxfBvLEGsZ++ky/XvlS2gSOnJIjcReks1NvQ8OYTpYUKKvK/pOK+c2e7teHJz oUK4qpDtK+G+XgqUCiz4y9njN2vx6IyixZ8Zxh3JwvnkC2/0Rx3pWpnO+TW0wDzoDmO2 kU2waW/QhiAljEFFRWj2tkkJGJbaYhlpaXWS1vIkpunUaO0aj4yp7+8CUhWSafaDBQbe tthCtHt54AoI1ZDqt1x3P//c7pvKgweePY45gajOTnQiBp3KUgq8xYXWp+HKAn7KznSe uvZSVZr/OxRq8H80DnDdBUbekS6JDdCjp0HHFFBvXliWh/5QMQfxWk1hta1EygVB1Ti8 QY7A== X-Gm-Message-State: AODbwcCa3PqxUSruLFbNgUmoyLGgu6OPs5DSAKCFGK/w7nsQg4iQm3Y1 NgcfEim1XgEHVb9MUsk= X-Received: by 10.28.135.82 with SMTP id j79mr13724119wmd.10.1496780389914; Tue, 06 Jun 2017 13:19:49 -0700 (PDT) Received: from [192.168.1.3] ([185.105.174.193]) by smtp.googlemail.com with ESMTPSA id x37sm61677591wrb.42.2017.06.06.13.19.48 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 06 Jun 2017 13:19:48 -0700 (PDT) Subject: Re: bug#27230: eldoc doc To: "Charles A. Roelli" , 27230@debbugs.gnu.org References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> From: Dmitry Gutov Message-ID: Date: Tue, 6 Jun 2017 23:19:46 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:54.0) Gecko/20100101 Thunderbird/54.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Score: 2.0 (++) X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.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 the administrator of that system for details. Content preview: On 6/6/17 9:33 PM, Charles A. Roelli wrote: > I'm confused about how the command `define-globalized-minor-mode' > defines will handle buffers that already have the minor mode turned > on. Indeed, the docstring is a bit ambiguous. [...] Content analysis details: (2.0 points, 10.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail provider (dgutov[at]yandex.ru) -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at http://www.dnswl.org/, no trust [74.125.82.41 listed in list.dnswl.org] 1.0 HEADER_FROM_DIFFERENT_DOMAINS From and EnvelopeFrom 2nd level mail domains are different -0.0 SPF_PASS SPF: sender matches SPF record -0.0 RCVD_IN_MSPIKE_H3 RBL: Good reputation (+3) [74.125.82.41 listed in wl.mailspike.net] 1.0 FREEMAIL_FORGED_FROMDOMAIN 2nd level domains in From and EnvelopeFrom freemail headers are different 0.0 T_DKIM_INVALID DKIM-Signature header exists but is not valid -0.0 RCVD_IN_MSPIKE_WL Mailspike good senders X-Debbugs-Envelope-To: 27230 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 2.0 (++) X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.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 the administrator of that system for details. Content preview: On 6/6/17 9:33 PM, Charles A. Roelli wrote: > I'm confused about how the command `define-globalized-minor-mode' > defines will handle buffers that already have the minor mode turned > on. Indeed, the docstring is a bit ambiguous. [...] Content analysis details: (2.0 points, 10.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at http://www.dnswl.org/, no trust [74.125.82.41 listed in list.dnswl.org] -0.0 RCVD_IN_MSPIKE_H3 RBL: Good reputation (+3) [74.125.82.41 listed in wl.mailspike.net] 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail provider (raaahh[at]gmail.com) 1.0 HEADER_FROM_DIFFERENT_DOMAINS From and EnvelopeFrom 2nd level mail domains are different -0.0 SPF_PASS SPF: sender matches SPF record 1.0 FREEMAIL_FORGED_FROMDOMAIN 2nd level domains in From and EnvelopeFrom freemail headers are different 0.0 T_DKIM_INVALID DKIM-Signature header exists but is not valid -0.0 RCVD_IN_MSPIKE_WL Mailspike good senders On 6/6/17 9:33 PM, Charles A. Roelli wrote: > I'm confused about how the command `define-globalized-minor-mode' > defines will handle buffers that already have the minor mode turned > on. Indeed, the docstring is a bit ambiguous. Maybe you want to improve the documentation of the said function, or the auto-generated docstring that it puts on the created minor modes. > Say buffers A and B have simple `eldoc-mode' switched on, and > buffers C and D don't (and global-eldoc-mode is off). If I then > switch global-eldoc-mode on, is every buffer's value of eldoc-mode > now /on/, or do the values get toggled instead (leaving A and B off, C > and D on)? Not toggled, of course. On everywhere (where appropriate). > And after that, if I toggle global-eldoc-mode off again, > are the previous values remembered and restored, or does every buffer > now have eldoc-mode switched off? Not remembered, no. Off everywhere. From debbugs-submit-bounces@debbugs.gnu.org Sun Jun 25 05:14:38 2017 Received: (at 27230) by debbugs.gnu.org; 25 Jun 2017 09:14:38 +0000 Received: from localhost ([127.0.0.1]:36290 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dP3cs-0006G3-0l for submit@debbugs.gnu.org; Sun, 25 Jun 2017 05:14:38 -0400 Received: from sinyavsky.aurox.ch ([37.35.109.145]:49552) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dP3cp-0006Fp-I6 for 27230@debbugs.gnu.org; Sun, 25 Jun 2017 05:14:36 -0400 Received: from sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) by sinyavsky.aurox.ch (Postfix) with ESMTP id 855CA22483 for <27230@debbugs.gnu.org>; Sun, 25 Jun 2017 09:09:32 +0000 (UTC) Authentication-Results: sinyavsky.aurox.ch (amavisd-new); dkim=pass (1024-bit key) reason="pass (just generated, assumed good)" header.d=aurox.ch DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=aurox.ch; h= content-type:content-type:in-reply-to:mime-version:user-agent :date:date:message-id:from:from:references:to:subject:subject; s=dkim; t=1498381769; x=1499245770; bh=Eh0GqXcoMwAQvHHMCnLgTNzI LiKOp7CQUMLM5bSdgSA=; b=TacTF30OLgU8KPKpAC4klgCqalfhrWL4+md/PkuP DLxcfuSSJ52wzKMRjYbJwTuJOpk9GFdBJdPvAWG4JH6gnhTdtuI07yET+e1qwNZ0 ymdZB85Bex0C70RXJTHPkczsKQqYX0EAVUt3oDRDtdX0fkIHgVwkwJ7W2mQNGjd6 xac= X-Virus-Scanned: Debian amavisd-new at test.virtualizor.com Received: from sinyavsky.aurox.ch ([127.0.0.1]) by sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id RTmQBbVRnq3B for <27230@debbugs.gnu.org>; Sun, 25 Jun 2017 09:09:29 +0000 (UTC) Received: from [192.168.1.121] (125.85.192.178.dynamic.wline.res.cust.swisscom.ch [178.192.85.125]) by sinyavsky.aurox.ch (Postfix) with ESMTPSA id 60C8B22443; Sun, 25 Jun 2017 09:09:29 +0000 (UTC) Subject: Re: bug#27230: eldoc doc To: Dmitry Gutov , 27230@debbugs.gnu.org References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> From: "Charles A. Roelli" Message-ID: Date: Sun, 25 Jun 2017 11:14:23 +0200 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.6; rv:45.0) Gecko/20100101 Thunderbird/45.8.0 MIME-Version: 1.0 In-Reply-To: Content-Type: multipart/mixed; boundary="------------35029ED80AD546807560BEB5" X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 27230 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.7 (/) This is a multi-part message in MIME format. --------------35029ED80AD546807560BEB5 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Here's a doc patch for ElDoc, with some minor readability fixes. I'm unsure how to improve the doc for globalized minor modes, so I'll leave that for another time. On 06/06/2017 22:19, Dmitry Gutov wrote: > On 6/6/17 9:33 PM, Charles A. Roelli wrote: >> I'm confused about how the command `define-globalized-minor-mode' >> defines will handle buffers that already have the minor mode turned >> on. > > Indeed, the docstring is a bit ambiguous. > > Maybe you want to improve the documentation of the said function, or > the auto-generated docstring that it puts on the created minor modes. > >> Say buffers A and B have simple `eldoc-mode' switched on, and >> buffers C and D don't (and global-eldoc-mode is off). If I then >> switch global-eldoc-mode on, is every buffer's value of eldoc-mode >> now /on/, or do the values get toggled instead (leaving A and B off, C >> and D on)? > > Not toggled, of course. On everywhere (where appropriate). > >> And after that, if I toggle global-eldoc-mode off again, >> are the previous values remembered and restored, or does every buffer >> now have eldoc-mode switched off? > > Not remembered, no. Off everywhere. --------------35029ED80AD546807560BEB5 Content-Type: text/x-patch; name="0001-ElDoc-add-docstrings-and-minor-refactoring.patch" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="0001-ElDoc-add-docstrings-and-minor-refactoring.patch" >From 744b20db5524b32302e9cd90cb71dcaec580430e Mon Sep 17 00:00:00 2001 From: Charles A. Roelli Date: Thu, 22 Jun 2017 21:04:09 +0200 Subject: [PATCH] ElDoc: add docstrings and minor refactoring * lisp/emacs-lisp/eldoc.el (eldoc-edit-message-commands): Add docstring. (turn-on-eldoc-mode): Fix capitalization. (eldoc--supported-p): Add docstring. (eldoc-schedule-timer): Add docstring and use 'eldoc--supported-p'. (eldoc-message): Add docstring and make calling convention clearer. (eldoc--message-command-p): (eldoc-pre-command-refresh-echo-area): (eldoc-display-message-p): (eldoc-display-message-no-interference-p): (eldoc-print-current-symbol-info): (eldoc-docstring-format-sym-doc): (eldoc-add-command, eldoc-add-command-completions): (eldoc-remove-command, eldoc-remove-command-completions): Add docstring. --- lisp/emacs-lisp/eldoc.el | 53 ++++++++++++++++++++++++++++++++++++--------- 1 files changed, 42 insertions(+), 11 deletions(-) diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index a05bd7c..2d8e029 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -160,6 +160,10 @@ eldoc-message-function It should receive the same arguments as `message'.") (defun eldoc-edit-message-commands () + "Return an obarray containing common editing commands. + +When `eldoc-print-after-edit' is non-nil, ElDoc messages are only +printed after commands contained in this obarray." (let ((cmds (make-vector 31 0)) (re (regexp-opt '("delete" "insert" "edit" "electric" "newline")))) (mapatoms (lambda (s) @@ -211,16 +215,21 @@ global-eldoc-mode ;;;###autoload (defun turn-on-eldoc-mode () - "Turn on `eldoc-mode' if the buffer has eldoc support enabled. + "Turn on `eldoc-mode' if the buffer has ElDoc support enabled. See `eldoc-documentation-function' for more detail." (when (eldoc--supported-p) (eldoc-mode 1))) (defun eldoc--supported-p () + "Non-nil if an ElDoc function is set for this buffer." (not (memq eldoc-documentation-function '(nil ignore)))) (defun eldoc-schedule-timer () + "Ensure `eldoc-timer' is running. + +If the user has changed `eldoc-idle-delay', update the timer to +reflect the change." (or (and eldoc-timer (memq eldoc-timer timer-idle-list)) ;FIXME: Why? (setq eldoc-timer @@ -229,8 +238,7 @@ eldoc-schedule-timer (lambda () (when (or eldoc-mode (and global-eldoc-mode - (not (memq eldoc-documentation-function - '(nil ignore))))) + (eldoc--supported-p))) (eldoc-print-current-symbol-info)))))) ;; If user has changed the idle delay, update the timer. @@ -268,16 +276,23 @@ eldoc-minibuffer-message (force-mode-line-update))) (apply 'message format-string args))) -(defun eldoc-message (&rest args) +(defun eldoc-message (&optional format-string &rest args) + "Store and display the given message. + +FORMAT-STRING and ARGS, if given, are passed to `format-message', +the output of which is stored in `eldoc-last-message'. + +`eldoc-last-message' is then displayed (using +`eldoc-message-function') and returned." (let ((omessage eldoc-last-message)) (setq eldoc-last-message - (cond ((eq (car args) eldoc-last-message) eldoc-last-message) - ((null (car args)) nil) + (cond ((eq format-string eldoc-last-message) eldoc-last-message) + ((null format-string) nil) ;; If only one arg, no formatting to do, so put it in ;; eldoc-last-message so eq test above might succeed on ;; subsequent calls. - ((null (cdr args)) (car args)) - (t (apply #'format-message args)))) + ((null args) format-string) + (t (apply #'format-message format-string args)))) ;; In emacs 19.29 and later, and XEmacs 19.13 and later, all messages ;; are recorded in a log. Do not put eldoc messages in that log since ;; they are Legion. @@ -289,6 +304,7 @@ eldoc-message eldoc-last-message) (defun eldoc--message-command-p (command) + "Non-nil if COMMAND is a command in `eldoc-message-commands'." (and (symbolp command) (intern-soft (symbol-name command) eldoc-message-commands))) @@ -299,6 +315,7 @@ eldoc--message-command-p ;; before the next command executes, which does away with the flicker. ;; This doesn't seem to be required for Emacs 19.28 and earlier. (defun eldoc-pre-command-refresh-echo-area () + "Reprint `eldoc-last-message' to the echo area." (and eldoc-last-message (not (minibufferp)) ;We don't use the echo area when in minibuffer. (if (and (eldoc-display-message-no-interference-p) @@ -310,6 +327,7 @@ eldoc-pre-command-refresh-echo-area ;; Decide whether now is a good time to display a message. (defun eldoc-display-message-p () + "Non-nil when appropriate to display an ElDoc message." (and (eldoc-display-message-no-interference-p) ;; If this-command is non-nil while running via an idle ;; timer, we're still in the middle of executing a command, @@ -322,6 +340,8 @@ eldoc-display-message-p ;; Check various conditions about the current environment that might make ;; it undesirable to print eldoc messages right this instant. (defun eldoc-display-message-no-interference-p () + "Nil when displaying an ElDoc message would cause interference +with other features." (not (or executing-kbd-macro (bound-and-true-p edebug-active)))) @@ -347,6 +367,7 @@ eldoc-documentation-function return any documentation.") (defun eldoc-print-current-symbol-info () + "Print the output of `eldoc-documentation-function'." ;; This is run from post-command-hook or some idle timer thing, ;; so we need to be careful that errors aren't ignored. (with-demoted-errors "eldoc error: %s" @@ -361,6 +382,12 @@ eldoc-print-current-symbol-info ;; truncated or eliminated entirely from the output to make room for the ;; description. (defun eldoc-docstring-format-sym-doc (prefix doc &optional face) + "Concatenate PREFIX and DOC, returning the largest part of the +resultant string that can fit in the minibuffer window. + +When PREFIX is a symbol, apply FACE to it before concatenating. + +See also: `eldoc-echo-area-use-multiline-p'." (when (symbolp prefix) (setq prefix (concat (propertize (symbol-name prefix) 'face face) ": "))) (let* ((ea-multi eldoc-echo-area-use-multiline-p) @@ -390,22 +417,26 @@ eldoc-docstring-format-sym-doc ;; These functions do display-command table management. (defun eldoc-add-command (&rest cmds) + "Add each of CMDS to the obarray `eldoc-message-commands'." (dolist (name cmds) (and (symbolp name) (setq name (symbol-name name))) (set (intern name eldoc-message-commands) t))) (defun eldoc-add-command-completions (&rest names) + "Pass every prefix completion of NAMES to `eldoc-add-command'." (dolist (name names) (apply #'eldoc-add-command (all-completions name obarray 'commandp)))) (defun eldoc-remove-command (&rest cmds) + "Remove each of CMDS from the obarray `eldoc-message-commands'." (dolist (name cmds) (and (symbolp name) (setq name (symbol-name name))) (unintern name eldoc-message-commands))) (defun eldoc-remove-command-completions (&rest names) + "Pass every prefix completion of NAMES to `eldoc-remove-command'." (dolist (name names) (apply #'eldoc-remove-command (all-completions name eldoc-message-commands)))) @@ -418,9 +449,9 @@ eldoc-remove-command-completions "down-list" "end-of-" "exchange-point-and-mark" "forward-" "goto-" "handle-select-window" "indent-for-tab-command" "left-" "mark-page" "mark-paragraph" "mouse-set-point" "move-" "move-beginning-of-" - "move-end-of-" "newline" "next-" "other-window" "pop-global-mark" "previous-" - "recenter" "right-" "scroll-" "self-insert-command" "split-window-" - "up-list") + "move-end-of-" "newline" "next-" "other-window" "pop-global-mark" + "previous-" "recenter" "right-" "scroll-" "self-insert-command" + "split-window-" "up-list") (provide 'eldoc) -- 1.7.4.4 --------------35029ED80AD546807560BEB5-- From debbugs-submit-bounces@debbugs.gnu.org Sun Jun 25 10:27:22 2017 Received: (at 27230) by debbugs.gnu.org; 25 Jun 2017 14:27:22 +0000 Received: from localhost ([127.0.0.1]:37402 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dP8VW-00079v-6D for submit@debbugs.gnu.org; Sun, 25 Jun 2017 10:27:22 -0400 Received: from eggs.gnu.org ([208.118.235.92]:36801) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dP8VT-00079i-JH for 27230@debbugs.gnu.org; Sun, 25 Jun 2017 10:27:20 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dP8VL-0005wS-8H for 27230@debbugs.gnu.org; Sun, 25 Jun 2017 10:27:14 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=0.8 required=5.0 tests=BAYES_50,RP_MATCHES_RCVD autolearn=disabled version=3.3.2 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:47547) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dP8VL-0005wO-57; Sun, 25 Jun 2017 10:27:11 -0400 Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:2829 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1dP8VK-0004HL-7M; Sun, 25 Jun 2017 10:27:10 -0400 Date: Sun, 25 Jun 2017 17:26:56 +0300 Message-Id: <83efu8ta6n.fsf@gnu.org> From: Eli Zaretskii To: "Charles A. Roelli" In-reply-to: (charles@aurox.ch) Subject: Re: bug#27230: eldoc doc References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-Spam-Score: -5.0 (-----) X-Debbugs-Envelope-To: 27230 Cc: 27230@debbugs.gnu.org, dgutov@yandex.ru X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Eli Zaretskii Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -5.0 (-----) > From: "Charles A. Roelli" > Date: Sun, 25 Jun 2017 11:14:23 +0200 > > Here's a doc patch for ElDoc, with some minor readability fixes. Thanks. Please allow me a few comments below. > -(defun eldoc-message (&rest args) > +(defun eldoc-message (&optional format-string &rest args) > + "Store and display the given message. The first line of a doc string should ideally mention the arguments. > +FORMAT-STRING and ARGS, if given, are passed to `format-message', > +the output of which is stored in `eldoc-last-message'. This leaves me wondering what happens if no arguments are supplied. > (defun eldoc--message-command-p (command) > + "Non-nil if COMMAND is a command in `eldoc-message-commands'." "Return non-nil if ...". The way you wrote it is appropriate for a variable, not for a function. > (defun eldoc-pre-command-refresh-echo-area () > + "Reprint `eldoc-last-message' to the echo area." Are you sure about the "to" part? I'd say "in" sounds more correct. > (defun eldoc-display-message-p () > + "Non-nil when appropriate to display an ElDoc message." "Return non-nil" > (defun eldoc-display-message-no-interference-p () > + "Nil when displaying an ElDoc message would cause interference > +with other features." Likewise. Also, the first line of a doc string should be a complete sentence. > (defun eldoc-print-current-symbol-info () > + "Print the output of `eldoc-documentation-function'." "Print the output" sounds confusing. How about this instead: Print the text produced by `eldoc-documentation-function'. > (defun eldoc-docstring-format-sym-doc (prefix doc &optional face) > + "Concatenate PREFIX and DOC, returning the largest part of the > +resultant string that can fit in the minibuffer window. First line not a complete sentence again. > +When PREFIX is a symbol, apply FACE to it before concatenating. But FACE is optional, so what if it isn't given? Thanks for working on this. From debbugs-submit-bounces@debbugs.gnu.org Sun Jun 25 15:48:01 2017 Received: (at 27230) by debbugs.gnu.org; 25 Jun 2017 19:48:01 +0000 Received: from localhost ([127.0.0.1]:37650 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dPDVo-0003GB-P5 for submit@debbugs.gnu.org; Sun, 25 Jun 2017 15:48:01 -0400 Received: from sinyavsky.aurox.ch ([37.35.109.145]:49916) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dPDVl-0003Fv-Jt for 27230@debbugs.gnu.org; Sun, 25 Jun 2017 15:47:58 -0400 Received: from sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) by sinyavsky.aurox.ch (Postfix) with ESMTP id C900422483 for <27230@debbugs.gnu.org>; Sun, 25 Jun 2017 19:42:55 +0000 (UTC) Authentication-Results: sinyavsky.aurox.ch (amavisd-new); dkim=pass (1024-bit key) reason="pass (just generated, assumed good)" header.d=aurox.ch DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=aurox.ch; h= content-type:content-type:in-reply-to:mime-version:user-agent :date:date:message-id:from:from:references:to:subject:subject; s=dkim; t=1498419772; x=1499283773; bh=sLsfLx0BiGiNuxf1J/sLI3Xc +VEezMEyiCYRxtlc0nc=; b=ePba/tsPr14eK3JMADhQY4qpZc02s+tvl6ZnVy3L 8DOCJLHY+X9nQqGRYppdwc/td2WQ0HH1mEQa7s2fYchQ8xUTAv9QsTCWGVbhfu/E o1Y70+CFPPNitvqyDJUt7Q1jBPq9TwXFwXoYOX11HMsLWcKoA5BYtk/Vdnf6MOOi WIQ= X-Virus-Scanned: Debian amavisd-new at test.virtualizor.com Received: from sinyavsky.aurox.ch ([127.0.0.1]) by sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id vZ-KgUvaqfgP for <27230@debbugs.gnu.org>; Sun, 25 Jun 2017 19:42:52 +0000 (UTC) Received: from [192.168.1.121] (125.85.192.178.dynamic.wline.res.cust.swisscom.ch [178.192.85.125]) by sinyavsky.aurox.ch (Postfix) with ESMTPSA id 26E8522454; Sun, 25 Jun 2017 19:42:52 +0000 (UTC) Subject: Re: bug#27230: eldoc doc To: Eli Zaretskii References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> From: "Charles A. Roelli" Message-ID: Date: Sun, 25 Jun 2017 21:47:46 +0200 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.6; rv:45.0) Gecko/20100101 Thunderbird/45.8.0 MIME-Version: 1.0 In-Reply-To: <83efu8ta6n.fsf@gnu.org> Content-Type: multipart/mixed; boundary="------------2FA1671CC8167200B143813B" X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 27230 Cc: 27230@debbugs.gnu.org, dgutov@yandex.ru X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.7 (/) This is a multi-part message in MIME format. --------------2FA1671CC8167200B143813B Content-Type: text/plain; charset=windows-1252; format=flowed Content-Transfer-Encoding: 7bit Thanks for the quick review! Revised patch is attached. On 25/06/2017 16:26, Eli Zaretskii wrote: >> From: "Charles A. Roelli" >> Date: Sun, 25 Jun 2017 11:14:23 +0200 >> >> Here's a doc patch for ElDoc, with some minor readability fixes. > Thanks. Please allow me a few comments below. > >> -(defun eldoc-message (&rest args) >> +(defun eldoc-message (&optional format-string &rest args) >> + "Store and display the given message. > The first line of a doc string should ideally mention the arguments. "Store and possibly display FORMAT-STRING formatted with ARGS. FORMAT-STRING (or nil, if not given) is stored in `eldoc-last-message'. If ARGS are given, FORMAT-STRING is first formatted through `format-message'. If `eldoc-last-message' is non-nil, display it using `eldoc-message-function'. If it is nil, clear the echo area if there was recently a message from ElDoc there. Return `eldoc-last-message'." > >> +FORMAT-STRING and ARGS, if given, are passed to `format-message', >> +the output of which is stored in `eldoc-last-message'. > This leaves me wondering what happens if no arguments are supplied. See above. > >> (defun eldoc--message-command-p (command) >> + "Non-nil if COMMAND is a command in `eldoc-message-commands'." > "Return non-nil if ...". The way you wrote it is appropriate for a > variable, not for a function. Fixed. > >> (defun eldoc-pre-command-refresh-echo-area () >> + "Reprint `eldoc-last-message' to the echo area." > Are you sure about the "to" part? I'd say "in" sounds more correct. Agreed, it's fixed. > >> (defun eldoc-display-message-p () >> + "Non-nil when appropriate to display an ElDoc message." > "Return non-nil" Fixed. > >> (defun eldoc-display-message-no-interference-p () >> + "Nil when displaying an ElDoc message would cause interference >> +with other features." > Likewise. Also, the first line of a doc string should be a complete > sentence. Fixed. > >> (defun eldoc-print-current-symbol-info () >> + "Print the output of `eldoc-documentation-function'." > "Print the output" sounds confusing. How about this instead: > > Print the text produced by `eldoc-documentation-function'. Fixed. > >> (defun eldoc-docstring-format-sym-doc (prefix doc &optional face) >> + "Concatenate PREFIX and DOC, returning the largest part of the >> +resultant string that can fit in the minibuffer window. > First line not a complete sentence again. How about this? "Combine PREFIX and DOC, and shorten the result to fit in the echo area. When PREFIX is a symbol, propertize its symbol name with FACE before combining it with DOC. If FACE is not provided, just apply the nil face. See also: `eldoc-echo-area-use-multiline-p'." >> +When PREFIX is a symbol, apply FACE to it before concatenating. > But FACE is optional, so what if it isn't given? See above. > > Thanks for working on this. Thanks again for your advice. --------------2FA1671CC8167200B143813B Content-Type: text/x-patch; name="0001-ElDoc-add-docstrings-and-minor-refactoring-v2.patch" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename*0="0001-ElDoc-add-docstrings-and-minor-refactoring-v2.patch" >From 18fe8d8a80be5966c4b9141afc4fc83748c85c9f Mon Sep 17 00:00:00 2001 From: Charles A. Roelli Date: Thu, 22 Jun 2017 21:04:09 +0200 Subject: [PATCH] ElDoc: add docstrings and minor refactoring * lisp/emacs-lisp/eldoc.el (eldoc-edit-message-commands): Add docstring. (turn-on-eldoc-mode): Fix capitalization. (eldoc--supported-p): Add docstring. (eldoc-schedule-timer): Add docstring and use 'eldoc--supported-p'. (eldoc-message): Add docstring and make calling convention clearer. (eldoc--message-command-p): (eldoc-pre-command-refresh-echo-area): (eldoc-display-message-p): (eldoc-display-message-no-interference-p): (eldoc-print-current-symbol-info): (eldoc-docstring-format-sym-doc): (eldoc-add-command, eldoc-add-command-completions): (eldoc-remove-command, eldoc-remove-command-completions): Add docstring. --- lisp/emacs-lisp/eldoc.el | 57 +++++++++++++++++++++++++++++++++++++--------- 1 files changed, 46 insertions(+), 11 deletions(-) diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index a05bd7c..9b4a2d4 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -160,6 +160,10 @@ eldoc-message-function It should receive the same arguments as `message'.") (defun eldoc-edit-message-commands () + "Return an obarray containing common editing commands. + +When `eldoc-print-after-edit' is non-nil, ElDoc messages are only +printed after commands contained in this obarray." (let ((cmds (make-vector 31 0)) (re (regexp-opt '("delete" "insert" "edit" "electric" "newline")))) (mapatoms (lambda (s) @@ -211,16 +215,21 @@ global-eldoc-mode ;;;###autoload (defun turn-on-eldoc-mode () - "Turn on `eldoc-mode' if the buffer has eldoc support enabled. + "Turn on `eldoc-mode' if the buffer has ElDoc support enabled. See `eldoc-documentation-function' for more detail." (when (eldoc--supported-p) (eldoc-mode 1))) (defun eldoc--supported-p () + "Non-nil if an ElDoc function is set for this buffer." (not (memq eldoc-documentation-function '(nil ignore)))) (defun eldoc-schedule-timer () + "Ensure `eldoc-timer' is running. + +If the user has changed `eldoc-idle-delay', update the timer to +reflect the change." (or (and eldoc-timer (memq eldoc-timer timer-idle-list)) ;FIXME: Why? (setq eldoc-timer @@ -229,8 +238,7 @@ eldoc-schedule-timer (lambda () (when (or eldoc-mode (and global-eldoc-mode - (not (memq eldoc-documentation-function - '(nil ignore))))) + (eldoc--supported-p))) (eldoc-print-current-symbol-info)))))) ;; If user has changed the idle delay, update the timer. @@ -268,16 +276,27 @@ eldoc-minibuffer-message (force-mode-line-update))) (apply 'message format-string args))) -(defun eldoc-message (&rest args) +(defun eldoc-message (&optional format-string &rest args) + "Store and possibly display FORMAT-STRING formatted with ARGS. + +FORMAT-STRING (or nil, if not given) is stored in +`eldoc-last-message'. If ARGS are given, FORMAT-STRING is first +formatted through `format-message'. + +If `eldoc-last-message' is non-nil, display it using +`eldoc-message-function'. If it is nil, clear the echo area if +there was recently a message from ElDoc there. + +Return `eldoc-last-message'." (let ((omessage eldoc-last-message)) (setq eldoc-last-message - (cond ((eq (car args) eldoc-last-message) eldoc-last-message) - ((null (car args)) nil) + (cond ((eq format-string eldoc-last-message) eldoc-last-message) + ((null format-string) nil) ;; If only one arg, no formatting to do, so put it in ;; eldoc-last-message so eq test above might succeed on ;; subsequent calls. - ((null (cdr args)) (car args)) - (t (apply #'format-message args)))) + ((null args) format-string) + (t (apply #'format-message format-string args)))) ;; In emacs 19.29 and later, and XEmacs 19.13 and later, all messages ;; are recorded in a log. Do not put eldoc messages in that log since ;; they are Legion. @@ -289,6 +308,7 @@ eldoc-message eldoc-last-message) (defun eldoc--message-command-p (command) + "Return non-nil if COMMAND is in `eldoc-message-commands'." (and (symbolp command) (intern-soft (symbol-name command) eldoc-message-commands))) @@ -299,6 +319,7 @@ eldoc--message-command-p ;; before the next command executes, which does away with the flicker. ;; This doesn't seem to be required for Emacs 19.28 and earlier. (defun eldoc-pre-command-refresh-echo-area () + "Reprint `eldoc-last-message' in the echo area." (and eldoc-last-message (not (minibufferp)) ;We don't use the echo area when in minibuffer. (if (and (eldoc-display-message-no-interference-p) @@ -310,6 +331,7 @@ eldoc-pre-command-refresh-echo-area ;; Decide whether now is a good time to display a message. (defun eldoc-display-message-p () + "Return non-nil when it is appropriate to display an ElDoc message." (and (eldoc-display-message-no-interference-p) ;; If this-command is non-nil while running via an idle ;; timer, we're still in the middle of executing a command, @@ -322,6 +344,7 @@ eldoc-display-message-p ;; Check various conditions about the current environment that might make ;; it undesirable to print eldoc messages right this instant. (defun eldoc-display-message-no-interference-p () + "Return nil if displaying a message would cause interference." (not (or executing-kbd-macro (bound-and-true-p edebug-active)))) @@ -347,6 +370,7 @@ eldoc-documentation-function return any documentation.") (defun eldoc-print-current-symbol-info () + "Print the text produced by `eldoc-documentation-function'." ;; This is run from post-command-hook or some idle timer thing, ;; so we need to be careful that errors aren't ignored. (with-demoted-errors "eldoc error: %s" @@ -361,6 +385,13 @@ eldoc-print-current-symbol-info ;; truncated or eliminated entirely from the output to make room for the ;; description. (defun eldoc-docstring-format-sym-doc (prefix doc &optional face) + "Combine PREFIX and DOC, and shorten the result to fit in the echo area. + +When PREFIX is a symbol, propertize its symbol name with FACE +before combining it with DOC. If FACE is not provided, just +apply the nil face. + +See also: `eldoc-echo-area-use-multiline-p'." (when (symbolp prefix) (setq prefix (concat (propertize (symbol-name prefix) 'face face) ": "))) (let* ((ea-multi eldoc-echo-area-use-multiline-p) @@ -390,22 +421,26 @@ eldoc-docstring-format-sym-doc ;; These functions do display-command table management. (defun eldoc-add-command (&rest cmds) + "Add each of CMDS to the obarray `eldoc-message-commands'." (dolist (name cmds) (and (symbolp name) (setq name (symbol-name name))) (set (intern name eldoc-message-commands) t))) (defun eldoc-add-command-completions (&rest names) + "Pass every prefix completion of NAMES to `eldoc-add-command'." (dolist (name names) (apply #'eldoc-add-command (all-completions name obarray 'commandp)))) (defun eldoc-remove-command (&rest cmds) + "Remove each of CMDS from the obarray `eldoc-message-commands'." (dolist (name cmds) (and (symbolp name) (setq name (symbol-name name))) (unintern name eldoc-message-commands))) (defun eldoc-remove-command-completions (&rest names) + "Pass every prefix completion of NAMES to `eldoc-remove-command'." (dolist (name names) (apply #'eldoc-remove-command (all-completions name eldoc-message-commands)))) @@ -418,9 +453,9 @@ eldoc-remove-command-completions "down-list" "end-of-" "exchange-point-and-mark" "forward-" "goto-" "handle-select-window" "indent-for-tab-command" "left-" "mark-page" "mark-paragraph" "mouse-set-point" "move-" "move-beginning-of-" - "move-end-of-" "newline" "next-" "other-window" "pop-global-mark" "previous-" - "recenter" "right-" "scroll-" "self-insert-command" "split-window-" - "up-list") + "move-end-of-" "newline" "next-" "other-window" "pop-global-mark" + "previous-" "recenter" "right-" "scroll-" "self-insert-command" + "split-window-" "up-list") (provide 'eldoc) -- 1.7.4.4 --------------2FA1671CC8167200B143813B-- From debbugs-submit-bounces@debbugs.gnu.org Sun Jun 25 21:04:28 2017 Received: (at 27230) by debbugs.gnu.org; 26 Jun 2017 01:04:28 +0000 Received: from localhost ([127.0.0.1]:37814 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dPIS4-00024T-EK for submit@debbugs.gnu.org; Sun, 25 Jun 2017 21:04:28 -0400 Received: from mail-wr0-f181.google.com ([209.85.128.181]:36067) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dPIS2-00024C-Q8 for 27230@debbugs.gnu.org; Sun, 25 Jun 2017 21:04:27 -0400 Received: by mail-wr0-f181.google.com with SMTP id c11so132247252wrc.3 for <27230@debbugs.gnu.org>; Sun, 25 Jun 2017 18:04:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=H2gd39S/6eIwmXWYHRVrlg8tGHrp25fx+rYv52hgREE=; b=uw1g0lekYAJU+pAVuGboU2CMSk0oOLaj0ejxtw2vgIUw2eal1+YypjJZrbUhLCE1fi gMNPFP6XHpExp6JG2IURQHn3jHiW2cq6pJK8OiJjIgdb8YLGdiu3zSZDds462jz9Z62g ABZRD/WmARBHe74Vjt2BzonS053GfhPO1GT9uUZ+Qh4yv0o1lbatiPDvd/ODcxRFYgpf WO7JaQ8qEYUgdEowdcbjvoO7SeLlms8mmX98vmGVk1Xzb1KbT6YnygCSXx90M1pGfGKJ FeRiA5WkJa2/oYeizfV6M0PTJh9Rl1KLAw1VPGFKRh4YYXT2d5srx23y2K/PpkKgV7Uj uw6A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:subject:to:cc:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=H2gd39S/6eIwmXWYHRVrlg8tGHrp25fx+rYv52hgREE=; b=aXwNzwJHycrGdACVoUXQSJIGhsIfFGWRERXp5tS8tqlfhsR4x37iqn6jSm5ct6im16 sKaDkxrMB1NKLO+bMZA7ezANke+g0mSpAZzkF4jtAL3Z32FEqgdTbCR72BpJNDiPIVYm f3KzRuo8sYbyzWqIkUD0pfO+rC4HfftMOQrPXEjSfjl17Lc3Y0X8OIVAlSLxvbqHYpPH l3faL/CvEfcNlj2SsohVrshPAmEaTDTilu0ZSI+r+FcUNZNcXKOAh8L7fS7U+49Mvthu 9HxJQPF/ggjlOLarTFcn1+g/1C8mVvC1o/QLz+L9ObeDgHbNuvR6qSIU3SMcSTypOwZy lmhg== X-Gm-Message-State: AKS2vOxjqGKwsPdOLp87shbS5oaJZRFuUcnlSWz4ef+6bXURKLS8x3A9 uA5tpuN7hlSYwBYMSB0= X-Received: by 10.28.194.68 with SMTP id s65mr11478150wmf.121.1498439060534; Sun, 25 Jun 2017 18:04:20 -0700 (PDT) Received: from [192.168.1.3] ([185.105.174.193]) by smtp.googlemail.com with ESMTPSA id w197sm10742544wme.20.2017.06.25.18.04.19 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 25 Jun 2017 18:04:19 -0700 (PDT) Subject: Re: bug#27230: eldoc doc To: "Charles A. Roelli" , Eli Zaretskii References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> From: Dmitry Gutov Message-ID: <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> Date: Mon, 26 Jun 2017 04:04:18 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:54.0) Gecko/20100101 Thunderbird/54.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=windows-1252; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Score: -2.1 (--) X-Debbugs-Envelope-To: 27230 Cc: 27230@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.1 (--) On 6/25/17 10:47 PM, Charles A. Roelli wrote: > FORMAT-STRING (or nil, if not given) is stored in > `eldoc-last-message'. If ARGS are given, FORMAT-STRING is first > formatted through `format-message'. I wonder if we ever call this function with more than one argument. If not, the code and the doc call for simplification. We can avoid advertising this possibility, at least. > If `eldoc-last-message' is non-nil, display it using > `eldoc-message-function'. If it is nil, clear the echo area if > there was recently a message from ElDoc there. I think this needlessly prioritizes the implementation over the intention. And the latter is to display whatever the documentation function returns (if non-nil). Saving to eldoc-last-message is secondary, and can be mentioned later. > Return `eldoc-last-message'." This is probably non-essential, and we can avoid mentioning it. From debbugs-submit-bounces@debbugs.gnu.org Tue Jun 27 15:51:58 2017 Received: (at 27230) by debbugs.gnu.org; 27 Jun 2017 19:51:58 +0000 Received: from localhost ([127.0.0.1]:41189 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dPwWk-0007SR-1q for submit@debbugs.gnu.org; Tue, 27 Jun 2017 15:51:58 -0400 Received: from sinyavsky.aurox.ch ([37.35.109.145]:51580) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dPwWi-0007SG-Jq for 27230@debbugs.gnu.org; Tue, 27 Jun 2017 15:51:57 -0400 Received: from sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) by sinyavsky.aurox.ch (Postfix) with ESMTP id 0285922485 for <27230@debbugs.gnu.org>; Tue, 27 Jun 2017 19:46:53 +0000 (UTC) Authentication-Results: sinyavsky.aurox.ch (amavisd-new); dkim=pass (1024-bit key) reason="pass (just generated, assumed good)" header.d=aurox.ch DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=aurox.ch; h= content-transfer-encoding:content-type:content-type:in-reply-to :mime-version:user-agent:date:date:message-id:from:from :references:to:subject:subject; s=dkim; t=1498592811; x= 1499456812; bh=wqcSKaikWDlIr+fgwaXMzLn015sFl2byPuVr+aC4jqU=; b=v V7GLjF4+1El0OCyo0t8N04+4vLPlWP9EgltW91y9Aw44wU+OZ3u8LRfwr+5EbN/k sltrUhC9ZU1ofFLIH5DZSaHANJHJeAA6eJ8f0xceavYkDvFRViUTYFSJEYIehi6/ Y72nkYxaVCSEassuhaF26aQ+CcV38FiY8mAfmYn0Xg= X-Virus-Scanned: Debian amavisd-new at test.virtualizor.com Received: from sinyavsky.aurox.ch ([127.0.0.1]) by sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id P8LSySK1AbJT for <27230@debbugs.gnu.org>; Tue, 27 Jun 2017 19:46:51 +0000 (UTC) Received: from [192.168.1.120] (125.85.192.178.dynamic.wline.res.cust.swisscom.ch [178.192.85.125]) by sinyavsky.aurox.ch (Postfix) with ESMTPSA id 6484422443; Tue, 27 Jun 2017 19:46:47 +0000 (UTC) Subject: Re: bug#27230: eldoc doc To: Dmitry Gutov , Eli Zaretskii References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> From: "Charles A. Roelli" Message-ID: <989c1d30-2eb4-41d3-e7a3-228ce365a69c@aurox.ch> Date: Tue, 27 Jun 2017 21:51:44 +0200 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.6; rv:45.0) Gecko/20100101 Thunderbird/45.8.0 MIME-Version: 1.0 In-Reply-To: <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> Content-Type: text/plain; charset=windows-1252; format=flowed Content-Transfer-Encoding: 7bit X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 27230 Cc: 27230@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.7 (/) On 26/06/2017 03:04, Dmitry Gutov wrote: > On 6/25/17 10:47 PM, Charles A. Roelli wrote: > >> FORMAT-STRING (or nil, if not given) is stored in >> `eldoc-last-message'. If ARGS are given, FORMAT-STRING is first >> formatted through `format-message'. > > I wonder if we ever call this function with more than one argument. If > not, the code and the doc call for simplification. We can avoid > advertising this possibility, at least. I think it follows the tradition of other *-message functions, which normally use the calling convention of `message'/`format-message'. > >> If `eldoc-last-message' is non-nil, display it using >> `eldoc-message-function'. If it is nil, clear the echo area if >> there was recently a message from ElDoc there. > > I think this needlessly prioritizes the implementation over the > intention. And the latter is to display whatever the documentation > function returns (if non-nil). Saving to eldoc-last-message is > secondary, and can be mentioned later. Agreed. Can you suggest how to word it? Here's what I come up with: "Display FORMAT-STRING formatted with ARGS as an ElDoc message. Store the message (if any) in `eldoc-last-message', and return it." > >> Return `eldoc-last-message'." > > This is probably non-essential, and we can avoid mentioning it. I think it once again follows the convention of other *-message functions, probably for consistency. From debbugs-submit-bounces@debbugs.gnu.org Tue Jun 27 19:50:35 2017 Received: (at 27230) by debbugs.gnu.org; 27 Jun 2017 23:50:35 +0000 Received: from localhost ([127.0.0.1]:41282 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dQ0Ff-0004nd-4L for submit@debbugs.gnu.org; Tue, 27 Jun 2017 19:50:35 -0400 Received: from mail-wm0-f47.google.com ([74.125.82.47]:38485) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dQ0Fd-0004nL-Ji for 27230@debbugs.gnu.org; Tue, 27 Jun 2017 19:50:33 -0400 Received: by mail-wm0-f47.google.com with SMTP id b184so42015946wme.1 for <27230@debbugs.gnu.org>; Tue, 27 Jun 2017 16:50:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=9ev+wNdwpJHX/uMKvZ/oV4kJInlt/aq5m6YnA9YHooA=; b=CX8C1u2nCamtw9mM4kS2GIm4J2veTLqppOvsJjeubtVuWLr9e1oY2lHRVEAciI0zJN st+PTRXmf/W7LGwLFL2Z927xtK36iNXsAp+XX+GIgeEEIbLawCesiolXOxQVDSgWzTQp 5OuFAhaA5gW4p3IzMqomBnreXVYL/PWslzn5ek0GQpPRjEnOtMyRvtjV/TrqT9IyFZ+R phVLJhMl/dkNSiE98/03wAwEJFGAi6zOvMnO7GUaaPEA5qsta4hOxn1GdvP2Spfi1XXh obePSH3yEJk+guSTDy9hFWuKFDBMIYzQuwPGJZ6a+feZFmMgkXzUPE0n5YIo7tLlBGtH zTnw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:subject:to:cc:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=9ev+wNdwpJHX/uMKvZ/oV4kJInlt/aq5m6YnA9YHooA=; b=fDI0DT2ziSyXkmsc3LaUjFxAdNnQUT2DjuiE4eZHuELoWHeORKNcmYhO5CWTIo3wt7 so5lEj12iPuwwAkppiDNE4lyNWL7nkMyf8FIZ2e2MRZt+4atkvZwuKqs74YkUpiqqLQy JzxknZdguMGm9JLr+Qvk517rK8meJBD5SzrLD5g9B1Tr7nL+mADI/rgUM8Fk2o8PSI2X qA0Th3O3I9dOkKDy+TgqxRtKNd+caEs8Vsk+Wotz5+wgfHfq8F3QUHraQxXLTjSX7MiT 0oIGgOA5D6z4rtgVC0inofBy3orGA58xhs2tWGvtRHkba12tS+sibMmznZlrx1TyFF4r IW+g== X-Gm-Message-State: AKS2vOxwdT0bT/cuXVdhIebSE3KJldjyagta57RTY8xTLGrTTLIVRifs /gtQrxNK+Ml/BeQjOxQ= X-Received: by 10.28.18.201 with SMTP id 192mr5013332wms.2.1498607427523; Tue, 27 Jun 2017 16:50:27 -0700 (PDT) Received: from [192.168.1.3] ([185.105.174.193]) by smtp.googlemail.com with ESMTPSA id t204sm4128187wme.2.2017.06.27.16.50.25 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 27 Jun 2017 16:50:26 -0700 (PDT) Subject: Re: bug#27230: eldoc doc To: "Charles A. Roelli" , Eli Zaretskii References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> <989c1d30-2eb4-41d3-e7a3-228ce365a69c@aurox.ch> From: Dmitry Gutov Message-ID: Date: Wed, 28 Jun 2017 02:50:24 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:54.0) Gecko/20100101 Thunderbird/54.0 MIME-Version: 1.0 In-Reply-To: <989c1d30-2eb4-41d3-e7a3-228ce365a69c@aurox.ch> Content-Type: text/plain; charset=windows-1252; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Score: 0.7 (/) X-Debbugs-Envelope-To: 27230 Cc: 27230@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.7 (/) On 6/27/17 10:51 PM, Charles A. Roelli wrote: > I think it follows the tradition of other *-message functions, which > normally use the calling convention of `message'/`format-message'. Do we really need a function in "the tradition of other *-message functions" if we don't ever use it like that? > Agreed. Can you suggest how to word it? Here's what I come up with: > > "Display FORMAT-STRING formatted with ARGS as an ElDoc message. > > Store the message (if any) in `eldoc-last-message', and return it." Looks okay to me, aside from what I mentioned above. >>> Return `eldoc-last-message'." >> >> This is probably non-essential, and we can avoid mentioning it. > > I think it once again follows the convention of other *-message > functions, probably for consistency. Yeah, ok. From debbugs-submit-bounces@debbugs.gnu.org Wed Jun 28 15:16:48 2017 Received: (at 27230) by debbugs.gnu.org; 28 Jun 2017 19:16:48 +0000 Received: from localhost ([127.0.0.1]:43004 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dQISG-0003IS-CE for submit@debbugs.gnu.org; Wed, 28 Jun 2017 15:16:48 -0400 Received: from sinyavsky.aurox.ch ([37.35.109.145]:52394) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dQISD-0003IF-SD for 27230@debbugs.gnu.org; Wed, 28 Jun 2017 15:16:46 -0400 Received: from sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) by sinyavsky.aurox.ch (Postfix) with ESMTP id 4D91E22494 for <27230@debbugs.gnu.org>; Wed, 28 Jun 2017 19:11:41 +0000 (UTC) Authentication-Results: sinyavsky.aurox.ch (amavisd-new); dkim=pass (1024-bit key) reason="pass (just generated, assumed good)" header.d=aurox.ch DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=aurox.ch; h= content-type:content-type:in-reply-to:mime-version:user-agent :date:date:message-id:from:from:references:to:subject:subject; s=dkim; t=1498677098; x=1499541099; bh=WebaAnRHHDpur7CPA2UP2sLm o4NrOu9WlhzRqEgTAww=; b=EQ6afMONFJrUyDfpmzPTh97VKtW15Zwnmh2vpboB 1n5ZZpZ3moTWJSBqX+IaJg/q+RrvoW2oxy6PzPtONeif8f25XQj26cLi6kgrh5tj QyvN9exPHlXCbPFkas8zxHBEsQhraTcsjNrABC+hnJwRHNTrc7zDnJrBCpD3uCf7 C1g= X-Virus-Scanned: Debian amavisd-new at test.virtualizor.com Received: from sinyavsky.aurox.ch ([127.0.0.1]) by sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id 2vurwsL5XEl2 for <27230@debbugs.gnu.org>; Wed, 28 Jun 2017 19:11:38 +0000 (UTC) Received: from [192.168.1.120] (125.85.192.178.dynamic.wline.res.cust.swisscom.ch [178.192.85.125]) by sinyavsky.aurox.ch (Postfix) with ESMTPSA id 6247E22454; Wed, 28 Jun 2017 19:11:34 +0000 (UTC) Subject: Re: bug#27230: eldoc doc To: Dmitry Gutov , Eli Zaretskii References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> <989c1d30-2eb4-41d3-e7a3-228ce365a69c@aurox.ch> From: "Charles A. Roelli" Message-ID: Date: Wed, 28 Jun 2017 21:16:32 +0200 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.6; rv:45.0) Gecko/20100101 Thunderbird/45.8.0 MIME-Version: 1.0 In-Reply-To: Content-Type: multipart/mixed; boundary="------------98426136A3A9AFE6AB853C5D" X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 27230 Cc: 27230@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.7 (/) This is a multi-part message in MIME format. --------------98426136A3A9AFE6AB853C5D Content-Type: text/plain; charset=windows-1252; format=flowed Content-Transfer-Encoding: 7bit On 28/06/2017 01:50, Dmitry Gutov wrote: > On 6/27/17 10:51 PM, Charles A. Roelli wrote: > >> I think it follows the tradition of other *-message functions, which >> normally use the calling convention of `message'/`format-message'. > > Do we really need a function in "the tradition of other *-message > functions" if we don't ever use it like that? I don't know. It might be helpful in the future, and it makes sense to follow the existing convention even if we don't make use of it yet (patch v3 attached). --------------98426136A3A9AFE6AB853C5D Content-Type: text/x-patch; name="0001-ElDoc-add-docstrings-and-minor-refactoring-v3.patch" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename*0="0001-ElDoc-add-docstrings-and-minor-refactoring-v3.patch" >From 078f0a28c22708c73b8362b3d19fe4679f5f1a00 Mon Sep 17 00:00:00 2001 From: Charles A. Roelli Date: Thu, 22 Jun 2017 21:04:09 +0200 Subject: [PATCH] ElDoc: add docstrings and minor refactoring * lisp/emacs-lisp/eldoc.el (eldoc-edit-message-commands): Add docstring. (turn-on-eldoc-mode): Fix capitalization. (eldoc--supported-p): Add docstring. (eldoc-schedule-timer): Add docstring and use 'eldoc--supported-p'. (eldoc-message): Add docstring and make calling convention clearer. (eldoc--message-command-p): (eldoc-pre-command-refresh-echo-area): (eldoc-display-message-p): (eldoc-display-message-no-interference-p): (eldoc-print-current-symbol-info): (eldoc-docstring-format-sym-doc): (eldoc-add-command, eldoc-add-command-completions): (eldoc-remove-command, eldoc-remove-command-completions): Add docstring. --- lisp/emacs-lisp/eldoc.el | 49 +++++++++++++++++++++++++++++++++++---------- 1 files changed, 38 insertions(+), 11 deletions(-) diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index a05bd7c..bca40ab 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -160,6 +160,10 @@ eldoc-message-function It should receive the same arguments as `message'.") (defun eldoc-edit-message-commands () + "Return an obarray containing common editing commands. + +When `eldoc-print-after-edit' is non-nil, ElDoc messages are only +printed after commands contained in this obarray." (let ((cmds (make-vector 31 0)) (re (regexp-opt '("delete" "insert" "edit" "electric" "newline")))) (mapatoms (lambda (s) @@ -211,16 +215,21 @@ global-eldoc-mode ;;;###autoload (defun turn-on-eldoc-mode () - "Turn on `eldoc-mode' if the buffer has eldoc support enabled. + "Turn on `eldoc-mode' if the buffer has ElDoc support enabled. See `eldoc-documentation-function' for more detail." (when (eldoc--supported-p) (eldoc-mode 1))) (defun eldoc--supported-p () + "Non-nil if an ElDoc function is set for this buffer." (not (memq eldoc-documentation-function '(nil ignore)))) (defun eldoc-schedule-timer () + "Ensure `eldoc-timer' is running. + +If the user has changed `eldoc-idle-delay', update the timer to +reflect the change." (or (and eldoc-timer (memq eldoc-timer timer-idle-list)) ;FIXME: Why? (setq eldoc-timer @@ -229,8 +238,7 @@ eldoc-schedule-timer (lambda () (when (or eldoc-mode (and global-eldoc-mode - (not (memq eldoc-documentation-function - '(nil ignore))))) + (eldoc--supported-p))) (eldoc-print-current-symbol-info)))))) ;; If user has changed the idle delay, update the timer. @@ -268,16 +276,19 @@ eldoc-minibuffer-message (force-mode-line-update))) (apply 'message format-string args))) -(defun eldoc-message (&rest args) +(defun eldoc-message (&optional format-string &rest args) + "Display FORMAT-STRING formatted with ARGS as an ElDoc message. + +Store the message (if any) in `eldoc-last-message', and return it." (let ((omessage eldoc-last-message)) (setq eldoc-last-message - (cond ((eq (car args) eldoc-last-message) eldoc-last-message) - ((null (car args)) nil) + (cond ((eq format-string eldoc-last-message) eldoc-last-message) + ((null format-string) nil) ;; If only one arg, no formatting to do, so put it in ;; eldoc-last-message so eq test above might succeed on ;; subsequent calls. - ((null (cdr args)) (car args)) - (t (apply #'format-message args)))) + ((null args) format-string) + (t (apply #'format-message format-string args)))) ;; In emacs 19.29 and later, and XEmacs 19.13 and later, all messages ;; are recorded in a log. Do not put eldoc messages in that log since ;; they are Legion. @@ -289,6 +300,7 @@ eldoc-message eldoc-last-message) (defun eldoc--message-command-p (command) + "Return non-nil if COMMAND is in `eldoc-message-commands'." (and (symbolp command) (intern-soft (symbol-name command) eldoc-message-commands))) @@ -299,6 +311,7 @@ eldoc--message-command-p ;; before the next command executes, which does away with the flicker. ;; This doesn't seem to be required for Emacs 19.28 and earlier. (defun eldoc-pre-command-refresh-echo-area () + "Reprint `eldoc-last-message' in the echo area." (and eldoc-last-message (not (minibufferp)) ;We don't use the echo area when in minibuffer. (if (and (eldoc-display-message-no-interference-p) @@ -310,6 +323,7 @@ eldoc-pre-command-refresh-echo-area ;; Decide whether now is a good time to display a message. (defun eldoc-display-message-p () + "Return non-nil when it is appropriate to display an ElDoc message." (and (eldoc-display-message-no-interference-p) ;; If this-command is non-nil while running via an idle ;; timer, we're still in the middle of executing a command, @@ -322,6 +336,7 @@ eldoc-display-message-p ;; Check various conditions about the current environment that might make ;; it undesirable to print eldoc messages right this instant. (defun eldoc-display-message-no-interference-p () + "Return nil if displaying a message would cause interference." (not (or executing-kbd-macro (bound-and-true-p edebug-active)))) @@ -347,6 +362,7 @@ eldoc-documentation-function return any documentation.") (defun eldoc-print-current-symbol-info () + "Print the text produced by `eldoc-documentation-function'." ;; This is run from post-command-hook or some idle timer thing, ;; so we need to be careful that errors aren't ignored. (with-demoted-errors "eldoc error: %s" @@ -361,6 +377,13 @@ eldoc-print-current-symbol-info ;; truncated or eliminated entirely from the output to make room for the ;; description. (defun eldoc-docstring-format-sym-doc (prefix doc &optional face) + "Combine PREFIX and DOC, and shorten the result to fit in the echo area. + +When PREFIX is a symbol, propertize its symbol name with FACE +before combining it with DOC. If FACE is not provided, just +apply the nil face. + +See also: `eldoc-echo-area-use-multiline-p'." (when (symbolp prefix) (setq prefix (concat (propertize (symbol-name prefix) 'face face) ": "))) (let* ((ea-multi eldoc-echo-area-use-multiline-p) @@ -390,22 +413,26 @@ eldoc-docstring-format-sym-doc ;; These functions do display-command table management. (defun eldoc-add-command (&rest cmds) + "Add each of CMDS to the obarray `eldoc-message-commands'." (dolist (name cmds) (and (symbolp name) (setq name (symbol-name name))) (set (intern name eldoc-message-commands) t))) (defun eldoc-add-command-completions (&rest names) + "Pass every prefix completion of NAMES to `eldoc-add-command'." (dolist (name names) (apply #'eldoc-add-command (all-completions name obarray 'commandp)))) (defun eldoc-remove-command (&rest cmds) + "Remove each of CMDS from the obarray `eldoc-message-commands'." (dolist (name cmds) (and (symbolp name) (setq name (symbol-name name))) (unintern name eldoc-message-commands))) (defun eldoc-remove-command-completions (&rest names) + "Pass every prefix completion of NAMES to `eldoc-remove-command'." (dolist (name names) (apply #'eldoc-remove-command (all-completions name eldoc-message-commands)))) @@ -418,9 +445,9 @@ eldoc-remove-command-completions "down-list" "end-of-" "exchange-point-and-mark" "forward-" "goto-" "handle-select-window" "indent-for-tab-command" "left-" "mark-page" "mark-paragraph" "mouse-set-point" "move-" "move-beginning-of-" - "move-end-of-" "newline" "next-" "other-window" "pop-global-mark" "previous-" - "recenter" "right-" "scroll-" "self-insert-command" "split-window-" - "up-list") + "move-end-of-" "newline" "next-" "other-window" "pop-global-mark" + "previous-" "recenter" "right-" "scroll-" "self-insert-command" + "split-window-" "up-list") (provide 'eldoc) -- 1.7.4.4 --------------98426136A3A9AFE6AB853C5D-- From debbugs-submit-bounces@debbugs.gnu.org Sun Jul 16 22:19:28 2017 Received: (at control) by debbugs.gnu.org; 17 Jul 2017 02:19:28 +0000 Received: from localhost ([127.0.0.1]:42978 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dWvdA-0001gU-3v for submit@debbugs.gnu.org; Sun, 16 Jul 2017 22:19:28 -0400 Received: from mail-io0-f172.google.com ([209.85.223.172]:35254) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dWvd8-0001gI-C0 for control@debbugs.gnu.org; Sun, 16 Jul 2017 22:19:26 -0400 Received: by mail-io0-f172.google.com with SMTP id h134so36459297iof.2 for ; Sun, 16 Jul 2017 19:19:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:subject:date:message-id:mime-version; bh=uFT1wfAUGairhPNSI5ZNiQnDD0qCdgv2SVVh/BVJisw=; b=d3/T03aKzqZz4+7Eu+MqGS43cyeZQfChCf4ZKqRiVIC9giogHSQwkcdJji11A5jY3n ieiMVMgXNrlwnCmuE0WkzmwkSBfWBYz10gQvXhMszPj2U2/bP/RDt8WpZa5z5z0VAzOh lP0uVhga2puWI0dfeRZoD1v4gIbqAB7dm80a1f77rGQI9Vzc9VjLbrZqtK+xyLvI9d5J zM7NN84VN8dqeZIG2zRAHOZlRpkS+evVkvFGv20gue/ZUc3MX/LDBxBgUdbLulzp04vm /k/N/Ry/qvZAHKYavGC5mmIG1Bs28o9WXwLkFInI89gIryKxZTajRYwOnaDPVOCpey8M bVng== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:subject:date:message-id :mime-version; bh=uFT1wfAUGairhPNSI5ZNiQnDD0qCdgv2SVVh/BVJisw=; b=E9y75v7n2AVuu8OxYQx81bzjoOJ4UKFB8+Ee+4cbRid+lHtPErkj7eMAwqTw34mCK5 VjqemRF+YryUi3ZZu2eABPkkqZRc57RwVqsgcBTcdM4/8PrQpPiaLVbKTwmp+OFOmK7q LndZtw9RkweWRX0Ubgig9g/PQFyC4RmJWWyhXllDZElFnx91ksHv9isKebNyZnp9YFT5 r93RvAwHkASXN2SGS8ZY0/V6iQzOBWMIjz0E9sedlHK0BJ9x3K3OmAn2qClTMzkTI/49 ngGxDwcKhH6vYg09jswgeSV4d9pSpg1+E9Gfez+Ek81BV0P+WM+ek3gTPvSo7z+CcNit sKHA== X-Gm-Message-State: AIVw113DqKRtaWIeXczb0mti+r5Mo6LHwbYDj3ojLCBUNecpfsCKQr4V mWGLQG+5F5wshTfw X-Received: by 10.107.131.9 with SMTP id f9mr17738074iod.225.1500257960836; Sun, 16 Jul 2017 19:19:20 -0700 (PDT) Received: from zony ([45.2.7.65]) by smtp.googlemail.com with ESMTPSA id l189sm5164536itl.21.2017.07.16.19.19.20 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Sun, 16 Jul 2017 19:19:20 -0700 (PDT) From: npostavs@users.sourceforge.net To: control@debbugs.gnu.org Subject: control message for bug #27230 Date: Sun, 16 Jul 2017 22:20:54 -0400 Message-ID: <877ez7by7t.fsf@users.sourceforge.net> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: -2.1 (--) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.1 (--) tags 27230 + patch user emacs usertag 27230 documentation quit From debbugs-submit-bounces@debbugs.gnu.org Sat Jul 22 04:12:01 2017 Received: (at 27230-done) by debbugs.gnu.org; 22 Jul 2017 08:12:01 +0000 Received: from localhost ([127.0.0.1]:51824 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dYpW4-00065R-Sc for submit@debbugs.gnu.org; Sat, 22 Jul 2017 04:12:01 -0400 Received: from eggs.gnu.org ([208.118.235.92]:60455) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dYpW3-00065A-HW for 27230-done@debbugs.gnu.org; Sat, 22 Jul 2017 04:11:59 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dYpVv-0008MC-6o for 27230-done@debbugs.gnu.org; Sat, 22 Jul 2017 04:11:54 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,RP_MATCHES_RCVD autolearn=disabled version=3.3.2 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:41982) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dYpVv-0008Lw-3h; Sat, 22 Jul 2017 04:11:51 -0400 Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:3325 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1dYpVt-00033v-Iu; Sat, 22 Jul 2017 04:11:50 -0400 Date: Sat, 22 Jul 2017 11:11:44 +0300 Message-Id: <83bmocao1r.fsf@gnu.org> From: Eli Zaretskii To: "Charles A. Roelli" In-reply-to: (charles@aurox.ch) Subject: Re: bug#27230: eldoc doc References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> <989c1d30-2eb4-41d3-e7a3-228ce365a69c@aurox.ch> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-Spam-Score: -7.8 (-------) X-Debbugs-Envelope-To: 27230-done Cc: 27230-done@debbugs.gnu.org, dgutov@yandex.ru X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Eli Zaretskii Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -7.8 (-------) > Cc: 27230@debbugs.gnu.org > From: "Charles A. Roelli" > Date: Wed, 28 Jun 2017 21:16:32 +0200 > > (patch v3 attached). Thanks, pushed. In the future, please mention the bug number in the commit log message, so that whoever pushes the changes won't need to do that by hand. From unknown Sat Aug 16 11:33:53 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Sat, 19 Aug 2017 11:24:04 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator From debbugs-submit-bounces@debbugs.gnu.org Thu Sep 14 07:42:27 2017 Received: (at control) by debbugs.gnu.org; 14 Sep 2017 11:42:27 +0000 Received: from localhost ([127.0.0.1]:39765 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dsSXK-00042T-UE for submit@debbugs.gnu.org; Thu, 14 Sep 2017 07:42:27 -0400 Received: from hermes.netfonds.no ([80.91.224.195]:46942) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dsSXJ-00042K-Ja for control@debbugs.gnu.org; Thu, 14 Sep 2017 07:42:26 -0400 Received: from luna.netfonds.no ([80.91.225.79]) by hermes.netfonds.no with esmtp (Exim 4.84_2) (envelope-from ) id 1dsSXG-0007yz-Tz; Thu, 14 Sep 2017 13:42:24 +0200 Received: by luna.netfonds.no (Postfix, from userid 547) id 040F94E00A4; Thu, 14 Sep 2017 13:42:23 +0200 (CEST) From: peder@klingenberg.no (Peder O. Klingenberg) To: control@debbugs.gnu.org Organization: Persons in a Position to Know, inc. Date: Thu, 14 Sep 2017 13:42:22 +0200 Message-ID: User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.0.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 2.0 (++) X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.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 the administrator of that system for details. Content preview: unarchive 27230 [...] Content analysis details: (2.0 points, 10.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at http://www.dnswl.org/, no trust [80.91.224.195 listed in list.dnswl.org] 0.0 HEADER_FROM_DIFFERENT_DOMAINS From and EnvelopeFrom 2nd level mail domains are different -0.0 RP_MATCHES_RCVD Envelope sender domain matches handover relay domain 1.8 MISSING_SUBJECT Missing Subject: header 0.2 NO_SUBJECT Extra score for no subject X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 2.0 (++) X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.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 the administrator of that system for details. Content preview: unarchive 27230 [...] Content analysis details: (2.0 points, 10.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at http://www.dnswl.org/, no trust [80.91.224.195 listed in list.dnswl.org] 0.0 HEADER_FROM_DIFFERENT_DOMAINS From and EnvelopeFrom 2nd level mail domains are different -0.0 RP_MATCHES_RCVD Envelope sender domain matches handover relay domain 0.0 TVD_SPACE_RATIO No description available. 1.8 MISSING_SUBJECT Missing Subject: header 0.2 NO_SUBJECT Extra score for no subject unarchive 27230 From debbugs-submit-bounces@debbugs.gnu.org Thu Sep 14 07:47:32 2017 Received: (at 27230) by debbugs.gnu.org; 14 Sep 2017 11:47:32 +0000 Received: from localhost ([127.0.0.1]:39781 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dsScF-000622-QT for submit@debbugs.gnu.org; Thu, 14 Sep 2017 07:47:31 -0400 Received: from hermes.netfonds.no ([80.91.224.195]:47046) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dsScE-00061v-Cp for 27230@debbugs.gnu.org; Thu, 14 Sep 2017 07:47:30 -0400 Received: from luna.netfonds.no ([80.91.225.79]) by hermes.netfonds.no with esmtp (Exim 4.84_2) (envelope-from ) id 1dsScB-0005ZH-6O; Thu, 14 Sep 2017 13:47:28 +0200 Received: by luna.netfonds.no (Postfix, from userid 547) id 46C124E00A4; Thu, 14 Sep 2017 13:47:27 +0200 (CEST) To: Dmitry Gutov Subject: Re: bug#27230: eldoc doc References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> MIME-Version: 1.0 Content-Type: text/plain ...Peder...From: pok@netfonds.no (Peder O. Klingenberg) From: pok@netfonds.no (Peder O. Klingenberg) Date: Thu, 14 Sep 2017 13:47:27 +0200 In-Reply-To: <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> (Dmitry Gutov's message of "Mon, 26 Jun 2017 04:04:18 +0300") Message-ID: User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.0.50 (gnu/linux) X-Spam-Score: -0.0 (/) X-Debbugs-Envelope-To: 27230 Cc: Eli Zaretskii , "Charles A. Roelli" , 27230@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.0 (/) On Mon, Jun 26 2017 at 04:04, Dmitry Gutov wrote: > On 6/25/17 10:47 PM, Charles A. Roelli wrote: > >> FORMAT-STRING (or nil, if not given) is stored in >> `eldoc-last-message'. If ARGS are given, FORMAT-STRING is first >> formatted through `format-message'. > > I wonder if we ever call this function with more than one argument. If > not, the code and the doc call for simplification. We can avoid > advertising this possibility, at least. As I discovered today, when I updated my tree, there are callers outside emacs core that do call eldoc-message with more than one argument. slime-autodoc.el is one such package, which I use. The slime project has an open issue on this, with a patch, but it hasn't been applied yet, after sitting in the discussion for 17 days. IMO commit 7ef0b5f611c2d56ac2edb8de287190f04c4b8f32 was an ill-advised change. The code worked fine before, the cleanup afforded by breaking the api was negligible. I think it should be reverted. (Slime would benefit from cleaing up their callers as well, no doubt, but not every slime user should be forced to do that on their own. And there may be more third-party, infrequently maintained packages using eldoc.) ...Peder... -- This must be Thursday. I never could get the hang of Thursdays. From debbugs-submit-bounces@debbugs.gnu.org Thu Sep 14 08:02:23 2017 Received: (at 27230) by debbugs.gnu.org; 14 Sep 2017 12:02:23 +0000 Received: from localhost ([127.0.0.1]:39850 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dsSqd-0006RH-9I for submit@debbugs.gnu.org; Thu, 14 Sep 2017 08:02:23 -0400 Received: from mail-lf0-f51.google.com ([209.85.215.51]:43720) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dsSqb-0006R5-Pp for 27230@debbugs.gnu.org; Thu, 14 Sep 2017 08:02:22 -0400 Received: by mail-lf0-f51.google.com with SMTP id c80so7527065lfh.0 for <27230@debbugs.gnu.org>; Thu, 14 Sep 2017 05:02:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=uwvZc4rYp2q11RpErcyM4H8wBGWAems99Vx9BEaU11M=; b=tR8hu3nt1lQCGqCcCsCxKA+kdkj1n5/qArIypVpop4eAvlscTGBM/Rq2d1YZTorMRj bgSXXPaJFv/M/0yFwTt2ok2eXpTrfOjwjurzGmlZw6CXgvfNvq3gtZmaWyMQ7SBFKYRj mbPv0HBfY5CvP50xdWYPbwVnikgVCvAH8J5N3yvHtmRnklW0mDP/fVIpxuxe9KkSAAVQ mOnV4GnHdMUghVHCEkJcBZYHvoE9Hcx96M3cfxJbF4rwRAxW7BYerx1pZn/54wIssiqy TEjYDq2p8otD75bQzcW6wURN1LOrbwIoXHDD7SUSOl8apaR/lWyOluDSNUSBIEbE78oS hntA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:subject:to:cc:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=uwvZc4rYp2q11RpErcyM4H8wBGWAems99Vx9BEaU11M=; b=sqt6zqEEYeF6RkQD9zXYD9Ine9cp6EpvweGtuhX/0q1POpX7A1NmeiwO8qVy4V+5t+ 9hzkuKzvCI/4M5cWw8TX2HBrQLv9ihY1EvZrXZqy8IMRVr6fYaUla0IQxOtuR8VKVyOJ yxKjsett+U8D6gY7jw6/NWmmuRXheWzqTyIpNDGBq6FahH5/xykPetEbd4IEuHERBR7e coy3ijY3WbN5lzJ48Xl9516yEtQjQL0KrlkLMuM/5596fkMPHwNBWmZRqQQJtU4wCqp3 W06FlumEqbFeW5HRyMi8LdegEJKSOHom4FxmrtyLqVWOOFoQhnEsHTenaaQjHxHXap10 lipw== X-Gm-Message-State: AHPjjUjuOHLGNsyJupdwdjYF/w38epIje3clvgmVqSoi36MMOk+i13MB 6Sodg6kBWsgsvh+7gEQ= X-Google-Smtp-Source: AOwi7QA1kQRo3AybmJDOb478qm+R8nTb57rgpppco6zjMHWDu2KNrst79/nIV3ICsr5W+btZxYYXqg== X-Received: by 10.25.208.137 with SMTP id h131mr1180001lfg.101.1505390535482; Thu, 14 Sep 2017 05:02:15 -0700 (PDT) Received: from [192.168.1.174] ([178.252.127.239]) by smtp.googlemail.com with ESMTPSA id 72sm3470588lje.96.2017.09.14.05.02.12 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 14 Sep 2017 05:02:13 -0700 (PDT) Subject: Re: bug#27230: eldoc doc To: "Peder O. Klingenberg" References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> From: Dmitry Gutov Message-ID: <1f39b877-4cbf-96d8-a318-7edf95f10406@yandex.ru> Date: Thu, 14 Sep 2017 15:02:11 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:56.0) Gecko/20100101 Thunderbird/56.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Score: 2.2 (++) X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.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 the administrator of that system for details. Content preview: On 9/14/17 2:47 PM, Peder O. Klingenberg wrote: > As I discovered today, when I updated my tree, there are callers outside > emacs core that do call eldoc-message with more than one argument. > slime-autodoc.el is one such package, which I use. [...] Content analysis details: (2.2 points, 10.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 0.0 URIBL_BLOCKED ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [URIs: github.com] 1.5 RCVD_IN_SORBS_WEB RBL: SORBS: sender is an abusable web server [178.252.127.239 listed in dnsbl.sorbs.net] -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at http://www.dnswl.org/, no trust [209.85.215.51 listed in list.dnswl.org] 0.5 RCVD_IN_SORBS_SPAM RBL: SORBS: sender is a spam source [209.85.215.51 listed in dnsbl.sorbs.net] -0.0 RCVD_IN_MSPIKE_H3 RBL: Good reputation (+3) [209.85.215.51 listed in wl.mailspike.net] 0.0 HEADER_FROM_DIFFERENT_DOMAINS From and EnvelopeFrom 2nd level mail domains are different -0.0 SPF_PASS SPF: sender matches SPF record 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail provider (dgutov[at]yandex.ru) 0.0 T_DKIM_INVALID DKIM-Signature header exists but is not valid 0.2 FREEMAIL_FORGED_FROMDOMAIN 2nd level domains in From and EnvelopeFrom freemail headers are different -0.0 RCVD_IN_MSPIKE_WL Mailspike good senders X-Debbugs-Envelope-To: 27230 Cc: "Charles A. Roelli" , 27230@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 2.2 (++) X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.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 the administrator of that system for details. Content preview: On 9/14/17 2:47 PM, Peder O. Klingenberg wrote: > As I discovered today, when I updated my tree, there are callers outside > emacs core that do call eldoc-message with more than one argument. > slime-autodoc.el is one such package, which I use. [...] Content analysis details: (2.2 points, 10.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 0.0 URIBL_BLOCKED ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [URIs: github.com] 1.5 RCVD_IN_SORBS_WEB RBL: SORBS: sender is an abusable web server [178.252.127.239 listed in dnsbl.sorbs.net] 0.5 RCVD_IN_SORBS_SPAM RBL: SORBS: sender is a spam source [209.85.215.51 listed in dnsbl.sorbs.net] -0.0 RCVD_IN_MSPIKE_H3 RBL: Good reputation (+3) [209.85.215.51 listed in wl.mailspike.net] -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at http://www.dnswl.org/, no trust [209.85.215.51 listed in list.dnswl.org] 0.0 HEADER_FROM_DIFFERENT_DOMAINS From and EnvelopeFrom 2nd level mail domains are different -0.0 SPF_PASS SPF: sender matches SPF record 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail provider (dgutov[at]yandex.ru) 0.0 T_DKIM_INVALID DKIM-Signature header exists but is not valid 0.2 FREEMAIL_FORGED_FROMDOMAIN 2nd level domains in From and EnvelopeFrom freemail headers are different -0.0 RCVD_IN_MSPIKE_WL Mailspike good senders On 9/14/17 2:47 PM, Peder O. Klingenberg wrote: > As I discovered today, when I updated my tree, there are callers outside > emacs core that do call eldoc-message with more than one argument. > slime-autodoc.el is one such package, which I use. Thanks for letting us know. > The slime project has an open issue on this, with a patch, but it hasn't > been applied yet, after sitting in the discussion for 17 days. I've commented on it: https://github.com/slime/slime/issues/400 For one thing, third-party packages should *not* use eldoc-message. > IMO commit 7ef0b5f611c2d56ac2edb8de287190f04c4b8f32 was an ill-advised > change. The code worked fine before, the cleanup afforded by breaking > the api was negligible. I think it should be reverted. Aside from breaking the "obviously wrong" callers like explained above, the code had a subtle bug where calling it with no format arguments, and then with some arguments, wouldn't update the message area. > (Slime would benefit from cleaing up their callers as well, no doubt, > but not every slime user should be forced to do that on their own. Of course, the project maintainers should do it. All the best, Dmitry. From debbugs-submit-bounces@debbugs.gnu.org Thu Sep 14 15:39:37 2017 Received: (at 27230) by debbugs.gnu.org; 14 Sep 2017 19:39:37 +0000 Received: from localhost ([127.0.0.1]:41485 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dsZz6-00066G-W5 for submit@debbugs.gnu.org; Thu, 14 Sep 2017 15:39:37 -0400 Received: from sinyavsky.aurox.ch ([37.35.109.145]:59444) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dsZz5-000662-6v for 27230@debbugs.gnu.org; Thu, 14 Sep 2017 15:39:35 -0400 Received: from sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) by sinyavsky.aurox.ch (Postfix) with ESMTP id 4EF4022538 for <27230@debbugs.gnu.org>; Thu, 14 Sep 2017 19:33:14 +0000 (UTC) Authentication-Results: sinyavsky.aurox.ch (amavisd-new); dkim=pass (1024-bit key) reason="pass (just generated, assumed good)" header.d=aurox.ch DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=aurox.ch; h= references:subject:subject:in-reply-to:to:from:from:message-id :date:date; s=dkim; t=1505417591; x=1506281592; bh=IX0mhrn4S+u+E X7bJqkL/lbvrKUpK9PuZWbotV48THE=; b=Il+DWNose/8I4BnWCkS90rZit/i9u n+mqiE+1DfhReP5LDOcJosaZh1P0xG0z7Yj2l3AOqdkWDkVTXf068COoGUOk10CV 0QB6kGDejhcgtcEUvmDcf8W58A534+hc6a0V5znf47/aAiU4ROo+CsOWhr08/kei mp1oVgaGSeevJI= X-Virus-Scanned: Debian amavisd-new at test.virtualizor.com Received: from sinyavsky.aurox.ch ([127.0.0.1]) by sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id NNYwNNeBcskO for <27230@debbugs.gnu.org>; Thu, 14 Sep 2017 19:33:11 +0000 (UTC) Received: from gray (125.85.192.178.dynamic.wline.res.cust.swisscom.ch [178.192.85.125]) by sinyavsky.aurox.ch (Postfix) with ESMTPSA id 47D5B22527; Thu, 14 Sep 2017 19:33:11 +0000 (UTC) Date: Thu, 14 Sep 2017 21:39:04 +0200 Message-Id: From: charles@aurox.ch (Charles A. Roelli) To: Dmitry Gutov In-reply-to: <1f39b877-4cbf-96d8-a318-7edf95f10406@yandex.ru> (message from Dmitry Gutov on Thu, 14 Sep 2017 15:02:11 +0300) Subject: Re: bug#27230: eldoc doc References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> <1f39b877-4cbf-96d8-a318-7edf95f10406@yandex.ru> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 27230 Cc: pok@netfonds.no, 27230@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) > From: Dmitry Gutov > Date: Thu, 14 Sep 2017 15:02:11 +0300 > > For one thing, third-party packages should *not* use eldoc-message. Right. But why should we break its calling convention without good reason, when we can see that now that other packages have been using it? Moreover, the function has probably been around for awhile, and without good documentation, it might not have been clear that it's best suited for "internal" use. This change might also be mentioned under "Incompatible Lisp Changes" in NEWS, and it should be discussed in a separate bug report since it doesn't have much to do with "eldoc doc" (which this bug was about). From debbugs-submit-bounces@debbugs.gnu.org Thu Sep 14 18:03:46 2017 Received: (at 27230) by debbugs.gnu.org; 14 Sep 2017 22:03:46 +0000 Received: from localhost ([127.0.0.1]:41597 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dscEc-00019e-3z for submit@debbugs.gnu.org; Thu, 14 Sep 2017 18:03:46 -0400 Received: from mail-lf0-f41.google.com ([209.85.215.41]:43730) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dscEa-00019R-Gn for 27230@debbugs.gnu.org; Thu, 14 Sep 2017 18:03:44 -0400 Received: by mail-lf0-f41.google.com with SMTP id c80so699731lfh.0 for <27230@debbugs.gnu.org>; Thu, 14 Sep 2017 15:03:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=Cg0Eg2uC7TgeKLP74HeFChgRsJAx3oaCejb50ZZmh3U=; b=Loa3LUF/ppcsRXmdZ3oVUz2JoT7hdlNdoH2KKFHs0NJcHFZSPikq3REd+yyJnSVMK7 KZ1NoEvKXPe+FYauZ0fIMo/vI3ffBDUl4iARE55u+h12f9dCMTICNdzkziZhOHn8SXpm OwHX2yShINiao1LYT4AT32YJt/tNW0MdDf3wlo+K6awFb35IWcZXzW61ySgiQJGwXJnx 80GRT6KOppe5x8XE/ehecUgPmZ/h6cjoeoVLzFh3Q6qpZ4aV9KQ3ZPTPXze4kOPEvXM7 KlHCusdleSqwvh2eKLoniYeHV98W42gl3UqtYPlU9PLugfN01XpZmqhoZkkHSbUQvPog rhqw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:subject:to:cc:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=Cg0Eg2uC7TgeKLP74HeFChgRsJAx3oaCejb50ZZmh3U=; b=g0u1W613aRhqaKj9/Ya+xVqkWxN7NFyx559Tu8McO+orR8N+64FXlsHbQsQCA2GB7V n/piLgfoYR2DDnoOz52DtsQaoCjt5L3302wI/unTMnjln9U981V2TvV0Mjsz3LHWpCye GqVvoj63KbxpIn/i7Wl/vRj3R/oRrxh/e0c/93dyHKo7LRi2G9AqNPhl4mRa36E/tAK9 BTM/PLIY7dSphOhlbCCUVrxZeuWKsAMO8qxPl8wbuNfag92y66jld37wO644Uf8NCU7e BQqbj+tVxwr8Yr9PgjFoIjoFowLV++oUPEZGq4JUsSIBn/ObIz4v9KLiEzXyHCKM31cu Nhxg== X-Gm-Message-State: AHPjjUjU7WIYNMLT2iwygK2MXv+yhQ1x3A3ioiujKftsBuFrooQ8hh2s wuAe+4xXJr/y2QcjrLA= X-Google-Smtp-Source: AOwi7QCLl9zuAdfcacc56x5LZn04NPyQDot9otUYTNy2VLwJ13oHjPYn1pLnQVlKZqeoj463pc0vZA== X-Received: by 10.25.24.231 with SMTP id 100mr7516370lfy.241.1505426618148; Thu, 14 Sep 2017 15:03:38 -0700 (PDT) Received: from [192.168.1.174] ([178.252.127.239]) by smtp.googlemail.com with ESMTPSA id l14sm3111469lfb.71.2017.09.14.15.03.35 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 14 Sep 2017 15:03:36 -0700 (PDT) Subject: Re: bug#27230: eldoc doc To: "Charles A. Roelli" References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> <1f39b877-4cbf-96d8-a318-7edf95f10406@yandex.ru> From: Dmitry Gutov Message-ID: Date: Fri, 15 Sep 2017 01:03:35 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:56.0) Gecko/20100101 Thunderbird/56.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Score: 2.2 (++) X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.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 the administrator of that system for details. Content preview: On 9/14/17 10:39 PM, Charles A. Roelli wrote: > Right. But why should we break its calling convention without good > reason, when we can see that now that other packages have been using > it? Now they know they should fix it, though. [...] Content analysis details: (2.2 points, 10.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 1.5 RCVD_IN_SORBS_WEB RBL: SORBS: sender is an abusable web server [178.252.127.239 listed in dnsbl.sorbs.net] 0.0 HEADER_FROM_DIFFERENT_DOMAINS From and EnvelopeFrom 2nd level mail domains are different -0.0 SPF_PASS SPF: sender matches SPF record 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail provider (raaahh[at]gmail.com) -0.0 RCVD_IN_MSPIKE_H3 RBL: Good reputation (+3) [209.85.215.41 listed in wl.mailspike.net] -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at http://www.dnswl.org/, no trust [209.85.215.41 listed in list.dnswl.org] 0.5 RCVD_IN_SORBS_SPAM RBL: SORBS: sender is a spam source [209.85.215.41 listed in dnsbl.sorbs.net] 0.0 T_DKIM_INVALID DKIM-Signature header exists but is not valid 0.2 FREEMAIL_FORGED_FROMDOMAIN 2nd level domains in From and EnvelopeFrom freemail headers are different -0.0 RCVD_IN_MSPIKE_WL Mailspike good senders X-Debbugs-Envelope-To: 27230 Cc: pok@netfonds.no, 27230@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 2.2 (++) X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.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 the administrator of that system for details. Content preview: On 9/14/17 10:39 PM, Charles A. Roelli wrote: > Right. But why should we break its calling convention without good > reason, when we can see that now that other packages have been using > it? Now they know they should fix it, though. [...] Content analysis details: (2.2 points, 10.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 1.5 RCVD_IN_SORBS_WEB RBL: SORBS: sender is an abusable web server [178.252.127.239 listed in dnsbl.sorbs.net] 0.5 RCVD_IN_SORBS_SPAM RBL: SORBS: sender is a spam source [209.85.215.41 listed in dnsbl.sorbs.net] -0.0 RCVD_IN_MSPIKE_H3 RBL: Good reputation (+3) [209.85.215.41 listed in wl.mailspike.net] -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at http://www.dnswl.org/, no trust [209.85.215.41 listed in list.dnswl.org] 0.0 HEADER_FROM_DIFFERENT_DOMAINS From and EnvelopeFrom 2nd level mail domains are different -0.0 SPF_PASS SPF: sender matches SPF record 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail provider (dgutov[at]yandex.ru) 0.0 T_DKIM_INVALID DKIM-Signature header exists but is not valid 0.2 FREEMAIL_FORGED_FROMDOMAIN 2nd level domains in From and EnvelopeFrom freemail headers are different -0.0 RCVD_IN_MSPIKE_WL Mailspike good senders On 9/14/17 10:39 PM, Charles A. Roelli wrote: > Right. But why should we break its calling convention without good > reason, when we can see that now that other packages have been using > it? Now they know they should fix it, though. > This change might also be mentioned under "Incompatible Lisp Changes" > in NEWS, and it should be discussed in a separate bug report since it > doesn't have much to do with "eldoc doc" (which this bug was about). Sometimes we go off tangent. It's not the end of the world. But yes, it's a good idea, thanks. From debbugs-submit-bounces@debbugs.gnu.org Tue Sep 19 16:02:48 2017 Received: (at 27230) by debbugs.gnu.org; 19 Sep 2017 20:02:48 +0000 Received: from localhost ([127.0.0.1]:48662 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1duOjH-00050j-NC for submit@debbugs.gnu.org; Tue, 19 Sep 2017 16:02:47 -0400 Received: from sinyavsky.aurox.ch ([37.35.109.145]:35217) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1duOjG-00050T-HO for 27230@debbugs.gnu.org; Tue, 19 Sep 2017 16:02:47 -0400 Received: from sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) by sinyavsky.aurox.ch (Postfix) with ESMTP id 8B38022542 for <27230@debbugs.gnu.org>; Tue, 19 Sep 2017 19:56:22 +0000 (UTC) Authentication-Results: sinyavsky.aurox.ch (amavisd-new); dkim=pass (1024-bit key) reason="pass (just generated, assumed good)" header.d=aurox.ch DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=aurox.ch; h= content-type:content-type:mime-version:references:subject :subject:in-reply-to:to:from:from:message-id:date:date; s=dkim; t=1505850981; x=1506714982; bh=4th0nbaSiFE6Prz5790A/qeBO+yEj/y5 LzhT1OEbofw=; b=QuTDRJZiscrKtocc6pWholDd+15T2ZGvf7CDgIYBWNlWLnVg irUdQDqbaaqhfl1vaOY0cg4AOV4YYVK55GfAgQxLr/zEATG6g3HI4iz902uP2XQb pwRHVl+9qlH72vyKJrMdypcVvO7X1HAmOW6NrKQFDcDID9HLDh/J3V8gkTI= X-Virus-Scanned: Debian amavisd-new at test.virtualizor.com Received: from sinyavsky.aurox.ch ([127.0.0.1]) by sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id 3Jh8rjlmMG4M for <27230@debbugs.gnu.org>; Tue, 19 Sep 2017 19:56:21 +0000 (UTC) Received: from gray (125.85.192.178.dynamic.wline.res.cust.swisscom.ch [178.192.85.125]) by sinyavsky.aurox.ch (Postfix) with ESMTPSA id 4F02A22541; Tue, 19 Sep 2017 19:56:17 +0000 (UTC) Date: Tue, 19 Sep 2017 22:02:33 +0200 Message-Id: From: charles@aurox.ch (Charles A. Roelli) To: Dmitry Gutov In-reply-to: (message from Dmitry Gutov on Fri, 15 Sep 2017 01:03:35 +0300) Subject: Re: bug#27230: eldoc doc References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> <1f39b877-4cbf-96d8-a318-7edf95f10406@yandex.ru> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 27230 Cc: pok@netfonds.no, 27230@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) --=-=-= Content-Type: text/plain > From: Dmitry Gutov > Date: Fri, 15 Sep 2017 01:03:35 +0300 > > > Right. But why should we break its calling convention without good > > reason, when we can see that now that other packages have been using > > it? > > Now they know they should fix it, though. Unfortunately it means there are probably other users of the function, and if we don't document the change, the function should stay as is. Attached is a patch that brings back the old behavior, without the convoluted buggy logic for setting eldoc-last-message. What do you think? And from an earlier message: > Aside from breaking the "obviously wrong" callers like explained above, > the code had a subtle bug where calling it with no format arguments, and > then with some arguments, wouldn't update the message area. Should be fixed with this patch. --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-Keep-old-calling-convention-of-eldoc-message.patch >From f872315286949e9b428ee108c66a8bb5f1131953 Mon Sep 17 00:00:00 2001 From: "Charles A. Roelli" Date: Tue, 19 Sep 2017 22:00:54 +0200 Subject: [PATCH] Keep old calling convention of 'eldoc-message' * lisp/emacs-lisp/eldoc.el (eldoc-message): Keep its old calling convention, as it's used by other packages. See the discussion in Bug#27230, and the previous change 7ef0b5f6 ("Simplify eldoc-message") of 2017-08-21. --- lisp/emacs-lisp/eldoc.el | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index cba9a00..7176eb8 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -276,12 +276,13 @@ eldoc-minibuffer-message (force-mode-line-update))) (apply 'message format-string args))) -(defun eldoc-message (&optional string) +(defun eldoc-message (&optional format-string &rest args) "Display STRING as an ElDoc message if it's non-nil. Also store it in `eldoc-last-message' and return that value." (let ((omessage eldoc-last-message)) - (setq eldoc-last-message string) + (setq eldoc-last-message + (if args (apply #'format-message format-string args) format-string)) ;; In emacs 19.29 and later, and XEmacs 19.13 and later, all messages ;; are recorded in a log. Do not put eldoc messages in that log since ;; they are Legion. -- 2.9.4 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Wed Sep 20 14:12:58 2017 Received: (at 27230) by debbugs.gnu.org; 20 Sep 2017 18:12:58 +0000 Received: from localhost ([127.0.0.1]:50476 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dujUX-0000BO-Rv for submit@debbugs.gnu.org; Wed, 20 Sep 2017 14:12:58 -0400 Received: from sinyavsky.aurox.ch ([37.35.109.145]:36104) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dujUV-0000B8-Fy for 27230@debbugs.gnu.org; Wed, 20 Sep 2017 14:12:56 -0400 Received: from sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) by sinyavsky.aurox.ch (Postfix) with ESMTP id 313492254A for <27230@debbugs.gnu.org>; Wed, 20 Sep 2017 18:06:32 +0000 (UTC) Authentication-Results: sinyavsky.aurox.ch (amavisd-new); dkim=pass (1024-bit key) reason="pass (just generated, assumed good)" header.d=aurox.ch DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=aurox.ch; h= content-type:content-type:mime-version:references:subject :subject:in-reply-to:to:from:from:message-id:date:date; s=dkim; t=1505930790; x=1506794791; bh=+Ln2yX0ju+GE5hb52n3/2LZuW3TXovKD 1PFVjmNHtzY=; b=lNL5iFIjkH/dqkMJ0xpqUKr5wkTj+oiJAPjwkJXudvENm5TG dlGf/xNDq1mtQmkyD4HLeAO/EXfFBdHf5Akf1kPR3oBmYDlHHhTNZuMdL1foTk3k Mfm/qpbfp7MdPJpUEJAnbCNKUE4KdfCIR4eMXYDvmZ5xGCLu8vlw1wH6Ojs= X-Virus-Scanned: Debian amavisd-new at test.virtualizor.com Received: from sinyavsky.aurox.ch ([127.0.0.1]) by sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id GP_m02n2pNgA for <27230@debbugs.gnu.org>; Wed, 20 Sep 2017 18:06:30 +0000 (UTC) Received: from gray (125.85.192.178.dynamic.wline.res.cust.swisscom.ch [178.192.85.125]) by sinyavsky.aurox.ch (Postfix) with ESMTPSA id 2BCB52252C; Wed, 20 Sep 2017 18:06:28 +0000 (UTC) Date: Wed, 20 Sep 2017 20:12:38 +0200 Message-Id: From: charles@aurox.ch (Charles A. Roelli) To: charles@aurox.ch (Charles A. Roelli) In-reply-to: (charles@aurox.ch) Subject: Re: bug#27230: eldoc doc References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> <1f39b877-4cbf-96d8-a318-7edf95f10406@yandex.ru> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 27230 Cc: 27230@debbugs.gnu.org, pok@netfonds.no, dgutov@yandex.ru X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) --=-=-= Content-Type: text/plain Sorry, I had forgotten to update the docstring. Updated patch attached. --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-Keep-old-calling-convention-of-eldoc-message.patch >From 576fced66c8960a91a1fcfd51efc700413a810b4 Mon Sep 17 00:00:00 2001 From: "Charles A. Roelli" Date: Tue, 19 Sep 2017 22:00:54 +0200 Subject: [PATCH] Keep old calling convention of 'eldoc-message' * lisp/emacs-lisp/eldoc.el (eldoc-message): Keep its old calling convention, as it's used by other packages. See the discussion in Bug#27230, and the previous change 7ef0b5f6 ("Simplify eldoc-message") of 2017-08-21. --- lisp/emacs-lisp/eldoc.el | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index cba9a00..1440fb1 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -276,12 +276,16 @@ eldoc-minibuffer-message (force-mode-line-update))) (apply 'message format-string args))) -(defun eldoc-message (&optional string) - "Display STRING as an ElDoc message if it's non-nil. +(defun eldoc-message (&optional format-string &rest args) + "Display FORMAT-STRING as an ElDoc message if it's non-nil. + +If ARGS are given, FORMAT-STRING and ARGS are first passed to +`format-message'. Also store it in `eldoc-last-message' and return that value." (let ((omessage eldoc-last-message)) - (setq eldoc-last-message string) + (setq eldoc-last-message + (if args (apply #'format-message format-string args) format-string)) ;; In emacs 19.29 and later, and XEmacs 19.13 and later, all messages ;; are recorded in a log. Do not put eldoc messages in that log since ;; they are Legion. -- 2.9.4 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Thu Sep 21 10:23:33 2017 Received: (at 27230) by debbugs.gnu.org; 21 Sep 2017 14:23:33 +0000 Received: from localhost ([127.0.0.1]:51682 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dv2O4-0005Ih-SZ for submit@debbugs.gnu.org; Thu, 21 Sep 2017 10:23:32 -0400 Received: from mail-wm0-f66.google.com ([74.125.82.66]:36544) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dv2O3-0005IT-HW for 27230@debbugs.gnu.org; Thu, 21 Sep 2017 10:23:31 -0400 Received: by mail-wm0-f66.google.com with SMTP id r136so5372761wmf.3 for <27230@debbugs.gnu.org>; Thu, 21 Sep 2017 07:23:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=c0wk5dlOpU0kfljCkUVTPAbgZLUD0iIHmad5qs+qu4I=; b=MSAvaZCEENCvMAHFmUk9ykGkF4zeJ6vdcnSuEuabn94NhJv8dj2tWVqaGdtoQgUbTd qH4KyqamowCXKnw5zJN58qMdxSFYhQne1MtbJepBYjhpyBda+TxRUyuy3GKRdv3GkJjy 9LalLD74rL2D9y/Y/ub8gUxUpRkUF0byiGkD+K2EOQ91bXMbM1ANOAuFY2Gi1P9SVLCR r+qBGh8EhXWgK6eWaQ8PJeE/QmZnGUXr/8k/xmosfAuvgvN8oqSqeA8A7h6uxPWhnNx4 WU0e26isxSIr9WdyMzzFFw6/NH6zvvd2XlRSUE23VJHuvAzK9FaCLUkCRXE4oTfLYi3/ 9lRA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:subject:to:cc:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=c0wk5dlOpU0kfljCkUVTPAbgZLUD0iIHmad5qs+qu4I=; b=LmPxkYXbx6EhK3h9wwgdEohrSW/BKCeA793GQNH5eKkiAKfxPweMCym/aPY/pfc2yd L6O22dvybLfORfQtm5mROcVlS+g+eFREiypuDxOrI3Auxp9DuVBkSrnhALa2JQJVR2PV oWawCWsb6ufky9yLsPNhF9RE6LakNRn05pGYPgR9oK4mDuwzfDWy7yYFPvd0wPlxskp8 RG/5jgwrtTgRZ0saXuDQD88ahowvi7rIk3LuuB4jGqcRkyQt+6nWOOVKiXkb8PMRBJeZ dYL0du96Fh5pH+IMvJTq09hnQkEvRXMXqCL7L+1CHsz0NgPPFdLI34tpOC/C95LXBVTR azvw== X-Gm-Message-State: AHPjjUh4zfLYt3D1KeLuTvDQFnbpdsbOeYN9rVeFM9QfS2/+wrgzB1s+ NGmaWM6zJDCXoboPs21W1nnvir+4 X-Google-Smtp-Source: AOwi7QA5ycpBjRkwG7BwI2+RbjSxp+y8A49bYPZNx55ljroesSmds9FfgFDaebkskNKpfJ7hD9xatw== X-Received: by 10.80.183.188 with SMTP id h57mr1366492ede.63.1506003805750; Thu, 21 Sep 2017 07:23:25 -0700 (PDT) Received: from [192.168.0.133] (static-nbl2-118.cytanet.com.cy. [212.31.107.118]) by smtp.googlemail.com with ESMTPSA id b8sm899634eda.35.2017.09.21.07.23.23 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 21 Sep 2017 07:23:24 -0700 (PDT) Subject: Re: bug#27230: eldoc doc To: "Charles A. Roelli" References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> <1f39b877-4cbf-96d8-a318-7edf95f10406@yandex.ru> From: Dmitry Gutov Message-ID: <86327677-dcfa-37b6-9f17-81ff05865266@yandex.ru> Date: Thu, 21 Sep 2017 17:23:22 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:56.0) Gecko/20100101 Thunderbird/56.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Score: 0.7 (/) X-Debbugs-Envelope-To: 27230 Cc: pok@netfonds.no, 27230@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.7 (/) Hey Charles, On 9/20/17 9:12 PM, Charles A. Roelli wrote: > Sorry, I had forgotten to update the docstring. Updated patch > attached. Is there a reason you so strongly insist on returning to the original calling convention? I'd rather add a NEWS entry instead. From debbugs-submit-bounces@debbugs.gnu.org Thu Sep 21 14:33:40 2017 Received: (at 27230) by debbugs.gnu.org; 21 Sep 2017 18:33:40 +0000 Received: from localhost ([127.0.0.1]:51859 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dv6I8-0006oH-In for submit@debbugs.gnu.org; Thu, 21 Sep 2017 14:33:40 -0400 Received: from sinyavsky.aurox.ch ([37.35.109.145]:37154) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dv6I5-0006o3-Lk for 27230@debbugs.gnu.org; Thu, 21 Sep 2017 14:33:39 -0400 Received: from sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) by sinyavsky.aurox.ch (Postfix) with ESMTP id D4F422253A for <27230@debbugs.gnu.org>; Thu, 21 Sep 2017 18:27:09 +0000 (UTC) Authentication-Results: sinyavsky.aurox.ch (amavisd-new); dkim=pass (1024-bit key) reason="pass (just generated, assumed good)" header.d=aurox.ch DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=aurox.ch; h= references:subject:subject:in-reply-to:to:from:from:message-id :date:date; s=dkim; t=1506018428; x=1506882429; bh=BIku2c1j5mnNc z90nvKFN5sAjZ7wccu0lRXkdzFykaA=; b=eP0+AeE5N06wsXUw8X98k1ETI3Kqc Wnwz+Yl+ZP9eurw1dIcaNkKvYzuUK+SKBgL5kBbqBD7Mh35Gn6FMHAC49okajUA8 KlQLccI0YgmDFhvFgTT/pIrrcuQeM+7vhqejbNDgcf7lLKblZbWLdo2YvYUIw2hB S/10MGsSFlAQhY= X-Virus-Scanned: Debian amavisd-new at test.virtualizor.com Received: from sinyavsky.aurox.ch ([127.0.0.1]) by sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id jod46IXRAZxF for <27230@debbugs.gnu.org>; Thu, 21 Sep 2017 18:27:08 +0000 (UTC) Received: from gray (125.85.192.178.dynamic.wline.res.cust.swisscom.ch [178.192.85.125]) by sinyavsky.aurox.ch (Postfix) with ESMTPSA id B2C4422534; Thu, 21 Sep 2017 18:27:06 +0000 (UTC) Date: Thu, 21 Sep 2017 20:33:29 +0200 Message-Id: From: charles@aurox.ch (Charles A. Roelli) To: Dmitry Gutov In-reply-to: <86327677-dcfa-37b6-9f17-81ff05865266@yandex.ru> (message from Dmitry Gutov on Thu, 21 Sep 2017 17:23:22 +0300) Subject: Re: bug#27230: eldoc doc References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> <1f39b877-4cbf-96d8-a318-7edf95f10406@yandex.ru> <86327677-dcfa-37b6-9f17-81ff05865266@yandex.ru> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 27230 Cc: pok@netfonds.no, 27230@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) > Cc: pok@netfonds.no, 27230@debbugs.gnu.org > From: Dmitry Gutov > Date: Thu, 21 Sep 2017 17:23:22 +0300 > > Hey Charles, > > On 9/20/17 9:12 PM, Charles A. Roelli wrote: > > Sorry, I had forgotten to update the docstring. Updated patch > > attached. > > Is there a reason you so strongly insist on returning to the original > calling convention? Yes, and another user gave an opinion too. What do others think? From debbugs-submit-bounces@debbugs.gnu.org Thu Sep 21 19:06:06 2017 Received: (at 27230) by debbugs.gnu.org; 21 Sep 2017 23:06:06 +0000 Received: from localhost ([127.0.0.1]:51977 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dvAXl-0000Ng-Pl for submit@debbugs.gnu.org; Thu, 21 Sep 2017 19:06:05 -0400 Received: from mail-wr0-f171.google.com ([209.85.128.171]:55002) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dvAXk-0000NB-Jn for 27230@debbugs.gnu.org; Thu, 21 Sep 2017 19:06:04 -0400 Received: by mail-wr0-f171.google.com with SMTP id g29so5624239wrg.11 for <27230@debbugs.gnu.org>; Thu, 21 Sep 2017 16:06:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=25NsBs5WW3HDxjmzgQavjq2ahkYwJ1O1mCVzJIgxfSw=; b=KxWmZJVvGshpjyLWZ4STpcmQPpboaHc3CNWcrI53BDzFu1JrmrAsBwFJvVNkpGeVlc NaHYayhZZO/EZ+vjes0uZsLNq/t4nU04PXdm3HQltuu0GRn4d3jezboo4r9MCrh8VItc e7/QX9zo/vSU9OzMfjyGn8tA13dNTyTBgMFKW4TOTffNWjkVZy0jvxiHt+62G0vZdp1/ kZ2py2GIIuFF2dmcYjK/m1OpBnlBEvyhpS0cZgrWe2dq3tu4QBOUfnhdMdNCudsh9cTr CA4m929lc+SdK6dR2ml6upNb1jqkKNV03iIk64mGJ7RzIP3sYfvBWWP4jBaQggx+4ST6 llIA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:subject:to:cc:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=25NsBs5WW3HDxjmzgQavjq2ahkYwJ1O1mCVzJIgxfSw=; b=cAGL80Bi75myhJ2sWoVCMeD+ioXhkLLkjeHCafYfZI3vDOnIS6Ku/PgI6v4LlKg9LV TyEkZFssZA7cK1Rw4vhjFIo4SbV2YQCEys7Myza3v/wh9pQBiGhM0ii4X8tzNVrfXu2r 4+tGHU9EqOrnUrijnAqb1hxKUWaRH+FQqTKT2CzRf4gWHA2zKV4bxTeNl8Zx1VkDBRMS av4Bo0SymBkyRoq7IDKp5CNy3CjJ+R19wJ/TUawJn0waHW/HZVK8ZARMZ9j5WCfdFIRI +ArxOTBEb/RI9QdjmQrZGpFONOol8a/B6ITkh5bXge2A1dnXQY1mplj9w0d4z2Di2MXX J5ZA== X-Gm-Message-State: AHPjjUimgN5AY6YtRx45NtgiqVSprSBOF0E8nlXqJ9tLAsQ8HExASg9x Nq4rOC5cY9AKakorQ2VGDOBiTEaO X-Google-Smtp-Source: AOwi7QAf/PAOiaq+NHDY5fEwG3ALIKtgFN7f8N5on04wRvQuepm7MBrFhbT6clksBaR0SH2zzCHujg== X-Received: by 10.223.198.82 with SMTP id u18mr3333720wrg.5.1506035158647; Thu, 21 Sep 2017 16:05:58 -0700 (PDT) Received: from [192.168.1.3] ([185.105.174.193]) by smtp.googlemail.com with ESMTPSA id 69sm3221305wmp.11.2017.09.21.16.05.55 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 21 Sep 2017 16:05:57 -0700 (PDT) Subject: Re: bug#27230: eldoc doc To: "Charles A. Roelli" References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> <1f39b877-4cbf-96d8-a318-7edf95f10406@yandex.ru> <86327677-dcfa-37b6-9f17-81ff05865266@yandex.ru> From: Dmitry Gutov Message-ID: <677d5e70-9303-d53f-a540-3238c59da1cd@yandex.ru> Date: Fri, 22 Sep 2017 02:05:54 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:56.0) Gecko/20100101 Thunderbird/56.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Score: -2.1 (--) X-Debbugs-Envelope-To: 27230 Cc: pok@netfonds.no, 27230@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.1 (--) On 9/21/17 9:33 PM, Charles A. Roelli wrote: > Yes, and another user gave an opinion too. What do others think? Just FYI, the SLIME project has merged the patch a week ago. It shouldn't be a problem anymore. From debbugs-submit-bounces@debbugs.gnu.org Mon Sep 25 19:26:54 2017 Received: (at 27230) by debbugs.gnu.org; 25 Sep 2017 23:26:54 +0000 Received: from localhost ([127.0.0.1]:59157 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dwcm5-0001FU-Oo for submit@debbugs.gnu.org; Mon, 25 Sep 2017 19:26:53 -0400 Received: from mail-wm0-f42.google.com ([74.125.82.42]:46129) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dwcm4-0001FC-6Y for 27230@debbugs.gnu.org; Mon, 25 Sep 2017 19:26:52 -0400 Received: by mail-wm0-f42.google.com with SMTP id m72so2253620wmc.1 for <27230@debbugs.gnu.org>; Mon, 25 Sep 2017 16:26:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=FKXZsxcRGMHE7ijuPvCYoz22x9jwv+IkWNCbYU+Csq8=; b=sPQCu70fWGcdxhE2sEClvjVbr4lmJpUP/LhHQtLGTg2Pnt6I1TH79nr9HRs2R66WkU eVZUqgpOnM8gAvPkveN051yeF7CAVaMjJasXJYIkrdgcziKsFKOGU4JzHGZT0+qyuLC5 zBsJiogRWEJR+8gzSIeH7pQuZpbih1YThdgwVdLo0zcJIhFYYfKx2LkE6SylGyNmBUb/ /H4dfRFmvY/hX/RZJFybazPwwADEXwPHVdna9VAxPKSlH+VeQTwVy0Y8l2vdNcCcP8C+ FiAx7t1XTwCSTOHc3O49/TqTUX/mGm8dWlAFCza9wyJugznkmtQETUTQbpnPcStJzwhT gDhg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:subject:to:cc:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=FKXZsxcRGMHE7ijuPvCYoz22x9jwv+IkWNCbYU+Csq8=; b=kd8P6QrHRC1c4mGk2vc7Tk6TRAsQ7wfstBWGAbdz3B8VyMYiXnWeyfaoNfEoWeoEVA jWdrILE87M/gTw7zBhCbV9wTP/IvpPzLjn4RP/z7oRpOoSo7CpkRrubhS2Vv/OdpxFK9 onM7T6279W1btcQ9IueK3Lt8Jvz+E/hfkvCAsCqALx/qFmumjDxTDSYpac2NXFnOtsL+ YgawejIu/MNd399XypvGXYaeR0l2cChyYjCde7xoits15jy0Cbh0TpnOg1XA58cptZpR ylHKuPd6Vit74xucSvVstgBjsGShvjKHNSjhEChDhJADjX8apKxCKoecP/GuSPf7/1vE 5q/A== X-Gm-Message-State: AHPjjUiNrKfnKa7epnPAiCN4/Ghb0kuyWyTWXY4a/V2vpw8lSlHKDB4o wSTI8fs1MdcI/SaMf7+DT1qp6XfX X-Google-Smtp-Source: AOwi7QDS8KDqnHsEhgwKy0eqLqWFh/3gVn1LqR+eGo9bqnpGyKk91SaIYIi8JVkOS5vWoCmpNSP4kw== X-Received: by 10.28.64.6 with SMTP id n6mr1712647wma.61.1506382006111; Mon, 25 Sep 2017 16:26:46 -0700 (PDT) Received: from [192.168.1.3] ([185.105.174.193]) by smtp.googlemail.com with ESMTPSA id y48sm7546060wrb.68.2017.09.25.16.26.43 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 25 Sep 2017 16:26:44 -0700 (PDT) Subject: Re: bug#27230: eldoc doc To: "Charles A. Roelli" References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> <1f39b877-4cbf-96d8-a318-7edf95f10406@yandex.ru> <86327677-dcfa-37b6-9f17-81ff05865266@yandex.ru> From: Dmitry Gutov Message-ID: <0520cae2-6bfa-5f9f-781d-78f1d85202dc@yandex.ru> Date: Tue, 26 Sep 2017 02:26:42 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:56.0) Gecko/20100101 Thunderbird/56.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Score: 0.7 (/) X-Debbugs-Envelope-To: 27230 Cc: pok@netfonds.no, 27230@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.7 (/) On 9/21/17 9:33 PM, Charles A. Roelli wrote: > What do others think? Since nobody else is chiming in, I've updated the "Incompatible Lisp Changes" in etc/NEWS. From unknown Sat Aug 16 11:33:53 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Tue, 24 Oct 2017 11:24:05 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator