GNU bug report logs - #50935
minibuffer-electric-default-mode interface

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 50935 in the body.
You can then email your comments to 50935 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: bug-gnu-emacs <at> gnu.org
Subject: minibuffer-electric-default-mode interface
Date: Fri, 1 Oct 2021 13:43:46 +0200

In (info "(emacs) Basic Minibuffer"), I see:

if you change the variable ‘minibuffer-eldef-shorten-default’ to a
non-‘nil’ value, the default argument is displayed as ‘[DEFAULT-ARG]’
instead of ‘(default DEFAULT-ARG)’, saving some screen space.  To
enable this minor mode, type ‘M-x minibuffer-electric-default-mode’.

But when I run "emacs -Q", I can't customize
'minibuffer-eldef-shorten-default', and this has no effect:

0. emacs -Q
1. (setq minibuffer-eldef-shorten-default t)
2. M-x set-fill-column RET

I still see "(default 0)".  Only if I run 'M-x
minibuffer-electric-default-mode' does this change to "[0]".  So the
above text seems wrong.

Message #8 received at 50935 <at> debbugs.gnu.org (full text, mbox):

From: Juri Linkov <juri <at> linkov.net>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 50935 <at> debbugs.gnu.org
Subject: Re: bug#50935: minibuffer-electric-default-mode interface
Date: Sat, 02 Oct 2021 22:15:54 +0300

> In (info "(emacs) Basic Minibuffer"), I see:
>
> if you change the variable ‘minibuffer-eldef-shorten-default’ to a
> non-‘nil’ value, the default argument is displayed as ‘[DEFAULT-ARG]’
> instead of ‘(default DEFAULT-ARG)’, saving some screen space.  To
> enable this minor mode, type ‘M-x minibuffer-electric-default-mode’.

While I don't know how to fix this issue, I have to note that
this Info node should also mention that minibuffer-electric-default-mode
is now obsoleted by the new user option minibuffer-default-prompt-format.
The only problem is that currently not all prompts use 'format-prompt'.
Maybe this should be added to etc/TODO?

Message #11 received at 50935 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Juri Linkov <juri <at> linkov.net>
Cc: 50935 <at> debbugs.gnu.org
Subject: Re: bug#50935: minibuffer-electric-default-mode interface
Date: Sun, 3 Oct 2021 01:14:59 +0200

Juri Linkov <juri <at> linkov.net> writes:

> > In (info "(emacs) Basic Minibuffer"), I see:
> >
> > if you change the variable ‘minibuffer-eldef-shorten-default’ to a
> > non-‘nil’ value, the default argument is displayed as ‘[DEFAULT-ARG]’
> > instead of ‘(default DEFAULT-ARG)’, saving some screen space.  To
> > enable this minor mode, type ‘M-x minibuffer-electric-default-mode’.
>
> While I don't know how to fix this issue, I have to note that
> this Info node should also mention that minibuffer-electric-default-mode
> is now obsoleted by the new user option minibuffer-default-prompt-format.

Hmm, shouldn't the info node then just mention
'minibuffer-default-prompt-format' instead, and only that?  I don't
think we mention obsolete things if we can avoid it, do we?

Also, should 'minibuffer-electric-default-mode' be declared obsolete,
or is it too early for that?

> The only problem is that currently not all prompts use 'format-prompt'.
> Maybe this should be added to etc/TODO?

It can't hurt.

Message #14 received at 50935 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Juri Linkov <juri <at> linkov.net>
Cc: stefan <at> marxist.se, 50935 <at> debbugs.gnu.org
Subject: Re: bug#50935: minibuffer-electric-default-mode interface
Date: Sun, 03 Oct 2021 14:51:30 +0300

> From: Juri Linkov <juri <at> linkov.net>
> Date: Sat, 02 Oct 2021 22:15:54 +0300
> Cc: 50935 <at> debbugs.gnu.org
> 
> While I don't know how to fix this issue, I have to note that
> this Info node should also mention that minibuffer-electric-default-mode
> is now obsoleted by the new user option minibuffer-default-prompt-format.
> The only problem is that currently not all prompts use 'format-prompt'.
> Maybe this should be added to etc/TODO?

