GNU bug report logs - #54078
[PATCH] gnu: add libaml, libneatvnc, and wayvnc

Previous Next

To reply to this bug, email your comments to 54078 AT debbugs.gnu.org.

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

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

From: kitzman <kitzman <at> disroot.org>
To: guix-patches <guix-patches <at> gnu.org>
Subject: [PATCH] gnu: add libaml, libneatvnc, and wayvnc
Date: Sun, 20 Feb 2022 23:51:35 +0200

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

I have attached a patch for the following packages:
  - gnu/packages/linux.scm:8818 libaml
  - gnu/packages/vnc.scm:361 libneatvnc
  - gnu/packages/vnc.scm:384 wayvnc

The libraries/software are created by a single person, with
dependents/dependencies which are also created by them. I can
split this into a patch set if deemed more appropriate.

[0001-gnu-add-libaml-libneatvnc-and-wayvnc.patch (text/x-diff, attachment)]

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

From: kitzman <kitzman <at> disroot.org>
To: 54078 <at> debbugs.gnu.org
Subject: Re: bug#54078: [PATCH 0/0] gnu: add libaml, libneatvnc, and wayvnc
Date: Mon, 21 Feb 2022 10:06:43 +0200

I was missing some imports in gnu/packages/vnc.scm.

With this occasion I have also split my commit in three different ones.

kitzman <kitzman <at> disroot.org> writes:

> I have attached a patch for the following packages:
>   - gnu/packages/linux.scm:8818 libaml
>   - gnu/packages/vnc.scm:361 libneatvnc
>   - gnu/packages/vnc.scm:384 wayvnc
>
> The libraries/software are created by a single person, with
> dependents/dependencies which are also created by them. I can
> split this into a patch set if deemed more appropriate.

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

From: kitzman <kitzman <at> disroot.org>
To: 54078 <at> debbugs.gnu.org
Subject: Re: bug#54078: [PATCH 1/3] gnu: add libaml
Date: Mon, 21 Feb 2022 10:09:26 +0200

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

I have attached a patch for libaml:

gnu/packages/linux.scm:8818 libaml

[0001-gnu-add-libaml.patch (text/x-diff, attachment)]

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

From: kitzman <kitzman <at> disroot.org>
To: 54078 <at> debbugs.gnu.org
Subject: Re: bug#54078: [PATCH 2/3] gnu: add libneatvnc
Date: Mon, 21 Feb 2022 10:11:21 +0200

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

I have attached a patch for libneatvnc:

gnu/packages/vnc.scm:361 libneatvnc

[0002-gnu-add-libneatvnc.patch (text/x-diff, attachment)]

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

From: kitzman <kitzman <at> disroot.org>
To: 54078 <at> debbugs.gnu.org
Subject: Re: bug#54078: [PATCH 3/3] gnu: add wayvnc
Date: Mon, 21 Feb 2022 10:12:49 +0200

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

I have attached the final patch in this series: wayvnc.

gnu/packages/vnc.scm:384 wayvnc

[0003-gnu-add-wayvnc.patch (text/x-diff, attachment)]

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

