[PATCH 0/2] gnu: Add sdl-union and guile-sdl

[PATCH 0/2] gnu: Add sdl-union and guile-sdl

[David Thompson]

Hello all,

The following patch set adds two new packages:

1) sdl-union: A union-build of SDL and it's utility libraries
2) guile-sdl: A Guile wrapper for SDL

Neither of these patches are ready for upstream.  I'm posting them now
because I need some help to fix the remaining issues.

Regarding sdl-union:

* This package isn't useful for users, only developers.  Should I keep it
private so that it doesn't show up in package searches?

* I wasn't sure how to fill out the metadata fields.  Thoughts on what
  they should be?

Regarding guile-sdl:

* This package doesn't build.  However, if I build with --keep-failed
and run `make clean && make` in /tmp/nix-.../guile-sdl-0.5.1, the build
is successful.  Does anyone have any thoughts about why this might be?
I really need some help here.

The motivation for these patches (and my previous freeimage) patch, are
to finish up packaging all of the dependencies for Sly, my game engine.

Thanks in advance for the help/feedback!

-- 
David Thompson
Web Developer - Free Software Foundation - http://fsf.org
GPG Key: 0FF1D807
Support the FSF: https://fsf.org/donate

[PATCH 1/2] gnu: Add sdl-union.

[David Thompson]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: 0001-gnu-Add-sdl-union.patch --]
[-- Type: text/x-diff, Size: 1872 bytes --]

From db0ee9ba8666d1f5b2cd080f837fdae3e1ee329b Mon Sep 17 00:00:00 2001
From: David Thompson <dthompson2@worcester.edu>
Date: Sun, 2 Nov 2014 11:54:20 -0500
Subject: [PATCH 1/2] gnu: Add sdl-union.

* gnu/packages/sdl.scm (sdl-union): New variable.
---
 gnu/packages/sdl.scm | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/gnu/packages/sdl.scm b/gnu/packages/sdl.scm
index b9b5262..fc374c0 100644
--- a/gnu/packages/sdl.scm
+++ b/gnu/packages/sdl.scm
@@ -22,6 +22,7 @@
   #:use-module (guix packages)
   #:use-module (guix download)
   #:use-module (guix build-system gnu)
+  #:use-module (guix build-system trivial)
   #:use-module ((gnu packages fontutils) #:prefix font:)
   #:use-module (gnu packages image)
   #:use-module (gnu packages linux)
@@ -240,3 +241,28 @@ SDL.")
     (description "SDL_ttf is a TrueType font rendering library for SDL.")
     (home-page "www.libsdl.org/projects/SDL_ttf/")
     (license zlib)))
