From: Juri Linkov <juri@linkov.net>
To: Mauro Aranda <maurooaranda@gmail.com>
Cc: 65874@debbugs.gnu.org
Subject: bug#65874: 30.0.50; outline-minor-mode-use-buttons missing choice
Date: Wed, 13 Sep 2023 09:51:06 +0300 [thread overview]
Message-ID: <86o7i6wopx.fsf@mail.linkov.net> (raw)
In-Reply-To: <b236fa73-57b2-794f-2617-d974b6f9b0c2@gmail.com> (Mauro Aranda's message of "Tue, 12 Sep 2023 06:55:57 -0300")
[-- Attachment #1: Type: text/plain, Size: 682 bytes --]
>>> The docstring for outline-minor-mode-use-buttons says its value can be
>>> the symbol insert, but that choice is not present in its :type.
>>>
>>> I can't send a patch, because I can't figure out a good :tag for it.
>>
>> Such omission is intentional, because 'insert' can be used only
>> in generated buffers, not in editable buffers, so disallowing
>> customization to the value 'insert' protects the users
>> from damaging editable buffers.
>
> I see, thanks. How about adding something to the docstring some text to
> explain that? And/or maybe add a comment in the :type to clarify that
> the omission is intentional?
Maybe something like this for the emacs-29 branch?
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: outline-minor-mode-use-buttons-insert.patch --]
[-- Type: text/x-diff, Size: 2067 bytes --]
diff --git a/doc/emacs/text.texi b/doc/emacs/text.texi
index 3d3f2562617..6f57bae8fef 100644
--- a/doc/emacs/text.texi
+++ b/doc/emacs/text.texi
@@ -1024,10 +1024,11 @@ Outline Minor Mode
mouse on the button toggles display of the section. If the value of
this variable is @code{insert}, the buttons are inserted directly into
the buffer text, so @key{RET} on the button will also toggle display
-of the section, like a mouse click does. If the value is
-@code{in-margins}, Outline minor mode will use the window margins to
-indicate that a section is hidden. The buttons are customizable as icons
-(@pxref{Icons}).
+of the section, like a mouse click does. Using the value @code{insert}
+is not recommended in editable buffers because it modifies them.
+If the value is @code{in-margins}, Outline minor mode will use the
+window margins to indicate that a section is hidden. The buttons are
+customizable as icons (@pxref{Icons}).
@vindex outline-minor-mode-cycle
If the @code{outline-minor-mode-cycle} user option is
diff --git a/lisp/outline.el b/lisp/outline.el
index 97a51c9b92a..7cdfec753d1 100644
--- a/lisp/outline.el
+++ b/lisp/outline.el
@@ -314,12 +314,15 @@ outline-minor-mode-use-buttons
When the value is `insert', additional placeholders for buttons are
inserted to the buffer, so buttons are not only clickable,
but also typing `RET' on them can hide and show the body.
+Using the value `insert' is not recommended in editable
+buffers because it modifies them.
When the value is `in-margins', then clickable buttons are
displayed in the margins before the headings.
When the value is `t', clickable buttons are displayed
in the buffer before the headings. The values `t' and
`in-margins' can be used in editing buffers because they
don't modify the buffer."
+ ;; The value `insert' is not intended to be customizable.
:type '(choice (const :tag "Do not use outline buttons" nil)
(const :tag "Show outline buttons in margins" in-margins)
(const :tag "Show outline buttons in buffer" t))
next prev parent reply other threads:[~2023-09-13 6:51 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-11 19:12 bug#65874: 30.0.50; outline-minor-mode-use-buttons missing choice Mauro Aranda
2023-09-12 6:59 ` Juri Linkov
2023-09-12 9:55 ` Mauro Aranda
2023-09-13 6:51 ` Juri Linkov [this message]
2023-09-13 15:24 ` Mauro Aranda
2023-09-13 16:50 ` Juri Linkov
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=86o7i6wopx.fsf@mail.linkov.net \
--to=juri@linkov.net \
--cc=65874@debbugs.gnu.org \
--cc=maurooaranda@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.