GNU bug report logs - #77258
[PATCH] New package: emacs-boxy

Previous Next

To reply to this bug, email your comments to 77258 AT debbugs.gnu.org.
There is no need to reopen the bug first.

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

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

From: Amy Grinn <grinn.amy <at> gmail.com>
To: guix-patches <at> gnu.org
Subject: [PATCH] New package: emacs-boxy
Date: Tue, 25 Mar 2025 18:55:34 +0100

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

Hello,

I would like to add my package, emacs-boxy, to Guix.

This is my first patch to Guix so let me know if I did anything wrong!

[0001-gnu-Add-emacs-boxy.patch (text/x-diff, inline)]

From b3223cec32425d6b8cf2c11545ed63ad6dabae88 Mon Sep 17 00:00:00 2001
From: Amy Grinn <grinn.amy <at> tuta.com>
Date: Tue, 25 Mar 2025 18:17:25 +0100
Subject: [PATCH] gnu: Add emacs-boxy

* gnu/packages/emacs-xyz.scm (emacs-boxy): New variable.
---
 gnu/packages/emacs-xyz.scm | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index f00c5e4b29..0423858b2f 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -39025,6 +39025,21 @@ (define-public emacs-boxquote
 example code.")
     (license license:gpl3+)))
 
+(define-public emacs-boxy
+  (package
+    (name "emacs-boxy")
+    (version "2.0.0")
+    (source (origin
+	      (method url-fetch)
+	      (uri (string-append "https://elpa.gnu.org/packages/boxy-"
+                                  version ".tar"))
+	      (sha256 (base64 "6w1QtINpWz9voCrc/ne6q8sPj4UcA3s8E/f/Pebjz+0="))))
+    (build-system emacs-build-system)
+    (home-page "https://gitlab.com/grinn.amy/boxy")
+    (synopsis "A boxy layout framework")
+    (description "Boxy provides an interface to create a 3D representation of boxes.")
+    (license license:gpl3+)))
+
 (define-public emacs-buffer-env
   (package
     (name "emacs-buffer-env")
-- 
2.49.0

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

-- 
Best,

Amy

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

From: Ian Eure <ian <at> retrospec.tv>
To: Amy Grinn <grinn.amy <at> gmail.com>
Cc: 77258 <at> debbugs.gnu.org
Subject: Re: [bug#77258] [PATCH] New package: emacs-boxy
Date: Sat, 29 Mar 2025 08:49:37 -0700

Hi Amy,

Amy Grinn <grinn.amy <at> gmail.com> writes:

> Hello,
>
> I would like to add my package, emacs-boxy, to Guix.
>
> This is my first patch to Guix so let me know if I did anything 
> wrong!

Thank you for contributing to Guix!  Please see 
(guix)Contributing[1] for info about sending patches.  The Guix 
tooling expects patches to be submitted with `git send-email', and 
not mailed as an attachment.

Other comments below.

>>From b3223cec32425d6b8cf2c11545ed63ad6dabae88 Mon Sep 17 
>>00:00:00 2001
> From: Amy Grinn <grinn.amy <at> tuta.com>
> Date: Tue, 25 Mar 2025 18:17:25 +0100
> Subject: [PATCH] gnu: Add emacs-boxy
>
> * gnu/packages/emacs-xyz.scm (emacs-boxy): New variable.
> ---
>  gnu/packages/emacs-xyz.scm | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
>
> diff --git a/gnu/packages/emacs-xyz.scm 
> b/gnu/packages/emacs-xyz.scm
> index f00c5e4b29..0423858b2f 100644
> --- a/gnu/packages/emacs-xyz.scm
> +++ b/gnu/packages/emacs-xyz.scm
> @@ -39025,6 +39025,21 @@ (define-public emacs-boxquote
>  example code.")
>      (license license:gpl3+)))
>  
> +(define-public emacs-boxy
> +  (package
> +    (name "emacs-boxy")
> +    (version "2.0.0")
> +    (source (origin
> +	      (method url-fetch)
> +	      (uri (string-append 
> "https://elpa.gnu.org/packages/boxy-"
> +                                  version ".tar"))

Please prefer the upstream Git repo over M/ELPA.

> +	      (sha256 (base64 
> "6w1QtINpWz9voCrc/ne6q8sPj4UcA3s8E/f/Pebjz+0="))))
> +    (build-system emacs-build-system)
> +    (home-page "https://gitlab.com/grinn.amy/boxy")
> +    (synopsis "A boxy layout framework")
> +    (description "Boxy provides an interface to create a 3D 
> representation of boxes.")

"Boxy" should probably reference the package name 
(@code{emacs-boxy}), "This package," or similar.  It would also be 
nice to have a bit more info about what the package is used for.

I also noticed a couple issues with the package itself which ought 
to be corrected:

- Your `defcustom' and `defface' forms don’t have `:group boxy', 
 so won’t appear if you `M-x customize-group RET boxy RET'.
- Several macros from `cl-macs' are used, but `cl-macs' isn’t 
 required.  ex. `cl-defstruct', `cl-flet*', possibly others. 
 `cl-lib' might also require `cl-macs', but you should always 
 require your direct dependencies instead of relying on 
 transitive ones.
- You may want to condsider using symbols or keywords for 
 `boxy-relationships' instead of strings.

Thanks,

 -- Ian

[1]: 
https://guix.gnu.org/manual/devel/en/html_node/Sending-a-Patch-Series.html#Single-Patches-1

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

From: Amy Pillow <amypillow <at> lavache.com>
To: Ian Eure <ian <at> retrospec.tv>
Cc: 77258 <at> debbugs.gnu.org
Subject: [PATCH v1] gnu: Add emacs-boxy
Date: Sun, 30 Mar 2025 14:20:59 +0200

* gnu/packages/emacs-xyz.scm (emacs-boxy): New variable.
---
Hi, sorry, I changed my email address, but I do have a few questions
about this contribution:

> Hi Amy,
>
> Amy Grinn <grinn.amy <at> gmail.com> writes:
>
>> Hello,
>>
>> I would like to add my package, emacs-boxy, to Guix.
>>
>> This is my first patch to Guix so let me know if I did anything 
>> wrong!
>
> Thank you for contributing to Guix!  Please see 
> (guix)Contributing[1] for info about sending patches.  The Guix 
> tooling expects patches to be submitted with `git send-email', and 
> not mailed as an attachment.
>

I was going off of these instructions:

https://guix.gnu.org/manual/en/html_node/Sending-a-Patch-Series.html

which state that "Sending patches as email attachments may make them
difficult to review in some mail clients, and git diff does not store
commit metadata."

I'm not sure how many email clients still have trouble viewing
attachments in emails, but you seemed to have no problem, so I'm curious
if maybe the instructions should be updated to explicitly state which
patch formats are allowed and maybe give a different justification for
it.

I tried my best here to stick to the git send-email format, let me know
if this is acceptable.

> Other comments below.
>
>>>From b3223cec32425d6b8cf2c11545ed63ad6dabae88 Mon Sep 17 
>>>00:00:00 2001
>> From: Amy Grinn <grinn.amy <at> tuta.com>
>> Date: Tue, 25 Mar 2025 18:17:25 +0100
>> Subject: [PATCH] gnu: Add emacs-boxy
>>
>> * gnu/packages/emacs-xyz.scm (emacs-boxy): New variable.
>> ---
>>  gnu/packages/emacs-xyz.scm | 15 +++++++++++++++
>>  1 file changed, 15 insertions(+)
>>
>> diff --git a/gnu/packages/emacs-xyz.scm 
>> b/gnu/packages/emacs-xyz.scm
>> index f00c5e4b29..0423858b2f 100644
>> --- a/gnu/packages/emacs-xyz.scm
>> +++ b/gnu/packages/emacs-xyz.scm
>> @@ -39025,6 +39025,21 @@ (define-public emacs-boxquote
>>  example code.")
>>      (license license:gpl3+)))
>>  
>> +(define-public emacs-boxy
>> +  (package
>> +    (name "emacs-boxy")
>> +    (version "2.0.0")
>> +    (source (origin
>> +           (method url-fetch)
>> +           (uri (string-append 
>> "https://elpa.gnu.org/packages/boxy-"
>> +                                  version ".tar"))
>
> Please prefer the upstream Git repo over M/ELPA.
>

The upstream repo is not at a stable location, I've changed it once or
twice already and I'm planning to do so again soon. Is it acceptable to
use GNU ELPA? I see that other packages in emacs-xyz.scm are doing the
same thing.

>> +           (sha256 (base64 
>> "6w1QtINpWz9voCrc/ne6q8sPj4UcA3s8E/f/Pebjz+0="))))
>> +    (build-system emacs-build-system)
>> +    (home-page "https://gitlab.com/grinn.amy/boxy")
>> +    (synopsis "A boxy layout framework")
>> +    (description "Boxy provides an interface to create a 3D 
>> representation of boxes.")
>
> "Boxy" should probably reference the package name 
> (@code{emacs-boxy}), "This package," or similar.  It would also be 
> nice to have a bit more info about what the package is used for.
>

Sure, I can do that.

> I also noticed a couple issues with the package itself which ought 
> to be corrected:
>
> - Your `defcustom' and `defface' forms don’t have `:group boxy', 
>   so won’t appear if you `M-x customize-group RET boxy RET'.

I think it's a little rude to point out a bug without actually checking
if it exists. `M-x customize-group RET boxy RET' works fine. The
`:group' option is unnecessary when you evaluate it after a `defgroup'.

> - Several macros from `cl-macs' are used, but `cl-macs' isn’t 
>   required.  ex. `cl-defstruct', `cl-flet*', possibly others. 
>   `cl-lib' might also require `cl-macs', but you should always 
>   require your direct dependencies instead of relying on 
>   transitive ones.

cl-macs is part of the cl-lib package. You can see more info about how
to use Common Lisp in Emacs here:

https://www.gnu.org/software/emacs/manual/html_mono/cl.html

> - You may want to condsider using symbols or keywords for 
>   `boxy-relationships' instead of strings.
>

Haha yes, maybe, it's far too late to change that now though. Maybe in
version 3.

> Thanks,
>
>   -- Ian
>
> [1]: 
> https://guix.gnu.org/manual/devel/en/html_node/Sending-a-Patch-Series.html#Single-Patches-1
>

I appreciate all of your thoughts, please let me know if you need
anything else!

Best,

Amy

 gnu/packages/emacs-xyz.scm | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index b5dc07acbb..8db221affb 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -156,6 +156,7 @@
 ;;; Copyright © 2025 Skylar Hill <stellarskylark <at> posteo.net>
 ;;; Copyright © 2025 Cayetano Santos <csantosb <at> inventati.org>
 ;;; Copyright © 2025 Lee Thompson <lee.p.thomp <at> gmail.com>
+;;; Copyright @ 2025 Amy Pillow <amypillow <at> lavache.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -39170,6 +39171,23 @@ (define-public emacs-boxquote
 example code.")
     (license license:gpl3+)))
 
+(define-public emacs-boxy
+  (package
+    (name "emacs-boxy")
+    (version "2.0.0")
+    (source (origin
+	      (method url-fetch)
+	      (uri (string-append "https://elpa.gnu.org/packages/boxy-"
+                                  version ".tar"))
+	      (sha256 (base64 "6w1QtINpWz9voCrc/ne6q8sPj4UcA3s8E/f/Pebjz+0="))))
+    (build-system emacs-build-system)
+    (home-page "https://gitlab.com/grinn.amy/boxy")
+    (synopsis "A boxy layout framework")
+    (description "@code{boxy} provides an interface to create a 3D
+representation of boxes. Other packages can use this library to create
+expandable menus for interacting with hierarchical data.")
+    (license license:gpl3+)))
+
 (define-public emacs-buffer-env
   (package
     (name "emacs-buffer-env")

base-commit: 2ed28b5c24c599b2f9bc60dfc93151cf489ca477
-- 
2.34.1

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

From: Amy Pillow <amypillow <at> lavache.com>
To: Ian Eure <ian <at> retrospec.tv>
Cc: 77258 <at> debbugs.gnu.org
Subject: [PATCH v1] gnu: Add emacs-boxy
Date: Sun, 30 Mar 2025 14:20:59 +0200

* gnu/packages/emacs-xyz.scm (emacs-boxy): New variable.
---
Hi, sorry, I changed my email address, but I do have a few questions
about this contribution:

> Hi Amy,
>
> Amy Grinn <grinn.amy <at> gmail.com> writes:
>
>> Hello,
>>
>> I would like to add my package, emacs-boxy, to Guix.
>>
>> This is my first patch to Guix so let me know if I did anything 
>> wrong!
>
> Thank you for contributing to Guix!  Please see 
> (guix)Contributing[1] for info about sending patches.  The Guix 
> tooling expects patches to be submitted with `git send-email', and 
> not mailed as an attachment.
>

I was going off of these instructions:

https://guix.gnu.org/manual/en/html_node/Sending-a-Patch-Series.html

which state that "Sending patches as email attachments may make them
difficult to review in some mail clients, and git diff does not store
commit metadata."

I'm not sure how many email clients still have trouble viewing
attachments in emails, but you seemed to have no problem, so I'm curious
if maybe the instructions should be updated to explicitly state which
patch formats are allowed and maybe give a different justification for
it.

I tried my best here to stick to the git send-email format, let me know
if this is acceptable.

> Other comments below.
>
>>>From b3223cec32425d6b8cf2c11545ed63ad6dabae88 Mon Sep 17 
>>>00:00:00 2001
>> From: Amy Grinn <grinn.amy <at> tuta.com>
>> Date: Tue, 25 Mar 2025 18:17:25 +0100
>> Subject: [PATCH] gnu: Add emacs-boxy
>>
>> * gnu/packages/emacs-xyz.scm (emacs-boxy): New variable.
>> ---
>>  gnu/packages/emacs-xyz.scm | 15 +++++++++++++++
>>  1 file changed, 15 insertions(+)
>>
>> diff --git a/gnu/packages/emacs-xyz.scm 
>> b/gnu/packages/emacs-xyz.scm
>> index f00c5e4b29..0423858b2f 100644
>> --- a/gnu/packages/emacs-xyz.scm
>> +++ b/gnu/packages/emacs-xyz.scm
>> @@ -39025,6 +39025,21 @@ (define-public emacs-boxquote
>>  example code.")
>>      (license license:gpl3+)))
>>  
>> +(define-public emacs-boxy
>> +  (package
>> +    (name "emacs-boxy")
>> +    (version "2.0.0")
>> +    (source (origin
>> +           (method url-fetch)
>> +           (uri (string-append 
>> "https://elpa.gnu.org/packages/boxy-"
>> +                                  version ".tar"))
>
> Please prefer the upstream Git repo over M/ELPA.
>

The upstream repo is not at a stable location, I've changed it once or
twice already and I'm planning to do so again soon. Is it acceptable to
use GNU ELPA? I see that other packages in emacs-xyz.scm are doing the
same thing.

>> +           (sha256 (base64 
>> "6w1QtINpWz9voCrc/ne6q8sPj4UcA3s8E/f/Pebjz+0="))))
>> +    (build-system emacs-build-system)
>> +    (home-page "https://gitlab.com/grinn.amy/boxy")
>> +    (synopsis "A boxy layout framework")
>> +    (description "Boxy provides an interface to create a 3D 
>> representation of boxes.")
>
> "Boxy" should probably reference the package name 
> (@code{emacs-boxy}), "This package," or similar.  It would also be 
> nice to have a bit more info about what the package is used for.
>

Sure, I can do that.

> I also noticed a couple issues with the package itself which ought 
> to be corrected:
>
> - Your `defcustom' and `defface' forms don’t have `:group boxy', 
>   so won’t appear if you `M-x customize-group RET boxy RET'.

I think it's a little rude to point out a bug without actually checking
if it exists. `M-x customize-group RET boxy RET' works fine. The
`:group' option is unnecessary when you evaluate it after a `defgroup'.

> - Several macros from `cl-macs' are used, but `cl-macs' isn’t 
>   required.  ex. `cl-defstruct', `cl-flet*', possibly others. 
>   `cl-lib' might also require `cl-macs', but you should always 
>   require your direct dependencies instead of relying on 
>   transitive ones.

cl-macs is part of the cl-lib package. You can see more info about how
to use Common Lisp in Emacs here:

https://www.gnu.org/software/emacs/manual/html_mono/cl.html

> - You may want to condsider using symbols or keywords for 
>   `boxy-relationships' instead of strings.
>

Haha yes, maybe, it's far too late to change that now though. Maybe in
version 3.

> Thanks,
>
>   -- Ian
>
> [1]: 
> https://guix.gnu.org/manual/devel/en/html_node/Sending-a-Patch-Series.html#Single-Patches-1
>

I appreciate all of your thoughts, please let me know if you need
anything else!

Best,

Amy

 gnu/packages/emacs-xyz.scm | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index b5dc07acbb..8db221affb 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -156,6 +156,7 @@
 ;;; Copyright © 2025 Skylar Hill <stellarskylark <at> posteo.net>
 ;;; Copyright © 2025 Cayetano Santos <csantosb <at> inventati.org>
 ;;; Copyright © 2025 Lee Thompson <lee.p.thomp <at> gmail.com>
+;;; Copyright @ 2025 Amy Pillow <amypillow <at> lavache.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -39170,6 +39171,23 @@ (define-public emacs-boxquote
 example code.")
     (license license:gpl3+)))
 
+(define-public emacs-boxy
+  (package
+    (name "emacs-boxy")
+    (version "2.0.0")
+    (source (origin
+	      (method url-fetch)
+	      (uri (string-append "https://elpa.gnu.org/packages/boxy-"
+                                  version ".tar"))
+	      (sha256 (base64 "6w1QtINpWz9voCrc/ne6q8sPj4UcA3s8E/f/Pebjz+0="))))
+    (build-system emacs-build-system)
+    (home-page "https://gitlab.com/grinn.amy/boxy")
+    (synopsis "A boxy layout framework")
+    (description "@code{boxy} provides an interface to create a 3D
+representation of boxes. Other packages can use this library to create
+expandable menus for interacting with hierarchical data.")
+    (license license:gpl3+)))
+
 (define-public emacs-buffer-env
   (package
     (name "emacs-buffer-env")

base-commit: 2ed28b5c24c599b2f9bc60dfc93151cf489ca477
-- 
2.34.1

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

From: "Thompson, David" <dthompson2 <at> worcester.edu>
To: 77258-done <at> debbugs.gnu.org
Subject: Re: [PATCH] New package: emacs-boxy
Date: Thu, 3 Apr 2025 11:04:48 -0400

Hi Amy,

The latest version of your patch looks good overall. Thanks for
expanding the description and adding a copyright line. As you
mentioned, many packages in emacs-xyz.scm use tarballs from ELPA so
given the instability of the upstream repo due to hosting migrations I
think using an ELPA URL is just fine here.

FWIW, patches as attachments are no problem for me. Whether inline or
attachment, doing code review by email is just as frustrating. ;)

Also, I think the comments from Ian about the code in the project
itself are irrelevant to the discussion of this patch, which should be
scoped to just the package recipe.

I modified the hash to use the conventional base32 format and pushed to master.

Congrats on your first Guix patch!

- Dave

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

From: Amy Pillow <amypillow <at> lavache.com>
To: "Thompson, David" <dthompson2 <at> worcester.edu>
Cc: 77258-done <at> debbugs.gnu.org, Ian Eure <ian <at> retrospec.tv>
Subject: Re: [PATCH] New package: emacs-boxy
Date: Fri, 04 Apr 2025 11:29:13 +0200

> Hi Amy,
> 
> The latest version of your patch looks good overall. Thanks for
> expanding the description and adding a copyright line. As you
> mentioned, many packages in emacs-xyz.scm use tarballs from ELPA so
> given the instability of the upstream repo due to hosting migrations I
> think using an ELPA URL is just fine here.
> 
> FWIW, patches as attachments are no problem for me. Whether inline or
> attachment, doing code review by email is just as frustrating. ;)
> 
> Also, I think the comments from Ian about the code in the project
> itself are irrelevant to the discussion of this patch, which should be
> scoped to just the package recipe.
> 
> I modified the hash to use the conventional base32 format and pushed to master.
> 
> Congrats on your first Guix patch!
> 
> - Dave

Thank you so much Dave, I appreciate it! I agree with everything you
said and I think both the ELPA src url and patches-as-attachments will
make it easier for me to contribute in the future.

I also agree that issues in the source project should be addressed
outside of the guix-patches mailing list. If anyone has an issue using
the boxy library please use the forge's issue tracker (currently gitlab)
instead of Guix'. That way, Emacs users who don't use Guix will be able
to join the discussion.

-- 
Best,
Amy

Previous Next

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