If we haven't yet completed the conversion between the two, I'm not
sure the time is right for us to announce the obsolescence of the old
method, as it is still needed in some situations.

Message #17 received at 50935 <at> debbugs.gnu.org (full text, mbox):

From: Juri Linkov <juri <at> linkov.net>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 50935 <at> debbugs.gnu.org
Subject: Re: bug#50935: minibuffer-electric-default-mode interface
Date: Sun, 03 Oct 2021 19:54:51 +0300

>> While I don't know how to fix this issue, I have to note that
>> this Info node should also mention that minibuffer-electric-default-mode
>> is now obsoleted by the new user option minibuffer-default-prompt-format.
>
> Hmm, shouldn't the info node then just mention
> 'minibuffer-default-prompt-format' instead, and only that?  I don't
> think we mention obsolete things if we can avoid it, do we?
>
> Also, should 'minibuffer-electric-default-mode' be declared obsolete,
> or is it too early for that?

It seems it's too early to obsolete it.  But maybe still
'minibuffer-default-prompt-format' should be mentioned?
Since it's a user option supporting the same format (but in
a limited set of prompts) as 'minibuffer-electric-default-mode'.

Message #20 received at 50935 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Juri Linkov <juri <at> linkov.net>
Cc: 50935 <at> debbugs.gnu.org
Subject: Re: bug#50935: minibuffer-electric-default-mode interface
Date: Mon, 4 Oct 2021 02:17:38 +0000

Juri Linkov <juri <at> linkov.net> writes:

> It seems it's too early to obsolete it.  But maybe still
> 'minibuffer-default-prompt-format' should be mentioned?
> Since it's a user option supporting the same format (but in
> a limited set of prompts) as 'minibuffer-electric-default-mode'.

I guess we have this problem for many defcustoms, unless they are
autoloaded, so for `minibuffer-eldef-shorten-default' we have that:

- "Setting it to a non-nil value" using setq before the library is
  loaded will work.

- "Setting it to a non-nil value" using setq after the library is loaded
  will *not* work, you must use customize.

- You can only set it with customize after the library has been loaded.

I think instead of documenting all that, we could just delete the
reference to `minibuffer-eldef-shorten-default' from the manual, as it
is the same thing as `minibuffer-default-prompt-format', just with a
different interface.  Of course, the latter is not yet perfect, but
anywhere it isn't, that's just a bug, right?  That option would look
like the below diff.

Another option is to just add a reference to
'minibuffer-default-prompt-format' without any deletions, basically
accepting that the text is not perfect and move on.

A third option is to add 'minibuffer-default-prompt-format' on emacs-28,
but make the suggested deletion on master -- which give us more time to
get `minibuffer-default-prompt-format' up to scrap.

Thoughts?

diff --git a/doc/emacs/mini.texi b/doc/emacs/mini.texi
index 6dcee3fa82..2581be30ba 100644
--- a/doc/emacs/mini.texi
+++ b/doc/emacs/mini.texi
@@ -41,11 +41,14 @@ Basic Minibuffer
 canceling the command asking for the argument (@pxref{Quitting}).

 @cindex default argument
+@vindex minibuffer-default-prompt-format
   Sometimes, the prompt shows a @dfn{default argument}, inside
 parentheses before the colon.  This default will be used as the
 argument if you just type @key{RET}.  For example, commands that read
 buffer names usually show a buffer name as the default; you can type
-@key{RET} to operate on that default buffer.
+@key{RET} to operate on that default buffer.  You can customize how
+the default argument is shown with the user option
+@code{minibuffer-default-prompt-format}.

 @cindex Minibuffer Electric Default mode
 @cindex mode, Minibuffer Electric Default
@@ -55,11 +58,7 @@ Basic Minibuffer
 Emacs hides the default argument as soon as you modify the contents of
 the minibuffer (since typing @key{RET} would no longer submit that
 default).  If you ever bring back the original minibuffer text, the