+
+(define-public sdl-union
+  (package
+    (name "sdl-union")
+    (version (package-version sdl))
+    (source #f)
+    (build-system trivial-build-system)
+    (arguments
+     '(#:modules ((guix build union))
+       #:builder (begin
+                   (use-modules (ice-9 match)
+                                (guix build union))
+                   (match %build-inputs
+                     (((names . directories) ...)
+                      (union-build (assoc-ref %outputs "out")
+                                   directories))))))
+    (inputs `(("sdl" ,sdl)
+              ("sdl-gfx" ,sdl-gfx)
+              ("sdl-image" ,sdl-image)
+              ("sdl-mixer" ,sdl-mixer)
+              ("sdl-ttf" ,sdl-ttf)))
+    (synopsis "Union of all SDL libraries.")
+    (description "Union of all SDL libraries.")
+    (home-page (package-home-page sdl))
+    (license (package-license sdl))))
-- 
2.1.1

[PATCH 2/2] gnu: Add guile-sdl.

[David Thompson]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: 0002-gnu-Add-guile-sdl.patch --]
[-- Type: text/x-diff, Size: 2157 bytes --]

From bde00797a13304f69e61b1cd87033b75a6174bba Mon Sep 17 00:00:00 2001
From: David Thompson <dthompson2@worcester.edu>
Date: Sun, 2 Nov 2014 11:55:21 -0500
Subject: [PATCH 2/2] gnu: Add guile-sdl.

* gnu/packages/sdl.scm (guile-sdl): New variable.
---
 gnu/packages/sdl.scm | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/gnu/packages/sdl.scm b/gnu/packages/sdl.scm
index fc374c0..8f78b90 100644
--- a/gnu/packages/sdl.scm
+++ b/gnu/packages/sdl.scm
@@ -24,6 +24,7 @@
   #:use-module (guix build-system gnu)
   #:use-module (guix build-system trivial)
   #:use-module ((gnu packages fontutils) #:prefix font:)
+  #:use-module (gnu packages guile)
   #:use-module (gnu packages image)
   #:use-module (gnu packages linux)
   #:use-module (gnu packages mp3)
@@ -266,3 +267,37 @@ SDL.")
     (description "Union of all SDL libraries.")
     (home-page (package-home-page sdl))
     (license (package-license sdl))))
+
+(define-public guile-sdl
+  (package
+    (name "guile-sdl")
+    (version "0.5.1")
+    (source (origin
+              (method url-fetch)
+              (uri
+               (string-append "mirror://gnu/guile-sdl/guile-sdl-"
+                              version ".tar.xz"))
+              (sha256
+               (base32
+                "126n4rd0ydh6i2s11ari5k85iivradlf12zq13b34shf9k1wn5am"))))
+    (build-system gnu-build-system)
+    (native-inputs
+     `(("pkg-config" ,pkg-config)))
+    (inputs
+     `(("guile" ,guile-2.0)
+       ("sdl-union" ,sdl-union)))
+    (arguments
+     '(#:configure-flags
+       (list (string-append "--with-sdl-prefix="
+                            (assoc-ref %build-inputs "sdl-union")))
+       #:phases
+       (alist-cons-before
+        'configure 'disable-guile-auto-compile
+        (lambda _
+          (setenv "GUILE_AUTO_COMPILE" "0"))
+        %standard-phases)))
+    (synopsis "SDL bindings for GNU Guile.")
+    (description "Guile-SDL is a set of modules that provide bindings for SDL
+to enable Guile programmers to do all the nice things you can do with SDL.")
+    (home-page "http://gnu.org/s/guile-sdl")
+    (license gpl3+)))
-- 
2.1.1

Re: [PATCH 0/2] gnu: Add sdl-union and guile-sdl

[Ludovic Courtès]

David Thompson <dthompson2@worcester.edu> skribis:

> Regarding sdl-union:
>
> * This package isn't useful for users, only developers.  Should I keep it
> private so that it doesn't show up in package searches?

Probably, yes.  But could you remind me why it’s needed?  ISTR from
earlier discussions that some tools (‘sdl-config’?) assume that all the
headers and libraries are in the same directory, right?

Could you add the explanation as a comment or the ‘description’ field in
the source?

> * I wasn't sure how to fill out the metadata fields.  Thoughts on what
>   they should be?

What you did is fine, or you could add the explanation mentioned above.

> Regarding guile-sdl:
>
> * This package doesn't build.  However, if I build with --keep-failed
> and run `make clean && make` in /tmp/nix-.../guile-sdl-0.5.1, the build
> is successful.  Does anyone have any thoughts about why this might be?
> I really need some help here.

Did you try #:parallel-build? #f and/or #:parallel-tests? #f?
Otherwise, perhaps you could post the fail of the build log to see if we
have an idea.

Thanks!

Ludo’.

Re: [PATCH 0/2] gnu: Add sdl-union and guile-sdl

[David Thompson]

Ludovic Courtès <ludo@gnu.org> writes:

> David Thompson <dthompson2@worcester.edu> skribis:
>
>> Regarding sdl-union:
>>
>> * This package isn't useful for users, only developers.  Should I keep it
>> private so that it doesn't show up in package searches?
>
> Probably, yes.  But could you remind me why it’s needed?  ISTR from
> earlier discussions that some tools (‘sdl-config’?) assume that all the
> headers and libraries are in the same directory, right?

Yes, that is why.

> Could you add the explanation as a comment or the ‘description’ field in
> the source?

Added.

>> Regarding guile-sdl:
>>
>> * This package doesn't build.  However, if I build with --keep-failed
>> and run `make clean && make` in /tmp/nix-.../guile-sdl-0.5.1, the build
>> is successful.  Does anyone have any thoughts about why this might be?
>> I really need some help here.
>
> Did you try #:parallel-build? #f and/or #:parallel-tests? #f?
> Otherwise, perhaps you could post the fail of the build log to see if we
> have an idea.

Parallel builds were indeed part of the problem.  Thanks for pointing
that out!

After working through some other tough problems, I finally have a
working guile-sdl package with a passing test suite.

I will submit new patches as replies to the originals.

-- 
David Thompson
Web Developer - Free Software Foundation - http://fsf.org
GPG Key: 0FF1D807
Support the FSF: https://fsf.org/donate

Re: [PATCH 1/2] gnu: Add sdl-union.

[David Thompson]

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

New patch!


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-gnu-Add-sdl-union.patch --]
[-- Type: text/x-diff, Size: 2013 bytes --]

From 6b119f2ab64f84ff03d1ddf9a1b3c715a3b17e9f Mon Sep 17 00:00:00 2001
From: David Thompson <dthompson2@worcester.edu>
Date: Sun, 2 Nov 2014 11:54:20 -0500
Subject: [PATCH 1/2] gnu: Add sdl-union.

* gnu/packages/sdl.scm (sdl-union): New variable.
---
 gnu/packages/sdl.scm | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/gnu/packages/sdl.scm b/gnu/packages/sdl.scm
index a4dbe7d..609088b 100644
--- a/gnu/packages/sdl.scm
+++ b/gnu/packages/sdl.scm
@@ -22,6 +22,7 @@
   #:use-module (guix packages)
   #:use-module (guix download)
   #:use-module (guix build-system gnu)
+  #:use-module (guix build-system trivial)
   #:use-module ((gnu packages fontutils) #:prefix font:)
   #:use-module (gnu packages image)
   #:use-module (gnu packages linux)
@@ -240,3 +241,31 @@ SDL.")
     (description "SDL_ttf is a TrueType font rendering library for SDL.")
     (home-page "http://www.libsdl.org/projects/SDL_ttf/")
     (license zlib)))
+
+(define sdl-union
+  (package
+    (name "sdl-union")
+    (version (package-version sdl))
+    (source #f)
+    (build-system trivial-build-system)
+    (arguments
+     '(#:modules ((guix build union))
+       #:builder (begin
+                   (use-modules (ice-9 match)
+                                (guix build union))
+                   (match %build-inputs
+                     (((names . directories) ...)
+                      (union-build (assoc-ref %outputs "out")
+                                   directories))))))
+    (inputs `(("sdl" ,sdl)
+              ("sdl-gfx" ,sdl-gfx)
+              ("sdl-image" ,sdl-image)
+              ("sdl-mixer" ,sdl-mixer)
+              ("sdl-ttf" ,sdl-ttf)))
+    (synopsis "Union of all SDL libraries.")
+    (description
+     "A union of SDL and its extension libraries.  A union is required because
+sdl-config assumes that all of the headers and libraries are in the same
+directory.")
+    (home-page (package-home-page sdl))
+    (license (package-license sdl))))
-- 
2.1.1


