GNU bug report logs - #76789
31.0.50; [PATCH] speedbar: New speedbar-window-mode

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 76789 in the body.
You can then email your comments to 76789 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: Vincenzo Pupillo <v.pupillo <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 31.0.50; [PATCH] speedbar: New speedbar-window-mode
Date: Thu, 06 Mar 2025 21:42:12 +0100

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

Ciao,
this patch adds speedbar-window-mode as an alternative to the default 
speedbar-frame-mode. Calling speedbar-window-mode will close speedbar-frame-
mode if it is open, and vice versa.
speedbar-window-mode, thanks to display-buffer-in-side-window, can be placed 
on the left side, right side but also on the top or bottom. 

Thank you.

Vincenzo

[0001-Add-a-new-command-speedbar-window.patch (text/x-patch, attachment)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Vincenzo Pupillo <v.pupillo <at> gmail.com>
Cc: 76789 <at> debbugs.gnu.org
Subject: Re: bug#76789: 31.0.50; [PATCH] speedbar: New speedbar-window-mode
Date: Fri, 07 Mar 2025 08:50:23 +0200

> From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
> Date: Thu, 06 Mar 2025 21:42:12 +0100
> 
> Ciao,
> this patch adds speedbar-window-mode as an alternative to the default 
> speedbar-frame-mode. Calling speedbar-window-mode will close speedbar-frame-
> mode if it is open, and vice versa.
> speedbar-window-mode, thanks to display-buffer-in-side-window, can be placed 
> on the left side, right side but also on the top or bottom. 

Thanks, a few comments below.

> +(defcustom speedbar-window-default-width 20
> +  "Initial width of `speedbar-window' under window system.
> +The default value is the same width of `speedbar-frame-mode'."
> +  :type 'integer
> +  :group 'speedbar
> +  :version "31.1")
> +
> +(defcustom speedbar-window-max-width 40
> +  "The maximum allowed `speedbar-window' width limit."
> +  :type 'integer
> +  :group 'speedbar
> +  :version "31.1")

These two options should document in their doc strings the units in
which the dimensions are measured.

> +(defun speedbar (&optional arg)
> +  "Open or close the `speedbar'.  Positive ARG means turn on, negative turn off.

The first line of a doc string should be a single complete sentence.

> +A nil ARG means toggle.  When `speedbar-prefer-window' open the
> +speedbar in a window istead of in a frame."

This should say what happens if speedbar-prefer-window is nil.  Also,
please don't use "when" to indicate a condition (as opposed to
something related to time), as it could be misinterpreted.

> +(defalias 'speedbar-frame 'speedbar-frame-mode)

This alias should be in NEWS.

Speedbar has its own manual.  Did you consider updating that manual
with this new feature?

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

From: Angelo Graziosi <angelo.g0 <at> libero.it>
To: 76789 <at> debbugs.gnu.org
Subject: Re: 31.0.50; [PATCH] speedbar: New speedbar-window-mode
Date: Sat, 8 Mar 2025 17:12:32 +0100

Ciao Vincenzo,

me too used sr-speedbar for years. Now I have built Emacs with your 
patch and it looks good. Thanks.

Ciao,
  Angelo.

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

From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 76789 <at> debbugs.gnu.org
Subject: Re: bug#76789: 31.0.50; [PATCH] speedbar: New speedbar-window-mode
Date: Sat, 08 Mar 2025 23:06:13 +0100

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

Ciao Eli,

In data venerdì 7 marzo 2025 07:50:23 Ora standard dell’Europa centrale, Eli 
Zaretskii ha scritto:
> > From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
> > Date: Thu, 06 Mar 2025 21:42:12 +0100
> > 
> > Ciao,
> > this patch adds speedbar-window-mode as an alternative to the default
> > speedbar-frame-mode. Calling speedbar-window-mode will close
> > speedbar-frame- mode if it is open, and vice versa.
> > speedbar-window-mode, thanks to display-buffer-in-side-window, can be
> > placed on the left side, right side but also on the top or bottom.
> 
> Thanks, a few comments below.
> 
> > +(defcustom speedbar-window-default-width 20
> > +  "Initial width of `speedbar-window' under window system.
> > +The default value is the same width of `speedbar-frame-mode'."
> > +  :type 'integer
> > +  :group 'speedbar
> > +  :version "31.1")
> > +
> > +(defcustom speedbar-window-max-width 40
> > +  "The maximum allowed `speedbar-window' width limit."
> > +  :type 'integer
> > +  :group 'speedbar
> > +  :version "31.1")
> 
> These two options should document in their doc strings the units in
> which the dimensions are measured.

Done.

> 
> > +(defun speedbar (&optional arg)
> > +  "Open or close the `speedbar'.  Positive ARG means turn on, negative
> > turn off.
> The first line of a doc string should be a single complete sentence.
> 

Done.
> > +A nil ARG means toggle.  When `speedbar-prefer-window' open the
> > +speedbar in a window istead of in a frame."
> 
> This should say what happens if speedbar-prefer-window is nil.  Also,
> please don't use "when" to indicate a condition (as opposed to
> something related to time), as it could be misinterpreted.
> 

Done.

> > +(defalias 'speedbar-frame 'speedbar-frame-mode)
> 
> This alias should be in NEWS.
> 

Done.
In addition, I fixed the speedbar menu so that it also works properly with 
speedbar-window.

> Speedbar has its own manual.  Did you consider updating that manual
> with this new feature?
I wrote something in speedbar.texi (not included in this patch), but I also 
saw that the emacs manual has section 18.9 Speedbar Frame (chapter 18 Frames 
and Graphical Display), and I am not sure how to edit it.

Thank.

Vincenzo

[0001-Add-a-new-command-speedbar-window.patch (text/x-patch, attachment)]

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

From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
To: 76789 <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org
Cc: Angelo Graziosi <angelo.g0 <at> libero.it>
Subject: Re: bug#76789: 31.0.50; [PATCH] speedbar: New speedbar-window-mode
Date: Sat, 08 Mar 2025 23:34:22 +0100

In data sabato 8 marzo 2025 17:12:32 Ora standard dell’Europa centrale, Angelo 
Graziosi ha scritto:
> Ciao Vincenzo,
> 
> me too used sr-speedbar for years. Now I have built Emacs with your
> patch and it looks good. Thanks.
> 
> Ciao,
>    Angelo.
Grazie Angelo!

Vincenzo

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Vincenzo Pupillo <v.pupillo <at> gmail.com>
Cc: 76789 <at> debbugs.gnu.org
Subject: Re: bug#76789: 31.0.50; [PATCH] speedbar: New speedbar-window-mode
Date: Sun, 09 Mar 2025 08:53:50 +0200

> From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
> Cc: 76789 <at> debbugs.gnu.org
> Date: Sat, 08 Mar 2025 23:06:13 +0100
> 
> > Speedbar has its own manual.  Did you consider updating that manual
> > with this new feature?
> I wrote something in speedbar.texi (not included in this patch), but I also 
> saw that the emacs manual has section 18.9 Speedbar Frame (chapter 18 Frames 
> and Graphical Display), and I am not sure how to edit it.

Just add short text there saying that speedbar can optionally be
displayed as a window, not a frame.  That section has a reference to
the Speedbar manual, so the details are covered by that.

Thanks.  Please see a few more comments below.

> +*** The new command 'speedbar-window-mode' open Speedbar in a window instead
> +of a frame.                                ^^^^

"opens"

> +*** New alias 'speedbar-window' is an alias for 'speedbar-window-mode'.

"New command 'speedbar-window' is an alias for 'speedbar-window-mode'."

> +*** The new user option 'speedbar-prefer-window', tell 'speedbar' to open
> +a side window instead of a frame.                 ^^^^

"tells"

> +(defcustom speedbar-prefer-window nil
> +  "If t, the command `speedbar' open the speedbar in a window."
                                   ^^^^
"opens"

> +(defcustom speedbar-window-dedicated-window t
> +  "Make the `speedbar-window' dedicated."

"Whether to make the `speedbar-window' dedicated."

> +  :group 'speedbar
> +  :type 'boolean
> +  :version "31.1")
> +
> +(defcustom speedbar-window-side 'left
> +  "Show the `speedbar-window' on the `left', `right', `top' or `bottom'.
> +See `display-buffer-in-side-window' for more details."

Our style is to make the first line of the doc string a kind of
summary:

    "Control the side of the frame on which to show the speedbar window.
  The value can be `left', `right', `top' or `bottom'.
  See `display-buffer-in-side-window' for more details."

> +(defcustom speedbar-window-default-width 20
> +  "Initial width in characters of `speedbar-window' under window system.

Why "under window system"?  Doesn't this work on TTY frames in the
same way?

> +(defcustom speedbar-window-max-width 40
> +  "The maximum allowed width in characters of the `speedbar-window'."

This begs the question: what happens with wider items?  I suggest to
tell that in the doc string.

> +(defun speedbar-easymenu-definition-trailer ()
> +  "Menu items appearing at the end of the speedbar menu."

I guess you meant "Return menu items appearing..."?

> +A nil ARG means toggle.  If `speedbar-prefer-window' is t, open the
> +speedbar in a window istead of in a frame."
                        ^^^^^^^^^^^^^^^^^^^^
"...instead of in a separate frame" is better here, because any Emacs
display is always "in a frame", even if it's in some window.

> +(defun speedbar-is-frame-or-window-p ()

This function is not a predicate, since its value is not a boolean.
So its name should be something like speedbar-frame-or-window, without
"is" and without "-p".

> +(defun speedbar-window-mode (&optional arg)
> +  "Enable or disable speedbar window.

I suggest

  Enable or disable speedbar window mode.

or

  "Enable or disable speedbar display in a separate window.

> +(defsubst speedbar-window--window-live-p ()
> +    "Return non-nil if  `speedbar--window' is defined and live."
                         ^^
Excess whitespace there.

> +(defsubst speedbar-window--buffer-live-p ()
> +    "Return non-nil `speedbar-buffer' is defined and live."
                      ^^
"if" is missing there.  Also, what do you mean by "buffer is defined"?
I suggest to remove it and leave only "buffer is live".

> +(defun speedbar-window--live-p ()
> +  "Return t if `speedbar-window' is opened."
                                    ^^^^^^^^^
I suggest "is live" or "is displayed".

> +(defsubst speedbar-window-current-window ()
> +  "Return t if the current windows is the `speedbar--window'."

"Return t if the selected window is the `speedbar--window'."

> +(defsubst speedbar-window--width ()
> +  "Return the width of `speedbar-window' WINDOW."
                                            ^^^^^^
This function has no argument named WINDOW.

> +(defun speedbar-width ()
> +  "Returns the width of the `speedbar'.
      ^^^^^^^
"Return"

> +(defun speedbar--speedbar-live-p ()
> +  "Return non-nil if `speedbar-window-mode' or `speedbar-frame-mode' are open."
                                                                        ^^^^^^^^^

"are active", I think?

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

From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 76789 <at> debbugs.gnu.org
Subject: Re: bug#76789: 31.0.50; [PATCH] speedbar: New speedbar-window-mode
Date: Tue, 11 Mar 2025 16:41:22 +0100

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

Thank you Eli. 
In this updated version of the patch I corrected what you indicated and added 
something in the manual, rather short :-(.

Thanks.
Vincenzo

In data domenica 9 marzo 2025 07:53:50 Ora standard dell’Europa centrale, Eli 
Zaretskii ha scritto:
> > From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
> > Cc: 76789 <at> debbugs.gnu.org
> > Date: Sat, 08 Mar 2025 23:06:13 +0100
> > 
> > > Speedbar has its own manual.  Did you consider updating that manual
> > > with this new feature?
> > 
> > I wrote something in speedbar.texi (not included in this patch), but I
> > also
> > saw that the emacs manual has section 18.9 Speedbar Frame (chapter 18
> > Frames and Graphical Display), and I am not sure how to edit it.
> 
> Just add short text there saying that speedbar can optionally be
> displayed as a window, not a frame.  That section has a reference to
> the Speedbar manual, so the details are covered by that.
> 
> Thanks.  Please see a few more comments below.
> 
> > +*** The new command 'speedbar-window-mode' open Speedbar in a window
> > instead +of a frame.                                ^^^^
> 
> "opens"
> 
> > +*** New alias 'speedbar-window' is an alias for 'speedbar-window-mode'.
> 
> "New command 'speedbar-window' is an alias for 'speedbar-window-mode'."
> 
> > +*** The new user option 'speedbar-prefer-window', tell 'speedbar' to open
> > +a side window instead of a frame.                 ^^^^
> 
> "tells"
> 
> > +(defcustom speedbar-prefer-window nil
> > +  "If t, the command `speedbar' open the speedbar in a window."
> 
>                                    ^^^^
> "opens"
> 
> > +(defcustom speedbar-window-dedicated-window t
> > +  "Make the `speedbar-window' dedicated."
> 
> "Whether to make the `speedbar-window' dedicated."
> 
> > +  :group 'speedbar
> > +  :type 'boolean
> > +  :version "31.1")
> > +
> > +(defcustom speedbar-window-side 'left
> > +  "Show the `speedbar-window' on the `left', `right', `top' or `bottom'.
> > +See `display-buffer-in-side-window' for more details."
> 
> Our style is to make the first line of the doc string a kind of
> summary:
> 
>     "Control the side of the frame on which to show the speedbar window.
>   The value can be `left', `right', `top' or `bottom'.
>   See `display-buffer-in-side-window' for more details."
> 
> > +(defcustom speedbar-window-default-width 20
> > +  "Initial width in characters of `speedbar-window' under window system.
> 
> Why "under window system"?  Doesn't this work on TTY frames in the
> same way?
> 
> > +(defcustom speedbar-window-max-width 40
> > +  "The maximum allowed width in characters of the `speedbar-window'."
> 
> This begs the question: what happens with wider items?  I suggest to
> tell that in the doc string.
> 
> > +(defun speedbar-easymenu-definition-trailer ()
> > +  "Menu items appearing at the end of the speedbar menu."
> 
> I guess you meant "Return menu items appearing..."?
> 
> > +A nil ARG means toggle.  If `speedbar-prefer-window' is t, open the
> > +speedbar in a window istead of in a frame."
> 
>                         ^^^^^^^^^^^^^^^^^^^^
> "...instead of in a separate frame" is better here, because any Emacs
> display is always "in a frame", even if it's in some window.
> 
> > +(defun speedbar-is-frame-or-window-p ()
> 
> This function is not a predicate, since its value is not a boolean.
> So its name should be something like speedbar-frame-or-window, without
> "is" and without "-p".
> 
> > +(defun speedbar-window-mode (&optional arg)
> > +  "Enable or disable speedbar window.
> 
> I suggest
> 
>   Enable or disable speedbar window mode.
> 
> or
> 
>   "Enable or disable speedbar display in a separate window.
> 
> > +(defsubst speedbar-window--window-live-p ()
> > +    "Return non-nil if  `speedbar--window' is defined and live."
> 
>                          ^^
> Excess whitespace there.
> 
> > +(defsubst speedbar-window--buffer-live-p ()
> > +    "Return non-nil `speedbar-buffer' is defined and live."
> 
>                       ^^
> "if" is missing there.  Also, what do you mean by "buffer is defined"?
> I suggest to remove it and leave only "buffer is live".
> 
> > +(defun speedbar-window--live-p ()
> > +  "Return t if `speedbar-window' is opened."
> 
>                                     ^^^^^^^^^
> I suggest "is live" or "is displayed".
> 
> > +(defsubst speedbar-window-current-window ()
> > +  "Return t if the current windows is the `speedbar--window'."
> 
> "Return t if the selected window is the `speedbar--window'."
> 
> > +(defsubst speedbar-window--width ()
> > +  "Return the width of `speedbar-window' WINDOW."
> 
>                                             ^^^^^^
> This function has no argument named WINDOW.
> 
> > +(defun speedbar-width ()
> > +  "Returns the width of the `speedbar'.
> 
>       ^^^^^^^
> "Return"
> 
> > +(defun speedbar--speedbar-live-p ()
> > +  "Return non-nil if `speedbar-window-mode' or `speedbar-frame-mode' are
> > open."
>                                                                        
> ^^^^^^^^^
> 
> "are active", I think?

[0001-Add-a-new-command-speedbar-window.patch (text/x-patch, attachment)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Vincenzo Pupillo <v.pupillo <at> gmail.com>
Cc: 76789 <at> debbugs.gnu.org
Subject: Re: bug#76789: 31.0.50; [PATCH] speedbar: New speedbar-window-mode
Date: Thu, 13 Mar 2025 11:57:41 +0200

> From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
> Cc: 76789 <at> debbugs.gnu.org
> Date: Tue, 11 Mar 2025 16:41:22 +0100
> 
> Thank you Eli. 
> In this updated version of the patch I corrected what you indicated and added 
> something in the manual, rather short :-(.

Thanks.  I meant to install it, but building Emacs after applying the
changes yields warnings:

  In speedbar-frame-or-window:
  speedbar.el:1009:2: Warning: docstring has wrong usage of unescaped single quotes (use \=' or different quoting such as `...')

  In speedbar-window-mode:
  speedbar.el:1045:13: Warning: assignment to free variable `speedbar-select-frame-method'

  In speedbar-window--buffer-live-p:
  speedbar.el:1079:11: Warning: defsubst `speedbar-window--buffer-live-p' was used before it was defined

  In speedbar-window--width:
  speedbar.el:1113:11: Warning: defsubst `speedbar-window--width' was used before it was defined

  In speedbar-current-frame:
  speedbar.el:1135:11: Warning: defsubst `speedbar-current-frame' was used before it was defined

Please fix those.

Also, here:

> +@cindex @code{speedbar-window}
> +Optionally, the speedbar can be displayed as a window, splitting the
> +windows of the selected frame, in both terminal and graphics modes.
> +Only one speedbar window can be open at a time.
> +
> +It is possible to switch from displaying the speedbar in a separate
> +frame to displaying it in a window and vice versa simply by using the
> +@kbd{M-x speedbar-window @key{RET}} or
> +@kbd{M-x speedbar-frame <at> key{RET}} command.

please mention and index the user option you added.

> +** Speedbar
> +
> +---
> +*** The new command 'speedbar-window-mode' opens Speedbar in a window instead
> +of a frame.
> +
> +*** New command 'speedbar-window' is an alias for 'speedbar-window-mode'.
> +'
> +*** The new user option 'speedbar-prefer-window', tells 'speedbar' to open
> +a side window instead of a frame.
> +
> +*** 'speedbar-easymenu-definition-trailer' is now a function.
> +

These NEWS entries should be marked with "+++", since this is now
documented in the relevant manuals.

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

From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 76789 <at> debbugs.gnu.org
Subject: Re: bug#76789: 31.0.50; [PATCH] speedbar: New speedbar-window-mode
Date: Fri, 14 Mar 2025 20:52:33 +0100

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

Thank you Eli for the review,

In data giovedì 13 marzo 2025 10:57:41 Ora standard dell’Europa centrale, Eli 
Zaretskii ha scritto:
> > From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
> > Cc: 76789 <at> debbugs.gnu.org
> > Date: Tue, 11 Mar 2025 16:41:22 +0100
> > 
> > Thank you Eli.
> > In this updated version of the patch I corrected what you indicated and
> > added something in the manual, rather short :-(.
> 
> Thanks.  I meant to install it, but building Emacs after applying the
> changes yields warnings:
> 
>   In speedbar-frame-or-window:
>   speedbar.el:1009:2: Warning: docstring has wrong usage of unescaped single
> quotes (use \=' or different quoting such as `...')
> 
>   In speedbar-window-mode:
>   speedbar.el:1045:13: Warning: assignment to free variable
> `speedbar-select-frame-method'
> 
>   In speedbar-window--buffer-live-p:
>   speedbar.el:1079:11: Warning: defsubst `speedbar-window--buffer-live-p'
> was used before it was defined
> 
>   In speedbar-window--width:
>   speedbar.el:1113:11: Warning: defsubst `speedbar-window--width' was used
> before it was defined
> 
>   In speedbar-current-frame:
>   speedbar.el:1135:11: Warning: defsubst `speedbar-current-frame' was used
> before it was defined
> 
> Please fix those.

Done

> 
> Also, here:
> > +@cindex @code{speedbar-window}
> > +Optionally, the speedbar can be displayed as a window, splitting the
> > +windows of the selected frame, in both terminal and graphics modes.
> > +Only one speedbar window can be open at a time.
> > +
> > +It is possible to switch from displaying the speedbar in a separate
> > +frame to displaying it in a window and vice versa simply by using the
> > +@kbd{M-x speedbar-window @key{RET}} or
> > +@kbd{M-x speedbar-frame <at> key{RET}} command.
> 
> please mention and index the user option you added.
> 
> > +** Speedbar
> > +
> > +---
> > +*** The new command 'speedbar-window-mode' opens Speedbar in a window
> > instead +of a frame.
> > +
> > +*** New command 'speedbar-window' is an alias for 'speedbar-window-mode'.
> > +'
> > +*** The new user option 'speedbar-prefer-window', tells 'speedbar' to
> > open
> > +a side window instead of a frame.
> > +
> > +*** 'speedbar-easymenu-definition-trailer' is now a function.
> > +
> 
> These NEWS entries should be marked with "+++", since this is now
> documented in the relevant manuals.

Done. 

The new version of the patch is attached.

Vincenzo

[0001-Add-a-new-command-speedbar-window.patch (text/x-patch, attachment)]

Message #37 received at 76789-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Vincenzo Pupillo <v.pupillo <at> gmail.com>
Cc: 76789-done <at> debbugs.gnu.org
Subject: Re: bug#76789: 31.0.50; [PATCH] speedbar: New speedbar-window-mode
Date: Sat, 15 Mar 2025 10:54:39 +0200

> From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
> Cc: 76789 <at> debbugs.gnu.org
> Date: Fri, 14 Mar 2025 20:52:33 +0100
> 
> Thank you Eli for the review,
> 
> In data giovedì 13 marzo 2025 10:57:41 Ora standard dell’Europa centrale, Eli 
> Zaretskii ha scritto:
> > > From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
> > > Cc: 76789 <at> debbugs.gnu.org
> > > Date: Tue, 11 Mar 2025 16:41:22 +0100
> > > 
> > > Thank you Eli.
> > > In this updated version of the patch I corrected what you indicated and
> > > added something in the manual, rather short :-(.
> > 
> > Thanks.  I meant to install it, but building Emacs after applying the
> > changes yields warnings:
> > 
> >   In speedbar-frame-or-window:
> >   speedbar.el:1009:2: Warning: docstring has wrong usage of unescaped single
> > quotes (use \=' or different quoting such as `...')
> > 
> >   In speedbar-window-mode:
> >   speedbar.el:1045:13: Warning: assignment to free variable
> > `speedbar-select-frame-method'
> > 
> >   In speedbar-window--buffer-live-p:
> >   speedbar.el:1079:11: Warning: defsubst `speedbar-window--buffer-live-p'
> > was used before it was defined
> > 
> >   In speedbar-window--width:
> >   speedbar.el:1113:11: Warning: defsubst `speedbar-window--width' was used
> > before it was defined
> > 
> >   In speedbar-current-frame:
> >   speedbar.el:1135:11: Warning: defsubst `speedbar-current-frame' was used
> > before it was defined
> > 
> > Please fix those.
> 
> Done
> 
> > 
> > Also, here:
> > > +@cindex @code{speedbar-window}
> > > +Optionally, the speedbar can be displayed as a window, splitting the
> > > +windows of the selected frame, in both terminal and graphics modes.
> > > +Only one speedbar window can be open at a time.
> > > +
> > > +It is possible to switch from displaying the speedbar in a separate
> > > +frame to displaying it in a window and vice versa simply by using the
> > > +@kbd{M-x speedbar-window @key{RET}} or
> > > +@kbd{M-x speedbar-frame <at> key{RET}} command.
> > 
> > please mention and index the user option you added.
> > 
> > > +** Speedbar
> > > +
> > > +---
> > > +*** The new command 'speedbar-window-mode' opens Speedbar in a window
> > > instead +of a frame.
> > > +
> > > +*** New command 'speedbar-window' is an alias for 'speedbar-window-mode'.
> > > +'
> > > +*** The new user option 'speedbar-prefer-window', tells 'speedbar' to
> > > open
> > > +a side window instead of a frame.
> > > +
> > > +*** 'speedbar-easymenu-definition-trailer' is now a function.
> > > +
> > 
> > These NEWS entries should be marked with "+++", since this is now
> > documented in the relevant manuals.
> 
> Done. 
> 
> The new version of the patch is attached.

Thanks, installed on the master branch, and closing the bug.

I needed to make a few minor followup changes; please study them and
try to avoid the same pitfalls in the future.

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

From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 76789-done <at> debbugs.gnu.org
Subject: Re: bug#76789: 31.0.50; [PATCH] speedbar: New speedbar-window-mode
Date: Mon, 17 Mar 2025 11:20:43 +0100

In data sabato 15 marzo 2025 09:54:39 Ora standard dell’Europa centrale, Eli 
Zaretskii ha scritto:

> Thanks, installed on the master branch, and closing the bug.
> 
> I needed to make a few minor followup changes; please study them and
> try to avoid the same pitfalls in the future.

Ok. Thank you.

Vincenzo

Previous Next

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