-prompt again shows the default.  Furthermore, if you change the
-variable @code{minibuffer-eldef-shorten-default} to a non-@code{nil}
-value, the default argument is displayed as @samp{[@var{default-arg}]}
-instead of @samp{(default @var{default-arg})}, saving some screen
-space.  To enable this minor mode, type @kbd{M-x
+prompt again shows the default.  To enable this minor mode, type @kbd{M-x
 minibuffer-electric-default-mode}.

   Since the minibuffer appears in the echo area, it can conflict with
diff --git a/lisp/minibuf-eldef.el b/lisp/minibuf-eldef.el
index f67ec353c8..039d0f8828 100644
--- a/lisp/minibuf-eldef.el
+++ b/lisp/minibuf-eldef.el
@@ -56,7 +56,9 @@ minibuffer-default--in-prompt-regexps
      ("\\( \\[.*\\]\\):? *\\'" 1))))

 (defcustom minibuffer-eldef-shorten-default nil
-  "If non-nil, shorten \"(default ...)\" to \"[...]\" in minibuffer prompts."
+  "If non-nil, shorten \"(default ...)\" to \"[...]\" in minibuffer prompts.
+This only takes effect if `minibuffer-electric-default-mode' is
+active."
   :set (lambda (symbol value)
          (set-default symbol value)
 	 (setq-default minibuffer-default-in-prompt-regexps
@@ -183,7 +185,9 @@ minibuffer-electric-default-mode
 the default when it's applicable -- that is, when hitting RET
 would yield the default value.  If the user modifies the input
 such that hitting RET would enter a non-default value, the prompt
-is modified to remove the default indication."
+is modified to remove the default indication.
+
+See also the user option `minibuffer-eldef-shorten-default'."
   :global t
   :group 'minibuffer
   (if minibuffer-electric-default-mode

Message #23 received at 50935 <at> debbugs.gnu.org (full text, mbox):

From: Juri Linkov <juri <at> linkov.net>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 50935 <at> debbugs.gnu.org
Subject: Re: bug#50935: minibuffer-electric-default-mode interface
Date: Mon, 04 Oct 2021 20:22:45 +0300

> I think instead of documenting all that, we could just delete the
> reference to `minibuffer-eldef-shorten-default' from the manual, as it
> is the same thing as `minibuffer-default-prompt-format', just with a
> different interface.  Of course, the latter is not yet perfect, but
> anywhere it isn't, that's just a bug, right?  That option would look
> like the below diff.
>
> Another option is to just add a reference to
> 'minibuffer-default-prompt-format' without any deletions, basically
> accepting that the text is not perfect and move on.
>
> A third option is to add 'minibuffer-default-prompt-format' on emacs-28,
> but make the suggested deletion on master -- which give us more time to
> get `minibuffer-default-prompt-format' up to scrap.
>
> Thoughts?

I guess the answer depends on the question how many prompts
are already converted to 'minibuffer-default-prompt-format',
and how many remain.  I checked a few commands, and noticed
only one command that doesn't use the new format.  It's 'M-.'
('xref-find-definitions').  But maybe it can't use the new option
'minibuffer-default-prompt-format' because xref.el should be
available in old versions?  Still it could use

  (if (boundp 'minibuffer-default-prompt-format) ...

Message #26 received at 50935 <at> debbugs.gnu.org (full text, mbox):

From: Juri Linkov <juri <at> linkov.net>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 50935 <at> debbugs.gnu.org
Subject: Re: bug#50935: minibuffer-electric-default-mode interface
Date: Tue, 05 Oct 2021 09:43:49 +0300

[Message part 1 (text/plain, inline)]

> A third option is to add 'minibuffer-default-prompt-format' on emacs-28,
> but make the suggested deletion on master -- which give us more time to
> get `minibuffer-default-prompt-format' up to scrap.
>
> Thoughts?

Thanks for adding format-prompt to many more prompts.  I noticed
that when minibuffer-default-prompt-format is customized to the
recommended format " [%s]", then the prompt of proced-send-signal
is confusing with two pairs of the same brackets:

  Send signal [3 processes] [TERM]:

The following patch makes the prompt more readable:

  Send signal to 3 processes [TERM]:

[proced-send-signal.patch (text/x-diff, inline)]

diff --git a/lisp/proced.el b/lisp/proced.el
index 29996068f9..cb66d68302 100644
--- a/lisp/proced.el
+++ b/lisp/proced.el
@@ -1773,7 +1773,7 @@ proced-send-signal
            `(:annotation-function
              ,(lambda (s) (cdr (assoc s proced-signal-list))))))
      (proced-with-processes-buffer process-alist
-       (list (completing-read (format-prompt "Send signal [%s]"
+       (list (completing-read (format-prompt "Send signal to %s"
                                              "TERM" pnum)
                               proced-signal-list
                               nil nil nil nil "TERM")
@@ -1798,7 +1798,7 @@ proced-send-signal
              `(:annotation-function
                ,(lambda (s) (cdr (assoc s proced-signal-list))))))
         (proced-with-processes-buffer process-alist
-          (setq signal (completing-read (format-prompt "Send signal [%s]"
+          (setq signal (completing-read (format-prompt "Send signal to %s"
                                                        "TERM" pnum)
                                         proced-signal-list
                                         nil nil nil nil "TERM"))))))

