[bug#35930] haskell Setup.hs-related changes

[bug#35930] haskell Setup.hs-related changes

[Robert Vollmert]

This primarily moves the substitution of missing Setup.hs files to
haskell-build-system. There was already duplicate code in a number
of packages to generated boilerplate Setup.hs, and I ran into a
couple more while trying to import some other packages.

[bug#35934] [PATCH 1/4] gnu: ghc-easy-plot: remove superfluous Setup.hs rename step

[Robert Vollmert]

haskell-build-system already uses whichever of Setup.hs and
Setup.lhs exists.

* gnu/packages/haskell.scm (ghc-easy-plot): don't rename
Setup.lhs to Setup.hs
---
 gnu/packages/haskell.scm | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/gnu/packages/haskell.scm b/gnu/packages/haskell.scm
index 33c9c6484d..44b9e9066a 100644
--- a/gnu/packages/haskell.scm
+++ b/gnu/packages/haskell.scm
@@ -8063,10 +8063,6 @@ interface for statistics based on hmatrix and GSL.")
         (base32 "18kndgvdj2apjpfga6fp7m16y1gx8zrwp3c5vfj03sx4v6jvciqk"))))
     (build-system haskell-build-system)
     (propagated-inputs `(("gnuplot" ,gnuplot)))
-    (arguments
-     `(#:phases (modify-phases %standard-phases
-                  (add-after 'unpack 'fix-setup-suffix
-                    (lambda _ (rename-file "Setup.lhs" "Setup.hs") #t)))))
     (home-page "https://hub.darcs.net/scravy/easyplot")
     (synopsis "Haskell plotting library based on gnuplot")
     (description "This package provides a plotting library for
-- 
2.20.1 (Apple Git-117)

[bug#35931] [PATCH 2/4] guix: haskell-build-system: correct haddock phase documentation

[Robert Vollmert]

* guix/build/haskell-build-system.scm (haddock): Correct docstring
---
 guix/build/haskell-build-system.scm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/guix/build/haskell-build-system.scm b/guix/build/haskell-build-system.scm
index 23d97e6602..5c5b32322b 100644
--- a/guix/build/haskell-build-system.scm
+++ b/guix/build/haskell-build-system.scm
@@ -260,7 +260,7 @@ given Haskell package."
   #t)
 
 (define* (haddock #:key outputs haddock? haddock-flags #:allow-other-keys)
-  "Run the test suite of a given Haskell package."
+  "Generate haddock documentation of a given Haskell package."
   (when haddock?
     (run-setuphs "haddock" haddock-flags))
   #t)
-- 
2.20.1 (Apple Git-117)

[bug#35932] [PATCH 3/4] guix: haskell-build-system: generate Setup.hs if not exists

[Robert Vollmert]

The default Setup.hs is boilerplate that is frequently left out of
source packages, causing build failure for package definitions as
generated by `guix import hackage`. Compare
<https://github.com/phadej/time-compat/issues/4>

* guix/build/haskell-build-system.scm: Generate Setup.hs if missing,
after unpack phase.
---
 guix/build/haskell-build-system.scm | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/guix/build/haskell-build-system.scm b/guix/build/haskell-build-system.scm
index 5c5b32322b..0c648e510f 100644
--- a/guix/build/haskell-build-system.scm
+++ b/guix/build/haskell-build-system.scm
@@ -275,9 +275,21 @@ given Haskell package."
       (_ (error "Could not find a Cabal file to patch."))))
   #t)
 
+(define* (generate-setup #:rest empty)
+  "Generate boilerplate Setup.hs if missing."
+  (when (not (or (file-exists? "Setup.hs")
+                 (file-exists? "Setup.lhs")))
+    (format #t "generating missing Setup.hs~%")
+    (with-output-to-file "Setup.hs"
+      (lambda ()
+        (format #t "import Distribution.Simple~%")
+        (format #t "main = defaultMain~%"))))
+  #t)
+
 (define %standard-phases
   (modify-phases gnu:%standard-phases
     (add-after 'unpack 'patch-cabal-file patch-cabal-file)
+    (add-after 'unpack 'generate-setup generate-setup)
     (delete 'bootstrap)
     (add-before 'configure 'setup-compiler setup-compiler)
     (add-before 'install 'haddock haddock)
-- 
2.20.1 (Apple Git-117)

[bug#35933] [PATCH 4/4] gnu: haskell: leave Setup.hs generation to build system

[Robert Vollmert]

Remove explicit Setup.hs generation from the configure step
now that haskell-build-system does it.

* gnu/packages/haskell.scm (ghc-foundation, ghc-inline-c,
ghc-inline-c-cpp, ghc-rio): Don't generate Setup.hs
---
 gnu/packages/haskell.scm | 42 ----------------------------------------
 1 file changed, 42 deletions(-)

diff --git a/gnu/packages/haskell.scm b/gnu/packages/haskell.scm
index 44b9e9066a..160b0a1fca 100644
--- a/gnu/packages/haskell.scm
+++ b/gnu/packages/haskell.scm
@@ -9688,16 +9688,6 @@ packages.")
         (base32
          "1q43y8wfj0wf9gdq2kzphwjwq6m5pvryy1lqgk954aq5z3ks1lsf"))))
     (build-system haskell-build-system)
-    (arguments
-     `(#:phases
-       (modify-phases %standard-phases
-         (add-after 'unpack 'add-setup-script
-           (lambda _
-             ;; The usual "Setup.hs" script is missing from the source.
-             (with-output-to-file "Setup.hs"
-               (lambda ()
-                 (format #t "import Distribution.Simple~%")
-                 (format #t "main = defaultMain~%"))))))))
     (inputs `(("ghc-basement" ,ghc-basement)))
     (home-page "https://github.com/haskell-foundation/foundation")
     (synopsis "Alternative prelude with batteries and no dependencies")
@@ -10575,16 +10565,6 @@ widths to the Char type.")
         (base32
          "064h8a4hp53a479d3ak0vmqbx8hi0cpg7zn4wp23rjy26dka8p7g"))))
     (build-system haskell-build-system)
-    (arguments
-     `(#:phases
-       (modify-phases %standard-phases
-         (add-after 'unpack 'add-setup-script
-           (lambda _
-             ;; The usual "Setup.hs" script is missing from the source.
-             (with-output-to-file "Setup.hs"
-               (lambda ()
-                 (format #t "import Distribution.Simple~%")
-                 (format #t "main = defaultMain~%"))))))))
     (inputs
      `(("ghc-exceptions" ,ghc-exceptions)
        ("ghc-hashable" ,ghc-hashable)
@@ -11107,17 +11087,6 @@ DOS/Windows paths and markup languages (such as XML).")
         (base32
          "0vbfrsqsi7mdziqsnj68bsqlwbqxxhvrmy9rv6w8z18d1m8w3n6h"))))
     (build-system haskell-build-system)
-    (arguments
-     `(#:phases
-       (modify-phases %standard-phases
-         (add-after 'unpack 'create-Setup.hs
-           (lambda _
-             (with-output-to-file "Setup.hs"
-               (lambda _
-                 (display "\
-import Distribution.Simple
-main = defaultMain")))
-             #t)))))
     (inputs
      `(("ghc-ansi-wl-pprint" ,ghc-ansi-wl-pprint)
        ("ghc-cryptohash" ,ghc-cryptohash)
@@ -11251,17 +11220,6 @@ handling wrong.")
         (base32
          "1rk7fmpkmxw9hhwr8df29kadnf0ybnwj64ggdbnsdrpfyhnkisci"))))
     (build-system haskell-build-system)
-    (arguments
-     `(#:phases
-       (modify-phases %standard-phases
-         (add-after 'unpack 'create-Setup.hs
-           (lambda _
-             (with-output-to-file "Setup.hs"
-               (lambda _
-                 (display "\
-import Distribution.Simple
-main = defaultMain")))
-             #t)))))
     (inputs
      `(("ghc-inline-c" ,ghc-inline-c)
        ("ghc-safe-exceptions" ,ghc-safe-exceptions)))
-- 
2.20.1 (Apple Git-117)

[bug#35930] [PATCH 1/4] gnu: ghc-easy-plot: remove superfluous Setup.hs rename step

[Robert Vollmert]

haskell-build-system already uses whichever of Setup.hs and
Setup.lhs exists.

* gnu/packages/haskell.scm (ghc-easy-plot): don't rename
Setup.lhs to Setup.hs
---
 gnu/packages/haskell.scm | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/gnu/packages/haskell.scm b/gnu/packages/haskell.scm
index 33c9c6484d..44b9e9066a 100644
--- a/gnu/packages/haskell.scm
+++ b/gnu/packages/haskell.scm
@@ -8063,10 +8063,6 @@ interface for statistics based on hmatrix and GSL.")
         (base32 "18kndgvdj2apjpfga6fp7m16y1gx8zrwp3c5vfj03sx4v6jvciqk"))))
     (build-system haskell-build-system)
     (propagated-inputs `(("gnuplot" ,gnuplot)))
-    (arguments
-     `(#:phases (modify-phases %standard-phases
-                  (add-after 'unpack 'fix-setup-suffix
-                    (lambda _ (rename-file "Setup.lhs" "Setup.hs") #t)))))
     (home-page "https://hub.darcs.net/scravy/easyplot")
     (synopsis "Haskell plotting library based on gnuplot")
     (description "This package provides a plotting library for
-- 
2.20.1 (Apple Git-117)

[bug#35930] [PATCH 2/4] guix: haskell-build-system: correct haddock phase documentation

[Robert Vollmert]

* guix/build/haskell-build-system.scm (haddock): Correct docstring
---
 guix/build/haskell-build-system.scm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/guix/build/haskell-build-system.scm b/guix/build/haskell-build-system.scm
index 23d97e6602..5c5b32322b 100644
--- a/guix/build/haskell-build-system.scm
+++ b/guix/build/haskell-build-system.scm
@@ -260,7 +260,7 @@ given Haskell package."
   #t)
 
 (define* (haddock #:key outputs haddock? haddock-flags #:allow-other-keys)
-  "Run the test suite of a given Haskell package."
+  "Generate haddock documentation of a given Haskell package."
   (when haddock?
     (run-setuphs "haddock" haddock-flags))
   #t)
-- 
2.20.1 (Apple Git-117)

[bug#35930] [PATCH 3/4] guix: haskell-build-system: generate Setup.hs if not exists

[Robert Vollmert]

The default Setup.hs is boilerplate that is frequently left out of
source packages, causing build failure for package definitions as
generated by `guix import hackage`. Compare
<https://github.com/phadej/time-compat/issues/4>

* guix/build/haskell-build-system.scm: Generate Setup.hs if missing,
after unpack phase.
---
 guix/build/haskell-build-system.scm | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/guix/build/haskell-build-system.scm b/guix/build/haskell-build-system.scm
index 5c5b32322b..0c648e510f 100644
--- a/guix/build/haskell-build-system.scm
+++ b/guix/build/haskell-build-system.scm
@@ -275,9 +275,21 @@ given Haskell package."
       (_ (error "Could not find a Cabal file to patch."))))
   #t)
 
+(define* (generate-setup #:rest empty)
+  "Generate boilerplate Setup.hs if missing."
+  (when (not (or (file-exists? "Setup.hs")
+                 (file-exists? "Setup.lhs")))
+    (format #t "generating missing Setup.hs~%")
+    (with-output-to-file "Setup.hs"
+      (lambda ()
+        (format #t "import Distribution.Simple~%")
+        (format #t "main = defaultMain~%"))))
+  #t)
+
 (define %standard-phases
   (modify-phases gnu:%standard-phases
     (add-after 'unpack 'patch-cabal-file patch-cabal-file)
+    (add-after 'unpack 'generate-setup generate-setup)
     (delete 'bootstrap)
     (add-before 'configure 'setup-compiler setup-compiler)
     (add-before 'install 'haddock haddock)
-- 
2.20.1 (Apple Git-117)

[bug#35930] [PATCH 4/4] gnu: haskell: leave Setup.hs generation to build system

[Robert Vollmert]

Remove explicit Setup.hs generation from the configure step
now that haskell-build-system does it.

* gnu/packages/haskell.scm (ghc-foundation, ghc-inline-c,
ghc-inline-c-cpp, ghc-rio): Don't generate Setup.hs
---
 gnu/packages/haskell.scm | 42 ----------------------------------------
 1 file changed, 42 deletions(-)

diff --git a/gnu/packages/haskell.scm b/gnu/packages/haskell.scm
index 44b9e9066a..160b0a1fca 100644
--- a/gnu/packages/haskell.scm
+++ b/gnu/packages/haskell.scm
@@ -9688,16 +9688,6 @@ packages.")
         (base32
          "1q43y8wfj0wf9gdq2kzphwjwq6m5pvryy1lqgk954aq5z3ks1lsf"))))
     (build-system haskell-build-system)
-    (arguments
-     `(#:phases
-       (modify-phases %standard-phases
-         (add-after 'unpack 'add-setup-script
-           (lambda _
-             ;; The usual "Setup.hs" script is missing from the source.
-             (with-output-to-file "Setup.hs"
-               (lambda ()
-                 (format #t "import Distribution.Simple~%")
-                 (format #t "main = defaultMain~%"))))))))
     (inputs `(("ghc-basement" ,ghc-basement)))
     (home-page "https://github.com/haskell-foundation/foundation")
     (synopsis "Alternative prelude with batteries and no dependencies")
@@ -10575,16 +10565,6 @@ widths to the Char type.")
         (base32
          "064h8a4hp53a479d3ak0vmqbx8hi0cpg7zn4wp23rjy26dka8p7g"))))
     (build-system haskell-build-system)
-    (arguments
-     `(#:phases
-       (modify-phases %standard-phases
-         (add-after 'unpack 'add-setup-script
-           (lambda _
-             ;; The usual "Setup.hs" script is missing from the source.
-             (with-output-to-file "Setup.hs"
-               (lambda ()
-                 (format #t "import Distribution.Simple~%")
-                 (format #t "main = defaultMain~%"))))))))
     (inputs
      `(("ghc-exceptions" ,ghc-exceptions)
        ("ghc-hashable" ,ghc-hashable)
@@ -11107,17 +11087,6 @@ DOS/Windows paths and markup languages (such as XML).")
         (base32
          "0vbfrsqsi7mdziqsnj68bsqlwbqxxhvrmy9rv6w8z18d1m8w3n6h"))))
     (build-system haskell-build-system)
-    (arguments
-     `(#:phases
-       (modify-phases %standard-phases
-         (add-after 'unpack 'create-Setup.hs
-           (lambda _
-             (with-output-to-file "Setup.hs"
-               (lambda _
-                 (display "\
-import Distribution.Simple
-main = defaultMain")))
-             #t)))))
     (inputs
      `(("ghc-ansi-wl-pprint" ,ghc-ansi-wl-pprint)
        ("ghc-cryptohash" ,ghc-cryptohash)
@@ -11251,17 +11220,6 @@ handling wrong.")
         (base32
          "1rk7fmpkmxw9hhwr8df29kadnf0ybnwj64ggdbnsdrpfyhnkisci"))))
     (build-system haskell-build-system)
-    (arguments
-     `(#:phases
-       (modify-phases %standard-phases
-         (add-after 'unpack 'create-Setup.hs
-           (lambda _
-             (with-output-to-file "Setup.hs"
-               (lambda _
-                 (display "\
-import Distribution.Simple
-main = defaultMain")))
-             #t)))))
     (inputs
      `(("ghc-inline-c" ,ghc-inline-c)
        ("ghc-safe-exceptions" ,ghc-safe-exceptions)))
-- 
2.20.1 (Apple Git-117)

[bug#35930] haskell Setup.hs-related changes

[Ludovic Courtès]

Hi Robert,

Robert Vollmert <rob@vllmrt.net> skribis:

> This primarily moves the substitution of missing Setup.hs files to
> haskell-build-system. There was already duplicate code in a number
> of packages to generated boilerplate Setup.hs, and I ran into a
> couple more while trying to import some other packages.

This looks like a welcome and harmless factorization; Timothy, Ricardo:
WDYT?

  https://issues.guix.gnu.org/issue/35930

Thanks,
Ludo’.

[bug#35930] haskell Setup.hs-related changes

[Timothy Sample]

Hi!

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

> Hi Robert,
>
> Robert Vollmert <rob@vllmrt.net> skribis:
>
>> This primarily moves the substitution of missing Setup.hs files to
>> haskell-build-system. There was already duplicate code in a number
>> of packages to generated boilerplate Setup.hs, and I ran into a
>> couple more while trying to import some other packages.
>
> This looks like a welcome and harmless factorization; Timothy, Ricardo:
> WDYT?
>
>   https://issues.guix.gnu.org/issue/35930

The first patch breaks “ghc-easyplot”.

I’m currently building some packages to test the other patches, and if
everything builds fine, they LGTM with some minor tweaks (which I’ve
already made).  Should I push it to master or staging?  It means
rebuilding all of our Haskell packages, which is a few hundered
packages.

Robert, do you know why the first patch doesn’t work?  Should I just
omit it?


-- Tim

[bug#35930] haskell Setup.hs-related changes

[Robert Vollmert]

> On 13. Jun 2019, at 17:57, Timothy Sample <samplet@ngyro.com> wrote:
>>  https://issues.guix.gnu.org/issue/35930
> 
> The first patch breaks “ghc-easyplot”.
> 
> I’m currently building some packages to test the other patches, and if
> everything builds fine, they LGTM with some minor tweaks (which I’ve
> already made).  Should I push it to master or staging?  It means
> rebuilding all of our Haskell packages, which is a few hundered
> packages.
> 
> Robert, do you know why the first patch doesn’t work?  Should I just
> omit it?

Yes go head, I thought it worked at some point but am very doubtful
right now. I’ll look into it again, but it’s not a necessary part here
I think.

bug#35930: haskell Setup.hs-related changes

[Timothy Sample]

Hello,

Robert Vollmert <rob@vllmrt.net> writes:

>> On 13. Jun 2019, at 17:57, Timothy Sample <samplet@ngyro.com> wrote:
>>>  https://issues.guix.gnu.org/issue/35930
>> 
>> The first patch breaks “ghc-easyplot”.
>> 
>> I’m currently building some packages to test the other patches, and if
>> everything builds fine, they LGTM with some minor tweaks (which I’ve
>> already made).  Should I push it to master or staging?  It means
>> rebuilding all of our Haskell packages, which is a few hundered
>> packages.
>> 
>> Robert, do you know why the first patch doesn’t work?  Should I just
>> omit it?
>
> Yes go head, I thought it worked at some point but am very doubtful
> right now. I’ll look into it again, but it’s not a necessary part here
> I think.

Pushed to staging, since ~550 packages is well over the manual’s
recommended limit of 300.

I omitted the first patch and merged the last two together (doing so is
consistent with similar changes in the past).

Thanks Robert!


-- Tim