bug#66539: 30.0.50; eldoc-echo-area-prefer-doc-buffer missing choice

bug#66539: 30.0.50; eldoc-echo-area-prefer-doc-buffer missing choice

[Mauro Aranda]

The docstring for eldoc-echo-area-prefer-doc-buffer says its value can
be the symbol maybe, but its :type is just boolean.

bug#66539: 30.0.50; eldoc-echo-area-prefer-doc-buffer missing choice

[Mauro Aranda]

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

tags 66539 patch
quit


Patch attached.  Please also note that this, and other user options are
missing the :version keyword (which I guess should be 28.1, at least for
this one)

[-- Attachment #2: 0001-Fix-a-defcustom-type.patch --]
[-- Type: text/x-patch, Size: 1131 bytes --]

From 9a583a2d4e5dacd4a443c3d37c096fa34f6ec17a Mon Sep 17 00:00:00 2001
From: Mauro Aranda <maurooaranda@gmail.com>
Date: Sat, 14 Oct 2023 10:34:54 -0300
Subject: [PATCH] Fix a defcustom :type

* lisp/emacs-lisp/eldoc.el (eldoc-echo-area-prefer-doc-buffer): Make
:type a choice, to allow for the value maybe.  (Bug##66539)
---
 lisp/emacs-lisp/eldoc.el | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el
index 3a786bb321b..941f1e4e157 100644
--- a/lisp/emacs-lisp/eldoc.el
+++ b/lisp/emacs-lisp/eldoc.el
@@ -132,7 +132,9 @@ eldoc-echo-area-prefer-doc-buffer
 buffer (displayed by `eldoc-doc-buffer') is already displayed in
 some window.  If the value is the symbol `maybe', then the echo area
 is only skipped if the documentation needs to be truncated there."
-  :type 'boolean)
+  :type '(choice (const :tag "Prefer ElDoc's documentation buffer" t)
+                 (const :tag "Prefer echo area" nil)
+                 (const :tag "Skip echo area if truncating" maybe)))
 
 (defface eldoc-highlight-function-argument
   '((t (:inherit bold)))
-- 
2.34.1

bug#66539: 30.0.50; eldoc-echo-area-prefer-doc-buffer missing choice

[Stefan Kangas]

Version: 29.2

Mauro Aranda <maurooaranda@gmail.com> writes:

> Patch attached.

Thanks, installed on emacs-29.

[1: 9044d4d94bb]: 2023-10-14 20:54:04 +0200
  Fix a defcustom :type in eldoc.el
  https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=9044d4d94bbdaed8af2681bf7facb0ce4b27cd48

> Please also note that this, and other user options are
> missing the :version keyword (which I guess should be 28.1, at least for
> this one)

Thanks, I fixed that.  Some of the options go back to 1997, so I left
them alone.

[2: 9525315c117]: 2023-10-14 21:00:00 +0200
  Add missing :version to two defcustoms
  https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=9525315c1179065b69c937899ea18fe649b0f16f