[-- Attachment #3: Type: text/plain, Size: 136 bytes --]


-- 
David Thompson
Web Developer - Free Software Foundation - http://fsf.org
GPG Key: 0FF1D807
Support the FSF: https://fsf.org/donate

Re: [PATCH 2/2] gnu: Add guile-sdl.

[David Thompson]

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

New patch!


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0002-gnu-Add-guile-sdl.patch --]
[-- Type: text/x-diff, Size: 3072 bytes --]

From 215bd5af729055196da818518c816f7fd08e6a06 Mon Sep 17 00:00:00 2001
From: David Thompson <dthompson2@worcester.edu>
Date: Sun, 2 Nov 2014 11:55:21 -0500
Subject: [PATCH 2/2] gnu: Add guile-sdl.

* gnu/packages/sdl.scm (guile-sdl): New variable.
---
 gnu/packages/sdl.scm | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

diff --git a/gnu/packages/sdl.scm b/gnu/packages/sdl.scm
index 609088b..e94a83c 100644
--- a/gnu/packages/sdl.scm
+++ b/gnu/packages/sdl.scm
@@ -24,6 +24,7 @@
   #:use-module (guix build-system gnu)
   #:use-module (guix build-system trivial)
   #:use-module ((gnu packages fontutils) #:prefix font:)
+  #:use-module (gnu packages guile)
   #:use-module (gnu packages image)
   #:use-module (gnu packages linux)
   #:use-module (gnu packages mp3)
@@ -269,3 +270,54 @@ sdl-config assumes that all of the headers and libraries are in the same
 directory.")
     (home-page (package-home-page sdl))
     (license (package-license sdl))))
