GNU bug report logs - #57756
[PATCH 0/2] Add sbcl-xml-emitter

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 57756 in the body.
You can then email your comments to 57756 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: Trevor Richards <trev <at> trevdev.ca>
To: guix-patches <at> gnu.org
Subject: [PATCH 0/2] Add sbcl-xml-emitter
Date: Mon, 12 Sep 2022 14:27:21 -0700

Hello! This series of patches brings sbcl-stumpwm-notify to GNU Guix. This stumpwm-contrib add-on gives stumpwm users a quick and easy way to listen for dbus messages and receive notification messages in a familiar, stumpish way.

Trevor Richards (2):
  * gnu/packages/lisp-xyz.scm: Add sbcl-xml-emitter
  * gnu/packages/wm.scm: Add sbcl-stumpwm-notify

 gnu/packages/lisp-xyz.scm | 23 +++++++++++++++++++++++
 gnu/packages/wm.scm       | 24 ++++++++++++++++++++++++
 2 files changed, 47 insertions(+)

-- 
2.37.3

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

From: Trevor Richards <trev <at> trevdev.ca>
To: 57756 <at> debbugs.gnu.org
Subject: [PATCH 1/2] * gnu/packages/lisp-xyz.scm: Add sbcl-xml-emitter
Date: Mon, 12 Sep 2022 14:10:00 -0700

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

diff --git a/gnu/packages/lisp-xyz.scm b/gnu/packages/lisp-xyz.scm
index 4da0323677..01719e05b2 100644
--- a/gnu/packages/lisp-xyz.scm
+++ b/gnu/packages/lisp-xyz.scm
@@ -35,6 +35,7 @@
 ;;; Copyright © 2022 Paul A. Patience <paul <at> apatience.com>
 ;;; Copyright © 2022 Thomas Albers Raviola <thomas <at> thomaslabs.org>
 ;;; Copyright © 2022 Arun Isaac <arunisaac <at> systemreboot.net>
