GNU bug report logs - #25741
neo layout for kbd

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 25741 in the body.
You can then email your comments to 25741 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: ng0 <contact.ng0 <at> cryptolab.net>
To: guix-patches <at> gnu.org
Subject: neo layout for kbd
Date: Wed, 15 Feb 2017 16:46:14 +0000

This adds two changes to the "kbd" package, to add the neo2 layout.

I just configured a test system with it and it works.

I'd prefer to find an smaller way to add the neo.map file, but this is
functional for now.


-- 
ng0 -- https://www.inventati.org/patternsinthechaos/

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

From: contact.ng0 <at> cryptolab.net
To: 25741 <at> debbugs.gnu.org
Cc: ng0 <ng0 <at> libertad.pw>
Subject: [PATCH 2/2] gnu: kbd: Add neo layout.
Date: Wed, 15 Feb 2017 16:48:00 +0000

From: ng0 <ng0 <at> libertad.pw>

* gnu/packages/linux.scm (kbd): Add neo layout.
[arguments]: Add new 'install-neo-layout' and 'add-neo-directory' phases.
[native-inputs]: Add 'kbd-neo'.
---
 gnu/packages/linux.scm | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/gnu/packages/linux.scm b/gnu/packages/linux.scm
index 65221579b..45314eeb0 100644
--- a/gnu/packages/linux.scm
+++ b/gnu/packages/linux.scm
@@ -1658,6 +1658,12 @@ system.")
     (arguments
      '(#:phases
        (modify-phases %standard-phases
+         (add-before 'configure 'add-neo-directory
+           (lambda _
+             (substitute* "data/Makefile.am"
+               (("mac/all")
+                "mac/all i386/neo"))
+             #t))
          (add-before 'build 'pre-build
            (lambda* (#:key inputs #:allow-other-keys)
              (let ((gzip  (assoc-ref %build-inputs "gzip"))
@@ -1675,12 +1681,21 @@ system.")
                (for-each (lambda (prog)
                            (wrap-program (string-append bin "/" prog)
                              `("PATH" ":" prefix (,bin))))
-                         '("unicode_start" "unicode_stop"))))))))
+                         '("unicode_start" "unicode_stop")))))
+         (add-before 'install 'install-neo-layout
+           (lambda* (#:key inputs outputs #:allow-other-keys)
+             (let* ((neo (assoc-ref %build-inputs "kbd-neo"))
+                    (out (assoc-ref outputs "out"))
+                    (neomap (string-append neo "/share/keymaps/i386/neo/neo.map"))
+                    (keymaps (string-append out "/share/keymaps/i386/neo")))
+               (mkdir-p keymaps)
+               (install-file neomap keymaps)))))))
     (inputs `(("check" ,check)
               ("gzip" ,gzip)
               ("bzip2" ,bzip2)
               ("pam" ,linux-pam)))
-    (native-inputs `(("pkg-config" ,pkg-config)))
+    (native-inputs `(("pkg-config" ,pkg-config)
+                     ("kbd-neo" ,kbd-neo)))
     (home-page "ftp://ftp.kernel.org/pub/linux/utils/kbd/")
     (synopsis "Linux keyboard utilities and keyboard maps")
     (description
-- 
2.11.1

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

From: contact.ng0 <at> cryptolab.net
To: 25741 <at> debbugs.gnu.org
Cc: ng0 <ng0 <at> libertad.pw>
Subject: [PATCH 1/2] gnu: Add kbd-neo.
Date: Wed, 15 Feb 2017 16:47:59 +0000

From: ng0 <ng0 <at> libertad.pw>

* gnu/packages/linux.scm (kbd-neo): New variable.
---
 gnu/packages/linux.scm | 42 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 41 insertions(+), 1 deletion(-)

diff --git a/gnu/packages/linux.scm b/gnu/packages/linux.scm
index d53f5487b..65221579b 100644
--- a/gnu/packages/linux.scm
+++ b/gnu/packages/linux.scm
@@ -17,7 +17,7 @@
 ;;; Copyright © 2016 John Darrington <jmd <at> gnu.org>
 ;;; Copyright © 2016 Marius Bakke <mbakke <at> fastmail.com>
 ;;; Copyright © 2016 Rene Saavedra <rennes <at> openmailbox.org>
-;;; Copyright © 2016 ng0 <ng0 <at> libertad.pw>
+;;; Copyright © 2016, 2017 ng0 <contact.ng0 <at> cryptolab.net>
 ;;; Copyright © 2017 Leo Famulari <leo <at> famulari.name>
 ;;; Copyright © 2017 José Miguel Sánchez García <jmi2k <at> openmailbox.com>
 ;;; Copyright © 2017 Gábor Boskovits <boskovits <at> gmail.com>
@@ -90,6 +90,7 @@
   #:use-module (guix build-system python)
   #:use-module (guix build-system trivial)
   #:use-module (guix download)
+  #:use-module (guix svn-download)
   #:use-module ((guix licenses) #:prefix license:)
   #:use-module (guix packages)
   #:use-module (guix utils)
@@ -1592,6 +1593,45 @@ system.")
     (license (list license:gpl2                   ;programs
                    license:lgpl2.1))))            ;library
 
+;; The Neo layout is a GPL3 licensed layout already present in Xorg,
+;; but not in kbd. home-page: https://neo-layout.org
+(define kbd-neo
+  (let ((svn-revision 2476)
+        (revision "1"))
+    (package
+      (name "kbd-neo")
+      (version (string-append "0.0.0-" revision "."
+                              (number->string svn-revision)))
+      (source
+       (origin
+         (method svn-fetch)
+         (uri (svn-reference
+               ;; The SVN branch with the neo.map file.
+               (url "https://svn.neo-layout.org/linux/console")
+               (revision svn-revision)))
+         (file-name (string-append name "-" version "-checkout"))
+         (sha256
+          (base32
+           "169hmlwcwz5sp605i8q5ikckxwsj1n3isylrnynflp30gbv9zrwn"))))
+      (build-system trivial-build-system)
+      (arguments
+       `(#:modules ((guix build utils))
+         #:builder (begin
+                     (use-modules (guix build utils))
+                     (let ((out (string-append %output
+                                               "/share/keymaps/i386/neo"))
+                           (source (assoc-ref %build-inputs "source")))
+                       (mkdir-p out)
+                       (copy-file (string-append source "/neo.map")
+                                  (string-append out "/neo.map"))))))
+      (native-inputs
+       `(("source" ,source)))
+      (home-page "https://neo-layout.org")
+      (license license:gpl3)
+      (synopsis "Neo2 console font")
+      (description
+       "Neo2 console font intended to be installed with kbd."))))
+
 (define-public kbd
   (package
     (name "kbd")
-- 
2.11.1

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

From: Ricardo Wurmus <rekado <at> elephly.net>
To: contact.ng0 <at> cryptolab.net
Cc: ng0 <ng0 <at> libertad.pw>, 25741 <at> debbugs.gnu.org
Subject: Re: bug#25741: [PATCH 1/2] gnu: Add kbd-neo.
Date: Thu, 09 Mar 2017 08:07:56 +0100

contact.ng0 <at> cryptolab.net writes:

> From: ng0 <ng0 <at> libertad.pw>
>
> * gnu/packages/linux.scm (kbd-neo): New variable.
[…]
> +;; The Neo layout is a GPL3 licensed layout already present in Xorg,
> +;; but not in kbd. home-page: https://neo-layout.org

Please remove this comment.

> +(define kbd-neo
> +  (let ((svn-revision 2476)
> +        (revision "1"))

SVN revisions are monotonically increasing, so we don’t need the
“revision” hack.

> +    (package
> +      (name "kbd-neo")
> +      (version (string-append "0.0.0-" revision "."
> +                              (number->string svn-revision)))
> +      (source
> +       (origin
> +         (method svn-fetch)
> +         (uri (svn-reference
> +               ;; The SVN branch with the neo.map file.
> +               (url "https://svn.neo-layout.org/linux/console")
> +               (revision svn-revision)))
> +         (file-name (string-append name "-" version "-checkout"))
> +         (sha256
> +          (base32
> +           "169hmlwcwz5sp605i8q5ikckxwsj1n3isylrnynflp30gbv9zrwn"))))

Actually, you can get the neo.map file at the given revision 2476 with
“url-fetch” from this URL:

    https://svn.neo-layout.org/!svn/bc/2476/linux/console/neo.map

This would be better than to use the more complicated “svn-fetch”.


> +      (build-system trivial-build-system)
> +      (arguments
> +       `(#:modules ((guix build utils))
> +         #:builder (begin
> +                     (use-modules (guix build utils))
> +                     (let ((out (string-append %output
> +                                               "/share/keymaps/i386/neo"))
> +                           (source (assoc-ref %build-inputs "source")))
> +                       (mkdir-p out)
> +                       (copy-file (string-append source "/neo.map")
> +                                  (string-append out "/neo.map"))))))

If you’re using the plain URL above this would be simplified a little.

> +      (native-inputs
> +       `(("source" ,source)))

I don’t think this is needed

> +      (home-page "https://neo-layout.org")
> +      (license license:gpl3)

Please move the license field below “description” for consistency.  It
is unfortunate that there are no license headers and that the license in
the COPYING file is explicitly declared to apply to all files in the
repository.

> +      (synopsis "Neo2 console font")

This is not a font as far as I can see.

> +      (description
> +       "Neo2 console font intended to be installed with kbd."))))
> +

Please use full sentences in the description.

--
Ricardo

GPG: BCA6 89B6 3655 3801 C3C6  2150 197A 5888 235F ACAC
https://elephly.net

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

From: Ricardo Wurmus <rekado <at> elephly.net>
To: contact.ng0 <at> cryptolab.net
Cc: ng0 <ng0 <at> libertad.pw>, 25741 <at> debbugs.gnu.org
Subject: Re: bug#25741: [PATCH 2/2] gnu: kbd: Add neo layout.
Date: Thu, 09 Mar 2017 08:12:35 +0100

contact.ng0 <at> cryptolab.net writes:

> From: ng0 <ng0 <at> libertad.pw>
>
> * gnu/packages/linux.scm (kbd): Add neo layout.
> [arguments]: Add new 'install-neo-layout' and 'add-neo-directory' phases.
> [native-inputs]: Add 'kbd-neo'.
> ---

I must say that this looks like a hack.  Shouldn’t it be sufficient to
install the gzipped map file to some directory?  Why is it necessary to
let kdb take care of installing the keymap?

If it is just a matter of finding the desired keymap at runtime, I think
it would be better to use a search path (if it exists).

-- 
Ricardo

GPG: BCA6 89B6 3655 3801 C3C6  2150 197A 5888 235F ACAC
https://elephly.net

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

From: ng0 <contact.ng0 <at> cryptolab.net>
To: Ricardo Wurmus <rekado <at> elephly.net>
Cc: ng0 <ng0 <at> libertad.pw>, 25741 <at> debbugs.gnu.org
Subject: Re: bug#25741: [PATCH 2/2] gnu: kbd: Add neo layout.
Date: Thu, 9 Mar 2017 12:01:50 +0000

Ricardo Wurmus transcribed 0.6K bytes:
> 
> contact.ng0 <at> cryptolab.net writes:
> 
> > From: ng0 <ng0 <at> libertad.pw>
> >
> > * gnu/packages/linux.scm (kbd): Add neo layout.
> > [arguments]: Add new 'install-neo-layout' and 'add-neo-directory' phases.
> > [native-inputs]: Add 'kbd-neo'.
> > ---
> 
> I must say that this looks like a hack.  Shouldn’t it be sufficient to
> install the gzipped map file to some directory?  Why is it necessary to
> let kdb take care of installing the keymap?
> 
> If it is just a matter of finding the desired keymap at runtime, I think
> it would be better to use a search path (if it exists).
> 
> -- 
> Ricardo
> 
> GPG: BCA6 89B6 3655 3801 C3C6  2150 197A 5888 235F ACAC
> https://elephly.net
> 

I've looked at Nix, and I've looked at the Makefile of kbd. This is the
way which works. I'm not sure if adding a searchpath would have the same
effect, but once I have fixed the neo patch I can try it. Even if it's
just to point out that it doesn't work this way.

Thanks for your reviews, I'll send updated patches as soon as I have
fixed my systems.

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

From: ng0 <contact.ng0 <at> cryptolab.net>
To: Ricardo Wurmus <rekado <at> elephly.net>
Cc: contact.ng0 <at> cryptolab.net, 25741 <at> debbugs.gnu.org
Subject: Re: bug#25741: [PATCH 2/2] gnu: kbd: Add neo layout.
Date: Thu, 27 Apr 2017 21:53:37 +0000

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

Alright, here is the reworked version.

Because it is equal to the result of the previous one, I am
positive that it works like this (the previous version did).
-- 
PGP and more: https://people.pragmatique.xyz/ng0/

[0001-gnu-kbd-Add-neo-layout.patch (text/plain, attachment)]

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

From: Ricardo Wurmus <rekado <at> elephly.net>
To: ng0 <contact.ng0 <at> cryptolab.net>
Cc: 25741 <at> debbugs.gnu.org
Subject: Re: bug#25741: [PATCH 2/2] gnu: kbd: Add neo layout.
Date: Fri, 28 Apr 2017 10:02:39 +0200

ng0 <contact.ng0 <at> cryptolab.net> writes:

> Alright, here is the reworked version.
>
> Because it is equal to the result of the previous one, I am
> positive that it works like this (the previous version did).

Thanks.  This still modifies the kbd package.  Have you tried what I
proposed, namely to install this as a separate package and /somehow/
make kbd find the installed keymap?  It would be nicer than to modify
the kbd package itself.

-- 
Ricardo
  
  GPG: BCA6 89B6 3655 3801 C3C6  2150 197A 5888 235F ACAC
  https://elephly.net

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

From: ng0 <contact.ng0 <at> cryptolab.net>
To: Ricardo Wurmus <rekado <at> elephly.net>
Cc: ng0 <contact.ng0 <at> cryptolab.net>, 25741 <at> debbugs.gnu.org
Subject: Re: bug#25741: [PATCH 2/2] gnu: kbd: Add neo layout.
Date: Fri, 28 Apr 2017 09:39:40 +0000

Ricardo Wurmus transcribed 0.5K bytes:
> 
> ng0 <contact.ng0 <at> cryptolab.net> writes:
> 
> > Alright, here is the reworked version.
> >
> > Because it is equal to the result of the previous one, I am
> > positive that it works like this (the previous version did).
> 
> Thanks.  This still modifies the kbd package.  Have you tried what I
> proposed, namely to install this as a separate package and /somehow/
> make kbd find the installed keymap?  It would be nicer than to modify
> the kbd package itself.
> 
> -- 
> Ricardo
>   
>   GPG: BCA6 89B6 3655 3801 C3C6  2150 197A 5888 235F ACAC
>   https://elephly.net
> 

Would this still work as intended?
kbd is a global package, part of the base. If I create a new
package which inherits from kbd, and people have to explicitly
add it to (packages) in (operating-system), it will colide with
(kbd). I think this really is the safest solution unless you
can convince me that it will work the way you proposed.

Or am I wrong and all you suggest is that (kbd) simply
finds the neo.map in the store?

I feel like kbd doesn#t work this way, but depending on
your explanation I can try.
-- 
PGP and more: https://people.pragmatique.xyz/ng0/

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

From: Ricardo Wurmus <rekado <at> elephly.net>
To: ng0 <contact.ng0 <at> cryptolab.net>
Cc: 25741 <at> debbugs.gnu.org
Subject: Re: bug#25741: [PATCH 2/2] gnu: kbd: Add neo layout.
Date: Fri, 28 Apr 2017 16:37:52 +0200

ng0 <contact.ng0 <at> cryptolab.net> writes:

> Would this still work as intended?
> kbd is a global package, part of the base.

This doesn’t matter.  The question here is: does this piece of software
have a mechanism to override or augment the search path for keymaps.

Often this is done with environment variables.  So I took the sources
and searched for “getenv”:

    tar xf $(guix build kbd)
    grep getenv -r kbd-*

Here’s what turned up:

[…]
kbd-2.0.4/src/libkeymap/analyze.l:	if ((ev = getenv("LOADKEYS_INCLUDE_PATH")) != NULL) {
kbd-2.0.4/src/libkeymap/analyze.c:	if ((ev = getenv("LOADKEYS_INCLUDE_PATH")) != NULL) {
kbd-2.0.4/src/loadkeys.c:	if ((ev = getenv("LOADKEYS_KEYMAP_PATH")) != NULL) {
[…]

This might be useful.


> If I create a new
> package which inherits from kbd, and people have to explicitly
> add it to (packages) in (operating-system), it will colide with
> (kbd).

I don’t understand what you mean.  Guix gives us programmatic control
over the package graph.  It is easy to replace all instances of one
package with another package (see “package-input-rewriting”).  In this
case that’s not even necessary; one can just take the “%base-packages”
list, delete “kbd” from it, and cons “my-custom-kbd” onto it.

However, none of this will be needed if you can augment the path where
kbd looks for keymaps.

> I feel like kbd doesn#t work this way

What makes you say this?  I don’t see anything special about kbd, but
maybe I’m missing something here.

--
Ricardo

GPG: BCA6 89B6 3655 3801 C3C6  2150 197A 5888 235F ACAC
https://elephly.net

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

From: <ng0 <at> pragmatique.xyz>
To: "25741" <25741 <at> debbugs.gnu.org>
Subject: bug#25741: [PATCH 2/2] gnu: kbd: Add neo layout.
Date: Thu, 25 May 2017 18:47:52 +0200 (CEST)

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

I updated with the changes you suggested and reconfigured my system with the patches applied.

Executing on tty1 as privileged user, "loadkeys neo" works and does what it should do.

Is it good to go now?

[0001-gnu-kbd-Add-native-search-paths.patch (application/octet-stream, attachment)]

[0002-gnu-Add-kbd-neo.patch (application/octet-stream, attachment)]

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

From: Marius Bakke <mbakke <at> fastmail.com>
To: ng0 <at> pragmatique.xyz, 25741 <25741-done <at> debbugs.gnu.org>
Subject: Re: bug#25741: [PATCH 2/2] gnu: kbd: Add neo layout.
Date: Thu, 25 May 2017 20:17:30 +0200

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

ng0 <at> pragmatique.xyz writes:

> I updated with the changes you suggested and reconfigured my system with the patches applied.
>
> Executing on tty1 as privileged user, "loadkeys neo" works and does what it should do.
>
> Is it good to go now?

LGTM. I pushed this with a few minor changes:

--8<---------------cut here---------------start------------->8---
diff --git a/gnu/packages/linux.scm b/gnu/packages/linux.scm
index ed1c6846b..2e984dd42 100644
--- a/gnu/packages/linux.scm
+++ b/gnu/packages/linux.scm
@@ -1662,15 +1662,16 @@ system.")
                    (let ((out (string-append %output "/share/keymaps"))
                          (source (assoc-ref %build-inputs "source")))
                      (mkdir-p out)
-                     (copy-file source (string-append out "/neo.map"))))))
+                     (copy-file source (string-append out "/neo.map"))
+                     #t))))
     (home-page "https://neo-layout.org")
-    (synopsis "Neo2 console layout for loadkeys(1)")
+    (synopsis "Neo2 console layout")
     (description
-     "Kbd-neo provides the Neo2 keyboard layout for use with loadkeys(1)
-with kbd(4).")
+     "Kbd-neo provides the Neo2 keyboard layout for use with
+@command{loadkeys(1)} from @code{kbd(4)}.")
     ;; The file is located in an svn directory, the entire content of
     ;; the directory is licensed as GPL3.
-    (license license:gpl3)))
+    (license license:gpl3+)))
--8<---------------cut here---------------end--------------->8---

[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.