From: Maxime Devos <maximedevos <at> telenet.be>
To: kitzman <kitzman <at> disroot.org>, 54078 <at> debbugs.gnu.org
Subject: Re: [bug#54078] [PATCH 1/3] gnu: add libaml
Date: Mon, 21 Feb 2022 14:12:37 +0100

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

kitzman via Guix-patches via schreef op ma 21-02-2022 om 10:09 [+0200]:
> +    (synopsis "Another/Andri's Main Loop")

What's up with the capitalisation?  In most situations, only the first
letter of a sentence (*) is capitalised, as in

(synopsis of 'texmacs')
Editing platform with special features for scientists

(*) It's not a complete sentence but AFAIK the same capitalisation
rules hold.

> +    (description "Portable and simple main loop implementation.")

This is not very descriptive, perhaps you an write a bit about what
it supports (file descriptor readability/writability, signal handlers,
timers, ...)?

Greetings,
Maxime.

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

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

From: Maxime Devos <maximedevos <at> telenet.be>
To: kitzman <kitzman <at> disroot.org>, 54078 <at> debbugs.gnu.org
Subject: Re: [bug#54078] [PATCH 2/3] gnu: add libneatvnc
Date: Mon, 21 Feb 2022 14:22:18 +0100

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

kitzman via Guix-patches via schreef op ma 21-02-2022 om 10:11 [+0200]:
> +    (native-inputs
> +     (list pkg-config libdrm))

Looking at 'src/tight.c', 'libdrm' looks like a regular input to me,
not a native-input.  It needs to be in inputs, otherwise the cross-
compiler won't find libdrm's header when src/tight.c is being cross-
compiled.

> +    (propagated-inputs
> +     (list libglvnd libxkbcommon pixman libaml gnutls libjpeg-turbo
> zlib))

Is propagation necessary here?  Would regular inputs suffice?
(Propagation can cause propagation conflicts and other issues.)

> +    (home-page "https://github.com/any1/neatvnc")
> +    (synopsis "VNC server library that's intended to be fast and
> neat")
> +    (description "This is a liberally licensed VNC server library
> that's intended to be fast and neat.")

‘Liberally licensed’: the package definition has a 'license' field
that should be sufficient for the user to determine if they like the
license or not.  Also, please keep the descriptions descriptive, no
marketing phrases ‘liberal’, ‘fast, and ‘neat’ (from (guix)Synopses and
Descriptions):

  Please avoid marketing phrases such as “world-leading”,
  “industrial-strength”, and “next-generation”, and avoid superlatives
  like “the most advanced”—they are not helpful to users looking for a
  package and may even sound suspicious.  Instead, try to be factual,
  mentioning use cases and features.

Greetings,
Maxime.

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

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

From: kitzman <kitzman <at> disroot.org>
To: Maxime Devos <maximedevos <at> telenet.be>
Cc: 54078 <at> debbugs.gnu.org
Subject: Re: bug#54078: [PATCH 1/3] gnu: add libaml
Date: Wed, 23 Feb 2022 19:50:06 +0200

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

Dear Maxime,

Thank you for reviewing.

[0001-gnu-add-libaml.patch (text/x-diff, attachment)]

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

I have attached here the fixed patch for libaml. The rest of the patches
are going to be part of the new series.

Kind regards,
Kitzman

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

From: Maxime Devos <maximedevos <at> telenet.be>
To: kitzman <kitzman <at> disroot.org>
Cc: 54078 <at> debbugs.gnu.org
Subject: Re: bug#54078: [PATCH 1/3] gnu: add libaml
Date: Wed, 23 Feb 2022 18:58:33 +0100

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

kitzman schreef op wo 23-02-2022 om 19:50 [+0200]:
> +    (description "The @code{aml} library provides an event loop for
> C, for Linux,

According to the README, it has portability as a goal.
Looking at src/kqueue.c, it supports some BSDs.
Looking at posix.c, it should support anything POSIX-like
(and hence, the Hurd).

As such, I don't think the qualifier 'for Linux' is very meaningful
here.

> +with the following features:
> +@enumerate
> +@item fd event handlers

‘(guix)Synopses and Descriptions’ recommends avoiding acronyms:

[...] Use full sentences, and avoid using acronyms without first
introducing them. [...]

‘@item file descriptor event handlers’ would be more explicit and
avoids the 'fd' acronym.

Otherwise, the description looks nice to me.

Greetings,
Maxime.

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

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

From: kitzman <kitzman <at> disroot.org>
To: Maxime Devos <maximedevos <at> telenet.be>
Cc: 54078 <at> debbugs.gnu.org
Subject: Re: bug#54078: [PATCH 1/3] gnu: add libaml
Date: Wed, 23 Feb 2022 20:50:11 +0200

[0001-gnu-add-libaml.patch (text/x-diff, attachment)]

From ac8f0bdbc92a834bbc96b3e676cc58059afc3633 Mon Sep 17 00:00:00 2001
From: kitzman <kitzman <at> disroot.org>
Date: Wed, 23 Feb 2022 20:41:17 +0200
Subject: [PATCH 1/3] gnu: add libaml

---
 gnu/packages/linux.scm | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/gnu/packages/linux.scm b/gnu/packages/linux.scm
index 1c514c3cec..27c54f90b0 100644
--- a/gnu/packages/linux.scm
+++ b/gnu/packages/linux.scm
@@ -8814,3 +8814,33 @@ (define-public libgpiod
     (license (list license:lgpl2.1+   ;; libgpiod
                    license:gpl2+      ;; gpio-tools
                    license:lgpl3+)))) ;; C++ bindings
+
+(define-public libaml
+  (package
+    (name "libaml")
+    (version "0.2.0")
+    (source (origin
+              (method git-fetch)
+              (uri (git-reference
+                    (url "https://github.com/any1/aml")
+                    (commit (string-append "v" version))))
+              (file-name (git-file-name "aml" (string-append "v" version)))
+              (sha256
+               (base32
+                "0mxmzlhiv88hm4sf8kyawyrml8qy1xis019hdyb5skl9g95z9yyf"))))
+    (build-system meson-build-system)
+    (native-inputs
+     (list pkg-config))
+    (home-page "https://github.com/any1/aml")
+    (synopsis "Another/Andri's main loop")
+    (description "The @code{aml} library provides a portable event loop for C,
+with the following features:
+@enumerate
+@item file descriptor event handlers
+@item timers and tickers
+@item signal handlers
+@item idle dispatch callbacks
+@item thread pool support
+@end enumerate
+")
+    (license license:isc)))
-- 
2.32.0

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

From: kitzman <kitzman <at> disroot.org>
To: Maxime Devos <maximedevos <at> telenet.be>
Cc: 54078 <at> debbugs.gnu.org
Subject: Re: bug#54078: [PATCH] gnu: add libaml, libneatvnc, and wayvnc
Date: Wed, 23 Feb 2022 20:57:42 +0200

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

Dear Maxime,

> Is propagation necessary here?  Would regular inputs suffice?
> (Propagation can cause propagation conflicts and other issues.)

That is true, the inputs were wrong.

> ‘Liberally licensed’: the package definition has a 'license' field
> that should be sufficient for the user to determine if they like the
> license or not.  Also, please keep the descriptions descriptive, no
> marketing phrases ‘liberal’, ‘fast, and ‘neat’

Instead of copying the repo's description, now there are some
functionalities of the library. However, it is unknown if they work with
all clients. Do you think it's worth mentioning?

[0002-gnu-add-libneatvnc.patch (text/x-diff, attachment)]

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

Kind regards,
Kitzman

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

From: Maxime Devos <maximedevos <at> telenet.be>
To: kitzman <kitzman <at> disroot.org>
Cc: 54078 <at> debbugs.gnu.org
Subject: Re: bug#54078: [PATCH] gnu: add libaml, libneatvnc, and wayvnc
Date: Wed, 23 Feb 2022 20:15:09 +0100

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

kitzman schreef op wo 23-02-2022 om 20:57 [+0200]:
> Instead of copying the repo's description, now there are some
> functionalities of the library. However, it is unknown if they work
> with
> all clients. Do you think it's worth mentioning?

Different interpretations of the specifications and bugs causing
server-client incompatibilities, and clients not making use of all the
features offered by the server, is always possible.  As such, I don't
think documenting incompatibilities in the description of servers is
very meaningful (YMMV; I would accept a description mentioning
incompatibilities FWIW).

It might be interesting to document these features (or lack of
features) in the descriptions of the clients though.  E.g., encryption
can be very important, so if a client doesn't support that, that might
be good to mention in the description of the package of the client. 
SSH tunneling does not seem to be ‘core’ functionality of VNC but
rather an extra, so that also seems useful to document in the client.

(TBC, this is only superficial review, and I'm not a committer.)

Greetings,
Maxime

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

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

From: kitzman <kitzman <at> disroot.org>
To: Maxime Devos <maximedevos <at> telenet.be>
Cc: 54078 <at> debbugs.gnu.org
Subject: Re: bug#54078: [PATCH] gnu: add libaml, libneatvnc, and wayvnc
Date: Wed, 23 Feb 2022 23:02:20 +0200

Dear Maxime,

> I don't
> think documenting incompatibilities in the description of servers is
> very meaningful (YMMV; I would accept a description mentioning
> incompatibilities FWIW).

From my perspective, these incompatibilities can be found anyway in the
README, plus it is unknown if some clients go well with the server -
thus one can always try, and maybe open an issue if there's a
problem. So I will leave that out for now.

> (TBC, this is only superficial review, and I'm not a committer.)

Thank you, the problem with the inputs was really bad and the
descriptions now do justice to the server and libs. It will make the
rest of the process much easier.

Kind regards,
Kitzman

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

From: kitzman <kitzman <at> disroot.org>
To: 54078 <at> debbugs.gnu.org
Subject: Re: bug#54078: [PATCH 3/3] gnu: add wayvnc
Date: Wed, 23 Feb 2022 23:04:52 +0200

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

I have attached here an updated version of the wayvnc package,
corresponding to the latest 1/3 and 2/3 patches.

[0003-gnu-add-wayvnc.patch (text/x-diff, attachment)]

Previous Next

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