Message #29 received at 50935 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Juri Linkov <juri <at> linkov.net>
Cc: 50935 <at> debbugs.gnu.org
Subject: Re: bug#50935: minibuffer-electric-default-mode interface
Date: Tue, 5 Oct 2021 10:11:11 -0400

Juri Linkov <juri <at> linkov.net> writes:

> The following patch makes the prompt more readable:
>
>   Send signal to 3 processes [TERM]:

Sounds good to me.

BTW, did you send the right patch?  I can't see the word "processes"
below.

> diff --git a/lisp/proced.el b/lisp/proced.el
> index 29996068f9..cb66d68302 100644
> --- a/lisp/proced.el
> +++ b/lisp/proced.el
> @@ -1773,7 +1773,7 @@ proced-send-signal
>             `(:annotation-function
>               ,(lambda (s) (cdr (assoc s proced-signal-list))))))
>       (proced-with-processes-buffer process-alist
> -       (list (completing-read (format-prompt "Send signal [%s]"
> +       (list (completing-read (format-prompt "Send signal to %s"
>                                               "TERM" pnum)
>                                proced-signal-list
>                                nil nil nil nil "TERM")
> @@ -1798,7 +1798,7 @@ proced-send-signal
>               `(:annotation-function
>                 ,(lambda (s) (cdr (assoc s proced-signal-list))))))
>          (proced-with-processes-buffer process-alist
> -          (setq signal (completing-read (format-prompt "Send signal [%s]"
> +          (setq signal (completing-read (format-prompt "Send signal to %s"
>                                                         "TERM" pnum)
>                                          proced-signal-list
>                                          nil nil nil nil "TERM"))))))

Message #32 received at 50935 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 50935 <at> debbugs.gnu.org, juri <at> linkov.net
Subject: Re: bug#50935: minibuffer-electric-default-mode interface
Date: Tue, 05 Oct 2021 18:52:11 +0300

> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Tue, 5 Oct 2021 10:11:11 -0400
> Cc: 50935 <at> debbugs.gnu.org
> 
> Juri Linkov <juri <at> linkov.net> writes:
> 
> > The following patch makes the prompt more readable:
> >
> >   Send signal to 3 processes [TERM]:
> 
> Sounds good to me.

It could be confusing.  Previously, the prompt was

  Send signal [TERM]

So it was much more clear that "TERM" refers to "signal" and vice
versa.  Now we have "3 processes" in the way, and someone could think
"TERM" refers to the processes or something.

How about this instead:

  Signal N processes with [SIGTERM]:

Note that I deliberately added the "SIG" part so that it would be more
clear this is the name of a signal.

Message #35 received at 50935 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Juri Linkov <juri <at> linkov.net>
Cc: 50935 <at> debbugs.gnu.org
Subject: Re: bug#50935: minibuffer-electric-default-mode interface
Date: Tue, 5 Oct 2021 12:55:52 -0400

[Message part 1 (text/plain, inline)]

tags 50935 + patch
thanks

Juri Linkov <juri <at> linkov.net> writes:

