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

Previous Next

Full log

View this message in rfc822 format

From: Vincenzo Pupillo <v.pupillo <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 76789 <at> debbugs.gnu.org
Subject: 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)]

Previous Next

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