Package: guix-patches;
Reported by: Philip McGrath <philip <at> philipmcgrath.com>
Date: Tue, 8 Feb 2022 15:14:01 UTC
Severity: normal
Tags: patch
Merged with 53997
Done: Liliana Marie Prikler <liliana.prikler <at> gmail.com>
Bug is archived. No further changes may be made.
View this message in rfc822 format
From: Philip McGrath <philip <at> philipmcgrath.com> To: Liliana Marie Prikler <liliana.prikler <at> ist.tugraz.at>, 53878 <at> debbugs.gnu.org Subject: [bug#53878] [PATCH 05/11] gnu: Add stex. Date: Wed, 16 Feb 2022 15:46:50 -0500
Hi,
On 2/16/22 13:35, Philip McGrath wrote:
> Hi,
>
> On 2/14/22 09:46, Liliana Marie Prikler wrote:
>> Am Sonntag, dem 13.02.2022 um 16:51 -0500 schrieb Philip McGrath:
>>> * gnu/packages/chez-and-racket-bootstrap.scm (stex-bootstrap): New
>>> variable.
>>> (stex): Change from origin to package inheriting from 'stex-
>>> bootstrap'.
>>> (chez-scheme)[native-inputs]: Add 'stex-bootstrap'. Remove
>>> labels. Remove dependencies of stex-bootstrap.
>>> [inputs]: Remove labels.
>>> [arguments]: Adapt to use 'stex-bootstrap', 'search-input-file', and
>>> G-expressions.
>>> (nanopass): Make it public as a temporary workaround for Racket.
>>> * gnu/packages/racket.scm
>>> (racket-bootstrap-chez-bootfiles)[native-inputs]: Update accordingly.
>> This is again a large number of changes in one go. When it comes to
>> writing good patches, less is more, especially in terms of being
>> understandable.
I will separate the non-substantive changes to input labels and such as
discussed below.
>>> +(define (unpack-nanopass+stex)
>>> + ;; delayed resolution of `nanopass`
>>> + #~(begin
>>> + (copy-recursively #$nanopass
>>> + "nanopass"
>>> + #:keep-mtime? #t)
>>> + (mkdir-p "stex")
>>> + (with-output-to-file "stex/Mf-stex"
>>> + (lambda ()
>>> + ;; otherwise, it will try to download submodules
>>> + (display "# to placate ../configure")))))
>>> [...]
>>> - (snippet
>>> - ;; Remove bundled libraries.
>>> - (with-imported-modules '((guix build utils))
>>> - #~(begin
>>> - (use-modules (guix build utils))
>>> - (for-each (lambda (dir)
>>> - (when (directory-exists? dir)
>>> - (delete-file-recursively dir)))
>>> - '("stex"
>>> - "nanopass"
>>> - "lz4"
>>> - "zlib")))))))
>>> [...]
>>> + (snippet unbundle-chez-submodules)))
>> Why?
Why lift the snippet to `unbundle-chez-submodules`? The origin of Racket
also needs it, but wrapped in a `with-directory-excursion`.
>>
>>> (build-system gnu-build-system)
>>> (inputs
>>> - `(("libuuid" ,util-linux "lib")
>>> - ("zlib" ,zlib)
>>> - ("lz4" ,lz4)
>>> - ;; for expeditor:
>>> - ("ncurses" ,ncurses)
>>> - ;; for X11 clipboard support in expeditor:
>>> - ;;
>>> https://github.com/cisco/ChezScheme/issues/9#issuecomment-222057232
>>> - ("libx11" ,libx11)))
>>> - (native-inputs
>>> - `(("nanopass" ,nanopass) ; source only
>>> - ;; for docs
>>> - ("stex" ,stex)
>>> - ("xorg-rgb" ,xorg-rgb)
>>> - ("texlive" ,(texlive-updmap.cfg (list texlive-dvips-l3backend
>>> - texlive-epsf
>>> - texlive-fonts-ec
>>> - texlive-oberdiek)))
>>> - ("ghostscript" ,ghostscript)
>>> - ("netpbm" ,netpbm)))
>>> + (list
>>> + `(,util-linux "lib") ;<-- libuuid
>>> + zlib
>>> + lz4
>>> + ncurses ;<-- for expeditor
>>> + ;; for X11 clipboard support in expeditor:
>>> + ;;
>>> https://github.com/cisco/ChezScheme/issues/9#issuecomment-222057232
>>> + libx11))
>>> + (native-inputs (list stex-bootstrap))
>> This is a lot of noise. Either first clean up the inputs and then add
>> new ones or the other way round, but doing both in the same commit
>> (especially with other stuff as well) is too much imo.
Ok, I will clean the inputs before lifting out stex.
>>
>>> (native-search-paths
>>> (list (search-path-specification
>>> (variable "CHEZSCHEMELIBDIRS")
>>> (files (list (string-append "lib/chez-scheme"))))))
>>> (outputs '("out" "doc"))
>>> (arguments
>>> - `(#:modules
>>> - ((guix build gnu-build-system)
>>> + (list
>>> + #:modules
>>> + '((guix build gnu-build-system)
>>> (guix build utils)
>>> (ice-9 ftw)
>>> (ice-9 match))
>>> - #:test-target "test"
>>> - #:configure-flags
>>> - '("--threads") ;; TODO when we fix armhf, it doesn't support
>>> --threads
>>> - #:phases
>>> - (modify-phases %standard-phases
>>> - ;; put these where configure expects them to be
>>> - (add-after 'unpack 'unpack-nanopass+stex
>>> - (lambda* (#:key native-inputs inputs #:allow-other-keys)
>>> - (for-each (lambda (dep)
>>> - (define src
>>> - (assoc-ref (or native-inputs inputs)
>>> dep))
>>> - (copy-recursively src dep
>>> - #:keep-mtime? #t))
>>> - '("nanopass" "stex"))))
>>> - ;; NOTE: the custom Chez 'configure' script doesn't allow
>>> - ;; unrecognized flags, such as those automatically added
>>> - ;; by `gnu-build-system`.
>>> - (replace 'configure
>>> - (lambda* (#:key inputs outputs
>>> - (configure-flags '())
>>> - #:allow-other-keys)
>>> - (let* ((zlib-static (assoc-ref inputs "zlib:static"))
>>> - (lz4-static (assoc-ref inputs "lz4:static"))
>>> - (out (assoc-ref outputs "out"))
>>> - ;; add flags which are always required:
>>> - (flags (cons* (string-append "--installprefix="
>>> out)
>>> + #:test-target "test"
>>> + ;; TODO when we fix armhf, it may not support --threads
>>> + #:configure-flags #~'("--threads")
>>> + #:phases
>>> + #~(modify-phases %standard-phases
>>> + (add-after 'unpack 'unpack-nanopass+stex
>>> + (lambda args
>>> + #$(unpack-nanopass+stex)))
>>> + ;; NOTE: the custom Chez 'configure' script doesn't allow
>>> + ;; unrecognized flags, such as those automatically added
>>> + ;; by `gnu-build-system`.
>>> + (replace 'configure
>>> + (lambda* (#:key inputs (configure-flags '()) #:allow-
>>> other-keys)
>>> + ;; add flags which are always required:
>>> + (let ((flags (cons* (string-append "--installprefix="
>>> #$output)
>>> "ZLIB=-lz"
>>> "LZ4=-llz4"
>>> "--libkernel"
>>> @@ -305,90 +276,59 @@ (define src
>>> ;; and letting Chez try causes an
>>> error
>>> "--nogzip-man-pages"
>>> configure-flags)))
>>> - (format #t "configure flags: ~s~%" flags)
>>> - ;; Some makefiles (for tests) don't seem to propagate
>>> CC
>>> - ;; properly, so we take it out of their hands:
>>> - (setenv "CC" ,(cc-for-target))
>>> - (setenv "HOME" "/tmp")
>>> - (apply invoke
>>> - "./configure"
>>> - flags))))
>>> - ;; The binary file name is called "scheme" as is the one
>>> from MIT/GNU
>>> - ;; Scheme. We add a symlink to use in case both are
>>> installed.
>>> - (add-after 'install 'install-symlink
>>> - (lambda* (#:key outputs #:allow-other-keys)
>>> - (let* ((out (assoc-ref outputs "out"))
>>> - (bin (string-append out "/bin"))
>>> - (lib (string-append out "/lib"))
>>> - (name "chez-scheme"))
>>> - (symlink (string-append bin "/scheme")
>>> - (string-append bin "/" name))
>>> - (map (lambda (file)
>>> - (symlink file (string-append (dirname file)
>>> - "/" name
>>> ".boot")))
>>> - (find-files lib "scheme.boot")))))
>>> - ;; Building explicitly lets us avoid using substitute*
>>> - ;; to re-write makefiles.
>>> - (add-after 'install-symlink 'prepare-stex
>>> - (lambda* (#:key native-inputs inputs outputs #:allow-
>>> other-keys)
>>> - (let* ((stex+version
>>> - (strip-store-file-name
>>> - (assoc-ref (or native-inputs inputs) "stex")))
>>> - ;; Eventually we want to install stex as a real
>>> - ;; package so it's reusable. For now:
>>> - (stex-output "/tmp")
>>> - (doc-dir (string-append stex-output
>>> - "/share/doc/"
>>> - stex+version)))
>>> - (with-directory-excursion "stex"
>>> - (invoke "make"
>>> - "install"
>>> - (string-append "LIB="
>>> - stex-output
>>> - "/lib/"
>>> - stex+version)
>>> - (string-append "Scheme="
>>> - (assoc-ref outputs "out")
>>> - "/bin/scheme"))
>>> - (for-each (lambda (pth)
>>> - (install-file pth doc-dir))
>>> - '("ReadMe" ; includes the license
>>> - "doc/stex.html"
>>> - "doc/stex.css"
>>> - "doc/stex.pdf"))))))
>>> - ;; Building the documentation requires stex and a running
>>> scheme.
>>> - ;; FIXME: this is probably wrong for cross-compilation
>>> - (add-after 'prepare-stex 'install-doc
>>> - (lambda* (#:key native-inputs inputs outputs #:allow-
>>> other-keys)
>>> - (let* ((chez+version (strip-store-file-name
>>> - (assoc-ref outputs "out")))
>>> - (stex+version
>>> - (strip-store-file-name
>>> - (assoc-ref (or native-inputs inputs) "stex")))
>>> - (scheme (string-append (assoc-ref outputs "out")
>>> - "/bin/scheme"))
>>> - ;; see note on stex-output in phase build-stex,
>>> above:
>>> - (stexlib (string-append "/tmp"
>>> - "/lib/"
>>> - stex+version))
>>> - (doc-dir (string-append (assoc-ref outputs
>>> "doc")
>>> - "/share/doc/"
>>> - chez+version)))
>>> - (define* (stex-make #:optional (suffix ""))
>>> - (invoke "make"
>>> - "install"
>>> - (string-append "Scheme=" scheme)
>>> - (string-append "STEXLIB=" stexlib)
>>> - (string-append "installdir=" doc-dir
>>> suffix)))
>>> - (with-directory-excursion "csug"
>>> - (stex-make "/csug"))
>>> - (with-directory-excursion "release_notes"
>>> - (stex-make "/release_notes"))
>>> - (with-directory-excursion doc-dir
>>> - (symlink "release_notes/release_notes.pdf"
>>> - "release_notes.pdf")
>>> - (symlink "csug/csug9_5.pdf"
>>> - "csug.pdf"))))))))
>>> + (format #t "configure flags: ~s~%" flags)
>>> + ;; Some makefiles (for tests) don't seem to
>>> propagate CC
>>> + ;; properly, so we take it out of their hands:
>>> + (setenv "CC" #$(cc-for-target))
>>> + (setenv "HOME" "/tmp")
>>> + (apply invoke "./configure" flags))))
>>> + ;; The binary file name is called "scheme" as is the one
>>> from
>>> + ;; MIT/GNU Scheme. We add a symlink to use in case both
>>> are
>>> + ;; installed.
>>> + (add-after 'install 'install-symlink
>>> + (lambda* (#:key outputs #:allow-other-keys)
>>> + (let* ((scheme (search-input-file outputs
>>> "/bin/scheme"))
>>> + (bin-dir (dirname scheme)))
>>> + (symlink scheme
>>> + (string-append bin-dir "/chez-scheme"))
>>> + (match (find-files (string-append bin-dir "/../lib")
>>> + "scheme.boot")
>>> + ((scheme.boot)
>>> + (symlink scheme.boot
>>> + (string-append (dirname scheme.boot)
>>> + "/chez-
>>> scheme.boot")))))))
>>> + ;; Building the documentation requires stex and a running
>>> scheme.
>>> + ;; FIXME: this is probably wrong for cross-compilation
>>> + (add-after 'install-symlink 'install-doc
>>> + (lambda* (#:key native-inputs inputs outputs
>>> + #:allow-other-keys)
>>> + (match (assoc-ref outputs "doc")
>>> + (#f
>>> + (format #t "not installing docs~%"))
>>> + (doc-prefix
>>> + (let* ((chez+version (strip-store-file-name
>>> #$output))
>>> + (scheme (search-input-file outputs
>>> "/bin/scheme"))
>>> + (stexlib (search-input-directory
>>> + (or native-inputs inputs)
>>> + "/lib/stex"))
>>> + (doc-dir (string-append doc-prefix
>>> + "/share/doc/"
>>> + chez+version)))
>>> + (define* (stex-make #:optional (suffix ""))
>>> + (invoke "make" "install"
>>> + (string-append "Scheme=" scheme)
>>> + (string-append "STEXLIB=" stexlib)
>>> + (string-append "installdir="
>>> + doc-dir suffix)))
>>> + (with-directory-excursion "csug"
>>> + (stex-make "/csug"))
>>> + (with-directory-excursion "release_notes"
>>> + (stex-make "/release_notes"))
>>> + (with-directory-excursion doc-dir
>>> + (symlink "release_notes/release_notes.pdf"
>>> + "release_notes.pdf")
>>> + (symlink "csug/csug9_5.pdf"
>>> + "csug.pdf"))))))))))
>> Again mixing cosmetic changes with functional ones.
Ok, I separate these.
>>> @@ -412,3 +352,145 @@ (define* (stex-make #:optional (suffix ""))
>>> generates native code for each target processor, with support for
>>> x86, x86_64,
>>> and 32-bit PowerPC architectures.")
>>> (license license:asl2.0)))
>>> +
>>> +;;
>>> +;; Chez's bootstrap dependencies:
>>> +;;
...
>> Not quite sure on these hunks. Could be fine, could not be fine.
>> Disentangling stex from chez and publicly exporting it is probably a
>> good idea, though.
Especially because it is also needed to build the docs for nanopass,
itself, and at least one package not yet in Guix
(<https://github.com/becls/swish>).
-Philip
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.