+;;; Copyright © 2022 Trevor Richards <trev <at> trevdev.ca>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -3799,6 +3800,28 @@ (define-public ecl-markup-reader
 (define-public cl-markup-reader
   (sbcl-package->cl-source-package sbcl-markup-reader))
 
+(define-public sbcl-xml-emitter
+  (package
+    (name "sbcl-xml-emitter")
+    (version "1.1.0")
+    (source (origin
+              (method git-fetch)
+              (uri (git-reference
+                    (url "https://github.com/VitoVan/xml-emitter.git")
+                    (commit "1a93a5ab084a10f3b527db3043bd0ba5868404bf")))
+              (sha256
+               (base32
+                "1w9yx8gc4imimvjqkhq8yzpg3kjrp2y37rjix5c1lnz4s7bxvhk9"))))
+    (build-system asdf-build-system/sbcl)
+    (inputs `(("cl-utilities" ,sbcl-cl-utilities)
+              ("1am" ,sbcl-1am)))
+    (synopsis "A common lisp library for emitting XML output")
+    (description "Simply emit XML, with some complexity for handling indentation.
+It can be used to produce all sorts of useful XML output; it has an RSS 2.0
+ emitter built in, so you can make RSS feeds trivially.")
+    (home-page "https://www.cliki.net/xml-emitter")
+    (license license:expat)))
+
 (define-public sbcl-cl-mustache
   (package
     (name "sbcl-cl-mustache")
-- 
2.37.3

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

From: Trevor Richards <trev <at> trevdev.ca>
To: 57756 <at> debbugs.gnu.org
Subject: [PATCH 2/2] * gnu/packages/wm.scm: Add sbcl-stumpwm-notify
Date: Mon, 12 Sep 2022 14:10:30 -0700

---
 gnu/packages/wm.scm | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/gnu/packages/wm.scm b/gnu/packages/wm.scm
index 451dfce516..6ae0135a64 100644
--- a/gnu/packages/wm.scm
+++ b/gnu/packages/wm.scm
@@ -56,6 +56,7 @@
 ;;; Copyright © 2022 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
 ;;; Copyright © 2022 muradm <mail <at> muradm.net>
 ;;; Copyright © 2022 Elais Player <elais <at> fastmail.com>
+;;; Copyright © 2022 Trevor Richards <trev <at> trevdev.ca>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -2256,6 +2257,29 @@ (define-public sbcl-stumpwm-screenshot
 PNG files.")
     (license license:gpl3+)))
 
+(define-public sbcl-stumpwm-notify
+  (package
+    (inherit stumpwm-contrib)
+    (name "sbcl-stumpwm-notify")
+    (build-system asdf-build-system/sbcl)
+    (inputs
+     `(("stumpwm" ,stumpwm "lib")
+       ("xml-emitter" ,sbcl-xml-emitter)
+       ("dbus" ,sbcl-dbus)
+       ("bordeaux-threads" ,sbcl-bordeaux-threads)))
+    (arguments
+     '(#:asd-systems '("notify")
+       #:tests? #f
+       #:phases
+       (modify-phases %standard-phases
+         (add-after 'unpack 'chdir
+           (lambda _ (chdir "util/notify") #t)))))
+    (home-page "https://github.com/stumpwm/stumpwm-contrib")
+    (synopsis "Notifications server for StumpWM")
+    (description "Implements org.freedesktop.Notifications
+interface[fn:dbus-spec]. Shows notifications using stumpwm:message by default.")
+    (license license:gpl3)))
+
 (define-public lemonbar
   (package
     (name "lemonbar")
-- 
2.37.3

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

From: Christopher Baines <mail <at> cbaines.net>
To: Trevor Richards <trev <at> trevdev.ca>
Cc: 57756 <at> debbugs.gnu.org
Subject: Re: [bug#57756] [PATCH 2/2] * gnu/packages/wm.scm: Add
 sbcl-stumpwm-notify
Date: Wed, 14 Sep 2022 08:58:47 +0100

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

Trevor Richards <trev <at> trevdev.ca> writes:

> ---
>  gnu/packages/wm.scm | 24 ++++++++++++++++++++++++
>  1 file changed, 24 insertions(+)

Hi Trevor,

The commit message for adding a package like this one would generally
look like:

gnu: Add sbcl-stumpwm-notify.

* gnu/packages/wm.scm (sbcl-stumpwm-notify): New variable.


You're mostly there.

> diff --git a/gnu/packages/wm.scm b/gnu/packages/wm.scm
> index 451dfce516..6ae0135a64 100644
> --- a/gnu/packages/wm.scm
> +++ b/gnu/packages/wm.scm
> @@ -56,6 +56,7 @@
>  ;;; Copyright © 2022 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
>  ;;; Copyright © 2022 muradm <mail <at> muradm.net>
>  ;;; Copyright © 2022 Elais Player <elais <at> fastmail.com>
> +;;; Copyright © 2022 Trevor Richards <trev <at> trevdev.ca>
>  ;;;
>  ;;; This file is part of GNU Guix.
>  ;;;
> @@ -2256,6 +2257,29 @@ (define-public sbcl-stumpwm-screenshot
>  PNG files.")
>      (license license:gpl3+)))
>  
> +(define-public sbcl-stumpwm-notify
> +  (package
> +    (inherit stumpwm-contrib)
> +    (name "sbcl-stumpwm-notify")
> +    (build-system asdf-build-system/sbcl)
> +    (inputs
> +     `(("stumpwm" ,stumpwm "lib")
> +       ("xml-emitter" ,sbcl-xml-emitter)
> +       ("dbus" ,sbcl-dbus)
> +       ("bordeaux-threads" ,sbcl-bordeaux-threads)))
> +    (arguments
> +     '(#:asd-systems '("notify")
> +       #:tests? #f

Why aren't the tests being run? If they can be run, that would be
good. If there's a reason why they can't or shouldn't be run, it would
be good to note that in a comment.

> +       #:phases
> +       (modify-phases %standard-phases
> +         (add-after 'unpack 'chdir
> +           (lambda _ (chdir "util/notify") #t)))))
> +    (home-page "https://github.com/stumpwm/stumpwm-contrib")
> +    (synopsis "Notifications server for StumpWM")
> +    (description "Implements org.freedesktop.Notifications
> +interface[fn:dbus-spec]. Shows notifications using stumpwm:message by default.")
> +    (license license:gpl3)))
> +
>  (define-public lemonbar
>    (package
>      (name "lemonbar")

[signature.asc (application/pgp-signature, inline)]

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

From: Trev <trev <at> trevdev.ca>
To: Christopher Baines <mail <at> cbaines.net>
Cc: 57756 <at> debbugs.gnu.org
Subject: Re: [bug#57756] [PATCH 2/2] * gnu/packages/wm.scm: Add
 sbcl-stumpwm-notify
Date: Wed, 14 Sep 2022 09:28:32 -0700

Christopher Baines <mail <at> cbaines.net> writes:

>> ---
>>  gnu/packages/wm.scm | 24 ++++++++++++++++++++++++
>>  1 file changed, 24 insertions(+)
>
> Hi Trevor,
>
> The commit message for adding a package like this one would generally
> look like:
>
> gnu: Add sbcl-stumpwm-notify.
>
> * gnu/packages/wm.scm (sbcl-stumpwm-notify): New variable.
>
>
> You're mostly there.
>

Thank you for this feedback! I had been following the guidelines
described in the documentation:

https://guix.gnu.org/manual/en/html_node/Submitting-Patches.html

It states to write patches in the "changelog" format described here:

https://www.gnu.org/prep/standards/html_node/Change-Logs.html#Change-Logs

Is there documentation somewhere that might help me adapt my strategy
for future contributions? I do prefer the tighter format you're asking
for :)

>> diff --git a/gnu/packages/wm.scm b/gnu/packages/wm.scm
>> index 451dfce516..6ae0135a64 100644
>> --- a/gnu/packages/wm.scm
>> +++ b/gnu/packages/wm.scm
>> @@ -56,6 +56,7 @@
>>  ;;; Copyright © 2022 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
>>  ;;; Copyright © 2022 muradm <mail <at> muradm.net>
>>  ;;; Copyright © 2022 Elais Player <elais <at> fastmail.com>
>> +;;; Copyright © 2022 Trevor Richards <trev <at> trevdev.ca>
>>  ;;;
>>  ;;; This file is part of GNU Guix.
>>  ;;;
>> @@ -2256,6 +2257,29 @@ (define-public sbcl-stumpwm-screenshot
>>  PNG files.")
>>      (license license:gpl3+)))
>>  
>> +(define-public sbcl-stumpwm-notify
>> +  (package
>> +    (inherit stumpwm-contrib)
>> +    (name "sbcl-stumpwm-notify")
>> +    (build-system asdf-build-system/sbcl)
>> +    (inputs
>> +     `(("stumpwm" ,stumpwm "lib")
>> +       ("xml-emitter" ,sbcl-xml-emitter)
>> +       ("dbus" ,sbcl-dbus)
>> +       ("bordeaux-threads" ,sbcl-bordeaux-threads)))
>> +    (arguments
>> +     '(#:asd-systems '("notify")
>> +       #:tests? #f
>
> Why aren't the tests being run? If they can be run, that would be
> good. If there's a reason why they can't or shouldn't be run, it would
> be good to note that in a comment.
>

I flagged them off while testing the build in my own channel and forgot
to put them back on. Oops! They pass if they exist.

I can submit an update.

>> +       #:phases
>> +       (modify-phases %standard-phases
>> +         (add-after 'unpack 'chdir
>> +           (lambda _ (chdir "util/notify") #t)))))
>> +    (home-page "https://github.com/stumpwm/stumpwm-contrib")
>> +    (synopsis "Notifications server for StumpWM")
>> +    (description "Implements org.freedesktop.Notifications
>> +interface[fn:dbus-spec]. Shows notifications using stumpwm:message by default.")
>> +    (license license:gpl3)))
>> +
>>  (define-public lemonbar
>>    (package
>>      (name "lemonbar")
>

-- 

Trev : 0FB7 D06B 4A2A F07E AD5B  1169 183B 6306 8AA1 D206

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

From: Trevor Richards <trev <at> trevdev.ca>
To: 57756 <at> debbugs.gnu.org
Subject: [PATCH 1/3] gnu: add sbcl-xml-emitter
Date: Mon, 12 Sep 2022 14:10:00 -0700

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

diff --git a/gnu/packages/lisp-xyz.scm b/gnu/packages/lisp-xyz.scm
index 4da0323677..01719e05b2 100644
--- a/gnu/packages/lisp-xyz.scm
+++ b/gnu/packages/lisp-xyz.scm
@@ -35,6 +35,7 @@
 ;;; Copyright © 2022 Paul A. Patience <paul <at> apatience.com>
 ;;; Copyright © 2022 Thomas Albers Raviola <thomas <at> thomaslabs.org>
 ;;; Copyright © 2022 Arun Isaac <arunisaac <at> systemreboot.net>
+;;; Copyright © 2022 Trevor Richards <trev <at> trevdev.ca>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -3799,6 +3800,28 @@ (define-public ecl-markup-reader
 (define-public cl-markup-reader
   (sbcl-package->cl-source-package sbcl-markup-reader))
 
+(define-public sbcl-xml-emitter
+  (package
+    (name "sbcl-xml-emitter")
+    (version "1.1.0")
+    (source (origin
+              (method git-fetch)
+              (uri (git-reference
+                    (url "https://github.com/VitoVan/xml-emitter.git")
+                    (commit "1a93a5ab084a10f3b527db3043bd0ba5868404bf")))
+              (sha256
+               (base32
+                "1w9yx8gc4imimvjqkhq8yzpg3kjrp2y37rjix5c1lnz4s7bxvhk9"))))
+    (build-system asdf-build-system/sbcl)
+    (inputs `(("cl-utilities" ,sbcl-cl-utilities)
+              ("1am" ,sbcl-1am)))
+    (synopsis "A common lisp library for emitting XML output")
+    (description "Simply emit XML, with some complexity for handling indentation.
+It can be used to produce all sorts of useful XML output; it has an RSS 2.0
+ emitter built in, so you can make RSS feeds trivially.")
+    (home-page "https://www.cliki.net/xml-emitter")
+    (license license:expat)))
+
 (define-public sbcl-cl-mustache
   (package
     (name "sbcl-cl-mustache")
-- 
2.37.3

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

From: Trevor Richards <trev <at> trevdev.ca>
To: 57756 <at> debbugs.gnu.org
Subject: [PATCH 2/3] gnu: add sbcl-stumpwm-notify
Date: Mon, 12 Sep 2022 14:10:30 -0700

---
 gnu/packages/wm.scm | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/gnu/packages/wm.scm b/gnu/packages/wm.scm
index 451dfce516..6ae0135a64 100644
--- a/gnu/packages/wm.scm
+++ b/gnu/packages/wm.scm
@@ -56,6 +56,7 @@
 ;;; Copyright © 2022 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
 ;;; Copyright © 2022 muradm <mail <at> muradm.net>
 ;;; Copyright © 2022 Elais Player <elais <at> fastmail.com>
+;;; Copyright © 2022 Trevor Richards <trev <at> trevdev.ca>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -2256,6 +2257,29 @@ (define-public sbcl-stumpwm-screenshot
 PNG files.")
     (license license:gpl3+)))
 
+(define-public sbcl-stumpwm-notify
+  (package
+    (inherit stumpwm-contrib)
+    (name "sbcl-stumpwm-notify")
+    (build-system asdf-build-system/sbcl)
+    (inputs
+     `(("stumpwm" ,stumpwm "lib")
+       ("xml-emitter" ,sbcl-xml-emitter)
+       ("dbus" ,sbcl-dbus)
+       ("bordeaux-threads" ,sbcl-bordeaux-threads)))
+    (arguments
+     '(#:asd-systems '("notify")
+       #:tests? #f
+       #:phases
+       (modify-phases %standard-phases
+         (add-after 'unpack 'chdir
+           (lambda _ (chdir "util/notify") #t)))))
+    (home-page "https://github.com/stumpwm/stumpwm-contrib")
+    (synopsis "Notifications server for StumpWM")
+    (description "Implements org.freedesktop.Notifications
+interface[fn:dbus-spec]. Shows notifications using stumpwm:message by default.")
+    (license license:gpl3)))
+
 (define-public lemonbar
   (package
     (name "lemonbar")
-- 
2.37.3

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

From: Trevor Richards <trev <at> trevdev.ca>
To: 57756 <at> debbugs.gnu.org
Subject: [PATCH 3/3] gnu: sbcl-stumpwm-notify: Fixed missing tests
Date: Wed, 14 Sep 2022 09:41:22 -0700

---
 gnu/packages/wm.scm | 1 -
 1 file changed, 1 deletion(-)

diff --git a/gnu/packages/wm.scm b/gnu/packages/wm.scm
index 6ae0135a64..2ee1269c9c 100644
--- a/gnu/packages/wm.scm
+++ b/gnu/packages/wm.scm
@@ -2269,7 +2269,6 @@ (define-public sbcl-stumpwm-notify
        ("bordeaux-threads" ,sbcl-bordeaux-threads)))
     (arguments
      '(#:asd-systems '("notify")
-       #:tests? #f
        #:phases
        (modify-phases %standard-phases
          (add-after 'unpack 'chdir
-- 
2.37.3

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

From: Guillaume Le Vaillant <glv <at> posteo.net>
To: Trevor Richards <trev <at> trevdev.ca>
Cc: 57756-done <at> debbugs.gnu.org
Subject: Re: [bug#57756] [PATCH 1/3] gnu: add sbcl-xml-emitter
Date: Thu, 15 Sep 2022 08:40:26 +0000

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

Patches pushed as d10bc44c2452aeb81de36a33257c327e30ffbc1f and following
with a few modifications.
Thanks.

[signature.asc (application/pgp-signature, inline)]

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

From: Christopher Baines <mail <at> cbaines.net>
To: Trev <trev <at> trevdev.ca>
Cc: 57756 <at> debbugs.gnu.org
Subject: Re: [bug#57756] [PATCH 2/2] * gnu/packages/wm.scm: Add
 sbcl-stumpwm-notify
Date: Fri, 16 Sep 2022 12:25:37 +0200

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

Trev <trev <at> trevdev.ca> writes:

> Christopher Baines <mail <at> cbaines.net> writes:
>
>>> ---
>>>  gnu/packages/wm.scm | 24 ++++++++++++++++++++++++
>>>  1 file changed, 24 insertions(+)
>>
>> Hi Trevor,
>>
>> The commit message for adding a package like this one would generally
>> look like:
>>
>> gnu: Add sbcl-stumpwm-notify.
>>
>> * gnu/packages/wm.scm (sbcl-stumpwm-notify): New variable.
>>
>>
>> You're mostly there.
>>
>
> Thank you for this feedback! I had been following the guidelines
> described in the documentation:
>
> https://guix.gnu.org/manual/en/html_node/Submitting-Patches.html
>
> It states to write patches in the "changelog" format described here:
>
> https://www.gnu.org/prep/standards/html_node/Change-Logs.html#Change-Logs
>
> Is there documentation somewhere that might help me adapt my strategy
> for future contributions? I do prefer the tighter format you're asking
> for :)

I'm no expert on the changelog format, but I think you were just missing
the descriptive first line of the commit.

Looking at how other commits are written is the only recommendation I
can give for writing commit messages. Also don't worry about it too much
:)

Chris

[signature.asc (application/pgp-signature, inline)]

Previous Next

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