+
+(define-public guile-sdl
+  (package
+    (name "guile-sdl")
+    (version "0.5.1")
+    (source (origin
+              (method url-fetch)
+              (uri
+               (string-append "mirror://gnu/guile-sdl/guile-sdl-"
+                              version ".tar.xz"))
+              (sha256
+               (base32
+                "126n4rd0ydh6i2s11ari5k85iivradlf12zq13b34shf9k1wn5am"))))
+    (build-system gnu-build-system)
+    (native-inputs
+     `(("pkg-config" ,pkg-config)
+       ;; Required by test suite.
+       ("xorg-server" ,xorg-server)
+       ("libjpeg" ,libjpeg)))
+    (inputs
+     `(("guile" ,guile-2.0)
+       ("sdl-union" ,sdl-union)))
+    (arguments
+     '(#:configure-flags
+       (list (string-append "--with-sdl-prefix="
+                            (assoc-ref %build-inputs "sdl-union")))
+       #:parallel-build? #f ; parallel build fails
+       #:phases
+       (alist-cons-before
+        'configure 'fix-env-and-patch
+        (lambda* (#:key inputs #:allow-other-keys)
+          (setenv "GUILE_AUTO_COMPILE" "0")
+          ;; SDL_image needs to dlopen libjpeg in the test suite.
+          (setenv "LD_LIBRARY_PATH"
+                  (string-append (assoc-ref inputs "libjpeg") "/lib"))
+          ;; Change the site directory /site/2.0 like Guile expects.
+          (substitute* "build-aux/guile-baux/re-prefixed-site-dirs"
+            (("\"/site\"") "\"/site/2.0\"")))
+        (alist-cons-before
+         'check 'start-xorg-server
+         (lambda* (#:key inputs #:allow-other-keys)
+           ;; The test suite requires a running X server.
+           (system (format #f "~a/bin/Xvfb :1 &"
+                           (assoc-ref inputs "xorg-server")))
+           (setenv "DISPLAY" ":1"))
+         %standard-phases))))
+    (synopsis "SDL bindings for GNU Guile.")
+    (description "Guile-SDL is a set of modules that provide bindings for SDL
+to enable Guile programmers to do all the nice things you can do with SDL.")
+    (home-page "http://gnu.org/s/guile-sdl")
+    (license gpl3+)))
-- 
2.1.1


[-- Attachment #3: Type: text/plain, Size: 136 bytes --]


-- 
David Thompson
Web Developer - Free Software Foundation - http://fsf.org
GPG Key: 0FF1D807
Support the FSF: https://fsf.org/donate

Re: [PATCH 1/2] gnu: Add sdl-union.

[Ludovic Courtès]

David Thompson <dthompson2@worcester.edu> skribis:

> From 6b119f2ab64f84ff03d1ddf9a1b3c715a3b17e9f Mon Sep 17 00:00:00 2001
> From: David Thompson <dthompson2@worcester.edu>
> Date: Sun, 2 Nov 2014 11:54:20 -0500
> Subject: [PATCH 1/2] gnu: Add sdl-union.
>
> * gnu/packages/sdl.scm (sdl-union): New variable.

LGTM!

> +    (synopsis "Union of all SDL libraries.")
                                            ^
Please remove the period before committing.

Thanks,
Ludo’.

Re: [PATCH 2/2] gnu: Add guile-sdl.

[Ludovic Courtès]

David Thompson <dthompson2@worcester.edu> skribis:

> From 215bd5af729055196da818518c816f7fd08e6a06 Mon Sep 17 00:00:00 2001
> From: David Thompson <dthompson2@worcester.edu>
> Date: Sun, 2 Nov 2014 11:55:21 -0500
> Subject: [PATCH 2/2] gnu: Add guile-sdl.
>
> * gnu/packages/sdl.scm (guile-sdl): New variable.

LGTM!  Nice work with the tests.

> +    (synopsis "SDL bindings for GNU Guile.")
> +    (description "Guile-SDL is a set of modules that provide bindings for SDL
> +to enable Guile programmers to do all the nice things you can do with SDL.")

Please run ‘make sync-descriptions’ and use whatever synopsis and
description it suggests.

OK to commit with this change.

Thank you!

Ludo’.

Re: [PATCH 2/2] gnu: Add guile-sdl.

[David Thompson]

Ludovic Courtès <ludo@gnu.org> writes:

> Please run ‘make sync-descriptions’ and use whatever synopsis and
> description it suggests.
>
> OK to commit with this change.

Done and pushed.

-- 
David Thompson
Web Developer - Free Software Foundation - http://fsf.org
GPG Key: 0FF1D807
Support the FSF: https://fsf.org/donate

Re: [PATCH 1/2] gnu: Add sdl-union.

[David Thompson]

Ludovic Courtès <ludo@gnu.org> writes:

> David Thompson <dthompson2@worcester.edu> skribis:
>
>> +    (synopsis "Union of all SDL libraries.")
>                                             ^
> Please remove the period before committing.

Done and pushed.

Thanks for reviewing these patches.

-- 
David Thompson
Web Developer - Free Software Foundation - http://fsf.org
GPG Key: 0FF1D807
Support the FSF: https://fsf.org/donate