[bug#61163] [PATCH] gnu: emacs-pretty-speedbar: New package.

[bug#61163] [PATCH] gnu: emacs-pretty-speedbar: New package.

[Martin Marshall]

* gnu/packages/emacs-xyz.scm (emacs-pretty-speedbar): New package.
---
 gnu/packages/emacs-xyz.scm | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index ad3603b205..e1dd10fe9c 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -6952,6 +6952,31 @@ (define-public emacs-sqlite3-api
 SQLite C interface, but should satisfy most user's needs.")
     (license license:gpl3+)))
 
+(define-public emacs-pretty-speedbar
+  (let ((commit "56dc9f114fcc55843e182cde1fc9d7a14c261c6a")
+        (revision "0"))
+    (package
+      (name "emacs-pretty-speedbar")
+      (version "0.2")
+      (source (origin
+                (uri (git-reference
+                      (url "https://github.com/kcyarn/pretty-speedbar")
+                      (commit commit)))
+                (method git-fetch)
+                (file-name (git-file-name name version))
+                (sha256
+                 (base32
+                  "1hz67jhvg9n9d07lil6zqciqhh512k0fv54dl605p7vi704ma2ir"))))
+      (build-system emacs-build-system)
+      (propagated-inputs (list font-awesome))
+      (home-page "https://github.com/kcyarn/pretty-speedbar")
+      (synopsis "SVG icons for Emacs Speedbar")
+      (description
+       "Generate and implement appealing SVG icons for the Emacs Speedbar.  By
+default, it generates icons from the Font Awesome fontset but can use
+alternative fonts.  The color of the icons may also be customized.")
+      (license license:gpl3+))))
+
 (define-public emacs-sr-speedbar
   (let ((commit "77a83fb50f763a465c021eca7343243f465b4a47")
         (revision "0"))

base-commit: 1bed1d848166a4081051b4e87a5ec4942ddb3397
-- 
2.39.1

[bug#61163] [PATCH] gnu: emacs-pretty-speedbar: New package.

[Nicolas Goaziou]

Hello,

Martin Marshall <law@martinmarshall.com> writes:

> * gnu/packages/emacs-xyz.scm (emacs-pretty-speedbar): New package.

Thank you. Some comments follow.

> +(define-public emacs-pretty-speedbar
> +  (let ((commit "56dc9f114fcc55843e182cde1fc9d7a14c261c6a")
> +        (revision "0"))
> +    (package
> +      (name "emacs-pretty-speedbar")
> +      (version "0.2")

This should be (git-version "0.2" revision commit) since you're not
using the exact commit where the version bump happened.

> +      (source (origin
> +                (uri (git-reference
> +                      (url "https://github.com/kcyarn/pretty-speedbar")
> +                      (commit commit)))
> +                (method git-fetch)
> +                (file-name (git-file-name name version))
> +                (sha256
> +                 (base32
> +                  "1hz67jhvg9n9d07lil6zqciqhh512k0fv54dl605p7vi704ma2ir"))))
> +      (build-system emacs-build-system)
> +      (propagated-inputs (list font-awesome))

It seems the project requires Font Awesome 6, but Guix only provides
version 4. Is it an issue?

It may be worth considering updating font-awesome in Guix first, but
I don't know what its freedom status is nowadays (as a data point,
Parabola provides it, tho).

> +      (description
> +       "Generate and implement appealing SVG icons for the Emacs
> Speedbar.  

This is not a complete sentence.

Could you send an updated patch?

Regards,
-- 
Nicolas Goaziou

[bug#61163] [PATCH] gnu: emacs-pretty-speedbar: New package.

[Martin Marshall]

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

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

>> +      (propagated-inputs (list font-awesome))
>
> It seems the project requires Font Awesome 6, but Guix only provides
> version 4. Is it an issue?

I don't think so.  While the default value of the `pretty-speedbar-font'
user-setting is "Font Awesome 6 Free Solid", the setting is
customizable, and any icon font may be used with the package.

Even with the default value of `pretty-speedbar-font' unchanged, my
system automatically uses the Font Awesome 4 fonts provided by Guix's
font-awesome package.

> It may be worth considering updating font-awesome in Guix first, but
> I don't know what its freedom status is nowadays (as a data point,
> Parabola provides it, tho).

There is a comment to its package definition stating this:

   ;; XXX The build scripts of version 5 are not freely licensed and
   ;; so we have to stick with version 4 for now:
   ;; <https://bugs.gnu.org/32916>

The linked discussion from 2018 concluded with all participants agreeing
that distribution of version 5 or higher would violate the Gnu FSDG.

I reviewed the Font Awesome GitHub Issues, and it seems they remain
unwilling to change the licensing terms for the build scripts, the matter
having been raised as late as March 2022.

There is a fork of Font Awesome whose stated goals are "to continue
building the amazing resource in a fully free, libre and open-source
fashion" (https://github.com/ForkAwesome/Fork-Awesome).  I haven't
used it though.

>> +      (description
>> +       "Generate and implement appealing SVG icons for the Emacs
>> Speedbar.  
>
> This is not a complete sentence.
>
> Could you send an updated patch?

Thank you for this and the other feedback provided.

I've rewritten the description along with the other suggested changes.

An updated patch is attached.

Warm regards,

-- 
Martin Marshall
law@martinmarshall.com

[-- Attachment #2: ~/Projects/guix/patches/0001-gnu-Add-emacs-pretty-speedbar.patch --]
[-- Type: message/external-body, Size: 111 bytes --]

[bug#61163] [PATCH] gnu: emacs-pretty-speedbar: New package.

[Martin Marshall]

[-- Attachment #1.1: Type: text/plain, Size: 2328 bytes --]

> An updated patch is attached.

I believe something happened to the attachment in my reply,
either in transit or before sending.  (I'm new to sending
attachments with Gnus.)

Hopefully this time will work better.

-- 
Martin Marshall
law@martinmarshall.com

On Tue, Jan 31, 2023 at 12:54 PM Martin Marshall <law@martinmarshall.com>
wrote:

> Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:
>
> >> +      (propagated-inputs (list font-awesome))
> >
> > It seems the project requires Font Awesome 6, but Guix only provides
> > version 4. Is it an issue?
>
> I don't think so.  While the default value of the `pretty-speedbar-font'
> user-setting is "Font Awesome 6 Free Solid", the setting is
> customizable, and any icon font may be used with the package.
>
> Even with the default value of `pretty-speedbar-font' unchanged, my
> system automatically uses the Font Awesome 4 fonts provided by Guix's
> font-awesome package.
>
> > It may be worth considering updating font-awesome in Guix first, but
> > I don't know what its freedom status is nowadays (as a data point,
> > Parabola provides it, tho).
>
> There is a comment to its package definition stating this:
>
>    ;; XXX The build scripts of version 5 are not freely licensed and
>    ;; so we have to stick with version 4 for now:
>    ;; <https://bugs.gnu.org/32916>
>
> The linked discussion from 2018 concluded with all participants agreeing
> that distribution of version 5 or higher would violate the Gnu FSDG.
>
> I reviewed the Font Awesome GitHub Issues, and it seems they remain
> unwilling to change the licensing terms for the build scripts, the matter
> having been raised as late as March 2022.
>
> There is a fork of Font Awesome whose stated goals are "to continue
> building the amazing resource in a fully free, libre and open-source
> fashion" (https://github.com/ForkAwesome/Fork-Awesome).  I haven't
> used it though.
>
> >> +      (description
> >> +       "Generate and implement appealing SVG icons for the Emacs
> >> Speedbar.
> >
> > This is not a complete sentence.
> >
> > Could you send an updated patch?
>
> Thank you for this and the other feedback provided.
>
> I've rewritten the description along with the other suggested changes.
>
> An updated patch is attached.
>
> Warm regards,
>
> --
> Martin Marshall
> law@martinmarshall.com
>

[-- Attachment #1.2: Type: text/html, Size: 3417 bytes --]

[-- Attachment #2: 0001-gnu-Add-emacs-pretty-speedbar.patch --]
[-- Type: text/x-patch, Size: 2109 bytes --]

From ba6c868b90504b5337ef14be8ee410a3ddad5890 Mon Sep 17 00:00:00 2001
Message-Id: <ba6c868b90504b5337ef14be8ee410a3ddad5890.1675183346.git.law@martinmarshall.com>
From: Martin Marshall <law@martinmarshall.com>
Date: Tue, 31 Jan 2023 11:38:47 -0500
Subject: [PATCH] gnu: Add emacs-pretty-speedbar.

* gnu/packages/emacs-xyz.scm (emacs-pretty-speedbar): Add variable.
---
 gnu/packages/emacs-xyz.scm | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index ba2916a463..3c8c201145 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -6975,6 +6975,32 @@ (define-public emacs-sqlite3-api
 SQLite C interface, but should satisfy most user's needs.")
     (license license:gpl3+)))
 
+(define-public emacs-pretty-speedbar
+  (let ((commit "56dc9f114fcc55843e182cde1fc9d7a14c261c6a")
+        (revision "0"))
+    (package
+      (name "emacs-pretty-speedbar")
+      (version (git-version "0.2" revision commit))
+      (source (origin
+                (uri (git-reference
+                      (url "https://github.com/kcyarn/pretty-speedbar")
+                      (commit commit)))
+                (method git-fetch)
+                (file-name (git-file-name name version))
+                (sha256
+                 (base32
+                  "1hz67jhvg9n9d07lil6zqciqhh512k0fv54dl605p7vi704ma2ir"))))
+      (build-system emacs-build-system)
+      (propagated-inputs (list font-awesome))
+      (home-page "https://github.com/kcyarn/pretty-speedbar")
+      (synopsis "SVG icons for the Emacs Speedbar")
+      (description
+       "This package generates and implements appealing SVG icons for the
+Emacs Speedbar.  By default, it generates icons from the Font Awesome fontset.
+However, alternative fontsets may also be used, and the color of the icons may
+be customized.")
+      (license license:gpl3+))))
+
 (define-public emacs-sr-speedbar
   (let ((commit "77a83fb50f763a465c021eca7343243f465b4a47")
         (revision "0"))
-- 
2.39.1

bug#61163: [PATCH] gnu: emacs-pretty-speedbar: New package.

[Nicolas Goaziou]

Hello,

> Hopefully this time will work better.

It does. Applied, thank you!

Regards,
-- 
Nicolas Goaziou