>> A third option is to add 'minibuffer-default-prompt-format' on emacs-28,
>> but make the suggested deletion on master -- which give us more time to
>> get `minibuffer-default-prompt-format' up to scrap.
>
> I guess the answer depends on the question how many prompts
> are already converted to 'minibuffer-default-prompt-format',
> and how many remain.  I checked a few commands, and noticed
> only one command that doesn't use the new format.  It's 'M-.'
> ('xref-find-definitions').  But maybe it can't use the new option
> 'minibuffer-default-prompt-format' because xref.el should be
> available in old versions?  Still it could use
>
>   (if (boundp 'minibuffer-default-prompt-format) ...

I've now updated any prompt I could find to use `format-prompt' (by
grepping for " (default ").  Maybe I've missed one or two, but that
should mean that that the overwhelming majority of our prompts now
respect `minibuffer-default-prompt-format'.  See commit 6640942221.

With that, I think the option `minibuffer-eldef-shorten-default' should
be declared obsolete, as in the attached patch, and consequently removed
from the manual.  This change should go to master, of course.

The command `minibuffer-electric-default-mode' shouldn't be declared
obsolete as it does something different.

[0001-Make-minibuffer-eldef-shorten-default-obsolete.patch (text/x-diff, attachment)]

Message #40 received at 50935 <at> debbugs.gnu.org (full text, mbox):

From: Juri Linkov <juri <at> linkov.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Stefan Kangas <stefan <at> marxist.se>, 50935 <at> debbugs.gnu.org
Subject: Re: bug#50935: minibuffer-electric-default-mode interface
Date: Tue, 05 Oct 2021 19:46:56 +0300

>> > The following patch makes the prompt more readable:
>> >
>> >   Send signal to 3 processes [TERM]:
>>
>> Sounds good to me.
>
> It could be confusing.  Previously, the prompt was
>
>   Send signal [TERM]

The previous prompt was:

    Send signal [3 processes] (default TERM):

or with customized minibuffer-default-prompt-format:

    Send signal [3 processes] [TERM]:

This was too confusing.

> So it was much more clear that "TERM" refers to "signal" and vice
> versa.  Now we have "3 processes" in the way, and someone could think
> "TERM" refers to the processes or something.
>
> How about this instead:
>
>   Signal N processes with [SIGTERM]:
>
> Note that I deliberately added the "SIG" part so that it would be more
> clear this is the name of a signal.

Sorry, the phrase "Signal N processes" is too difficult to comprehend -
it's diffucult to see that "signal" is a verb here.

Message #43 received at 50935 <at> debbugs.gnu.org (full text, mbox):

From: Juri Linkov <juri <at> linkov.net>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 50935 <at> debbugs.gnu.org
Subject: Re: bug#50935: minibuffer-electric-default-mode interface
Date: Tue, 05 Oct 2021 19:42:54 +0300

>> The following patch makes the prompt more readable:
>>
>>   Send signal to 3 processes [TERM]:
>
> Sounds good to me.
>
> BTW, did you send the right patch?  I can't see the word "processes"
> below.

You can see the word "processes" in the source code
outside of the patch diff context ;-)

Message #46 received at 50935 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 50935 <at> debbugs.gnu.org, Juri Linkov <juri <at> linkov.net>
Subject: Re: bug#50935: minibuffer-electric-default-mode interface
Date: Fri, 02 Sep 2022 14:51:54 +0200

Stefan Kangas <stefan <at> marxist.se> writes:

> I've now updated any prompt I could find to use `format-prompt' (by
> grepping for " (default ").  Maybe I've missed one or two, but that
> should mean that that the overwhelming majority of our prompts now
> respect `minibuffer-default-prompt-format'.  See commit 6640942221.
>
> With that, I think the option `minibuffer-eldef-shorten-default' should
> be declared obsolete, as in the attached patch, and consequently removed
> from the manual.  This change should go to master, of course.
>
> The command `minibuffer-electric-default-mode' shouldn't be declared
> obsolete as it does something different.

Makes sense to me, so I've now pushed this to Emacs 29 and am closing
this bug report.

Previous Next

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