* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
@ 2021-07-11 0:37 Paul A. Patience
2021-07-12 1:01 ` Paul A. Patience
0 siblings, 1 reply; 15+ messages in thread
From: Paul A. Patience @ 2021-07-11 0:37 UTC (permalink / raw)
To: 49517
[-- Attachment #1: Type: text/plain, Size: 13 bytes --]
Empty Message
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-gnu-txr-Build-documentation.patch --]
[-- Type: text/x-patch; name=0001-gnu-txr-Build-documentation.patch, Size: 7002 bytes --]
From 078e028b34497a928399151db1a5edd12d7c9196 Mon Sep 17 00:00:00 2001
From: "Paul A. Patience" <paul@apatience.com>
Date: Sat, 10 Jul 2021 20:23:49 -0400
Subject: [PATCH 1/2] gnu: txr: Build documentation.
* gnu/packages/lisp.scm (man-for-txr): New variable.
(txr)[native-inputs]: New field.
[inputs]: Move above the arguments field.
[arguments]<#:phases>{inhibit-doc-syms-generation, build-doc}
{install-doc}: New phases.
{fix-tests}: Add after the unpack phase rather than after the configure
phase so that all file-modifying phases are performed after unpacking.
---
gnu/packages/lisp.scm | 95 ++++++++++++++++++++++++++++++++++++++++---
1 file changed, 89 insertions(+), 6 deletions(-)
diff --git a/gnu/packages/lisp.scm b/gnu/packages/lisp.scm
index 382f48beb1..8f3be7dafe 100644
--- a/gnu/packages/lisp.scm
+++ b/gnu/packages/lisp.scm
@@ -18,6 +18,7 @@
;;; Copyright © 2020 Marius Bakke <mbakke@fastmail.com>
;;; Copyright © 2020 Zhu Zihao <all_but_last@163.com>
;;; Copyright © 2021 Sharlatan Hellseher <sharlatanus@gmail.com>
+;;; Copyright © 2021 Paul A. Patience <paul@apatience.com>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -59,8 +60,10 @@
#:use-module (gnu packages fontutils)
#:use-module (gnu packages gcc)
#:use-module (gnu packages gettext)
+ #:use-module (gnu packages ghostscript)
#:use-module (gnu packages gl)
#:use-module (gnu packages glib)
+ #:use-module (gnu packages groff)
#:use-module (gnu packages m4)
#:use-module (gnu packages maths)
#:use-module (gnu packages multiprecision)
@@ -846,6 +849,60 @@ enough to play the original mainframe Zork all the way through.")
(home-page "http://www.russotto.net/git/mrussotto/confusion/src/master/src/README")
(license license:gpl3+))))
+(define man-for-txr
+ (let ((commit "dfbf19b9a96474b8c1bacac85e43605e5691ceb2")
+ ;; Number of additional commits since the last tag (see the output of
+ ;; "git describe --tags").
+ (revision "41"))
+ (package
+ (name "man-for-txr")
+ (version (git-version "1.6g" revision commit))
+ (source
+ (origin
+ (method git-fetch)
+ (uri (git-reference
+ (url "http://www.kylheku.com/git/man/")
+ (commit commit)))
+ (file-name (git-file-name name version))
+ (sha256
+ (base32 "1zy0g8fj9nsfwzvg88hyaiy94r8j14xhs8vy2ln2niqdm6x2lvy2"))))
+ (build-system gnu-build-system)
+ (arguments
+ `(#:tests? #f ; There are no tests.
+ #:phases
+ (modify-phases %standard-phases
+ (add-after 'unpack 'fix-man2html-makefile
+ (lambda _
+ (substitute* "man2html/Makefile.in"
+ ;; It inadvertently ignores @bindir@.
+ (("^(bindir = \\$\\(DESTDIR\\)\\$\\(PREFIX\\)).*" _ prefix)
+ (string-append prefix "@bindir@\n")))
+ #t))
+ (add-after 'unpack 'delete-generated-files
+ (lambda _
+ (for-each delete-file
+ (append
+ (list "conf_script")
+ (map (lambda (d) (string-append d "/Makefile"))
+ '("." "man" "man2html" "src"))
+ (map (lambda (f) (string-append "src/" f))
+ '("makewhatis.in" "man.conf"
+ "paths.h" "version.h"))))
+ #t))
+ (replace 'configure
+ (lambda* (#:key outputs #:allow-other-keys)
+ (setenv "CC" ,(cc-for-target))
+ ;; Humor the manually written configure script.
+ (invoke "./configure" "+lang" "en" "+fhs"
+ (string-append "-prefix=" (assoc-ref outputs "out")))
+ #t)))))
+ (home-page "http://www.kylheku.com/cgit/man/")
+ (synopsis "Modifications to the man utilities, specifically man2html")
+ (description
+ "This is a fork of the man utilities intended specifically for building
+the HTML documentation of TXR.")
+ (license license:gpl2))))
+
(define-public txr
(package
(name "txr")
@@ -860,6 +917,13 @@ enough to play the original mainframe Zork all the way through.")
(sha256
(base32 "14zaziymnbr2ld79x4h7sf88bzzzj82w3xpavmcx7mhwannb2swh"))))
(build-system gnu-build-system)
+ (native-inputs
+ ;; Required to build the documentation.
+ `(("ghostscript" ,ghostscript)
+ ("groff" ,groff)
+ ("man2html" ,man-for-txr)))
+ (inputs
+ `(("libffi" ,libffi)))
(arguments
`(#:configure-flags
(list ,(string-append "cc=" (cc-for-target))
@@ -867,6 +931,22 @@ enough to play the original mainframe Zork all the way through.")
#:test-target "tests"
#:phases
(modify-phases %standard-phases
+ (add-after 'unpack 'inhibit-doc-syms-generation
+ (lambda _
+ (substitute* "genman.txr"
+ ;; Exit from genman.txr before it tries to write to
+ ;; stdlib/doc-syms.tl, which is anyway kept up to date with
+ ;; each release (and is already compiled to stdlib/doc-syms.tlo
+ ;; when genman.txr is run).
+ (("^@\\(output \"share/txr/stdlib/doc-syms\\.tl\"\\).*" line)
+ (string-append "@(do (exit))\n" line)))
+ #t))
+ (add-after 'unpack 'fix-tests
+ (lambda _
+ (substitute* (list "tests/017/realpath.tl"
+ "tests/017/realpath.expected")
+ (("/usr/bin") "/"))
+ #t))
(replace 'configure
;; ./configure is a hand-written script that can't handle standard
;; autotools arguments like CONFIG_SHELL.
@@ -874,14 +954,17 @@ enough to play the original mainframe Zork all the way through.")
(setenv "txr_shell" (which "bash"))
(apply invoke "./configure" configure-flags)
#t))
- (add-after 'configure 'fix-tests
+ (add-after 'build 'build-doc
(lambda _
- (substitute* (list "tests/017/realpath.tl"
- "tests/017/realpath.expected")
- (("/usr/bin") "/"))
+ (invoke "make" "txr-manpage.html" "txr-manpage.pdf")
+ #t))
+ (add-after 'install 'install-doc
+ (lambda* (#:key outputs #:allow-other-keys)
+ (let ((doc (string-append (assoc-ref outputs "out")
+ "/share/doc/" ,name "-" ,version)))
+ (for-each (lambda (f) (install-file f doc))
+ '("txr-manpage.html" "txr-manpage.pdf")))
#t)))))
- (inputs
- `(("libffi" ,libffi)))
(synopsis "General-purpose, multi-paradigm programming language")
(description
"TXR is a general-purpose, multi-paradigm programming language. It
--
2.32.0
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0002-gnu-txr-Update-to-265.patch --]
[-- Type: text/x-patch; name=0002-gnu-txr-Update-to-265.patch, Size: 2555 bytes --]
From 6a1848b05de9e66cdbc561c0ddb2f3c338823e87 Mon Sep 17 00:00:00 2001
From: "Paul A. Patience" <paul@apatience.com>
Date: Sat, 10 Jul 2021 20:31:32 -0400
Subject: [PATCH 2/2] gnu: txr: Update to 265.
* gnu/packages/lisp.scm (txr)[version]: Update to 265.
[arguments]<#:phases>{disable-failing-tests}: New phase.
---
gnu/packages/lisp.scm | 17 ++++++++++++++---
1 file changed, 14 insertions(+), 3 deletions(-)
diff --git a/gnu/packages/lisp.scm b/gnu/packages/lisp.scm
index 8f3be7dafe..12c726b36c 100644
--- a/gnu/packages/lisp.scm
+++ b/gnu/packages/lisp.scm
@@ -906,7 +906,7 @@ the HTML documentation of TXR.")
(define-public txr
(package
(name "txr")
- (version "263")
+ (version "265")
(source
(origin
(method git-fetch)
@@ -915,7 +915,7 @@ the HTML documentation of TXR.")
(commit (string-append "txr-" version))))
(file-name (git-file-name name version))
(sha256
- (base32 "14zaziymnbr2ld79x4h7sf88bzzzj82w3xpavmcx7mhwannb2swh"))))
+ (base32 "0v39323rblhl3gr03midxkx9njzzvs0scm3kmfpw5s0n5jd6drr6"))))
(build-system gnu-build-system)
(native-inputs
;; Required to build the documentation.
@@ -938,7 +938,7 @@ the HTML documentation of TXR.")
;; stdlib/doc-syms.tl, which is anyway kept up to date with
;; each release (and is already compiled to stdlib/doc-syms.tlo
;; when genman.txr is run).
- (("^@\\(output \"share/txr/stdlib/doc-syms\\.tl\"\\).*" line)
+ (("^@\\(output \"stdlib/doc-syms\\.tl\"\\).*" line)
(string-append "@(do (exit))\n" line)))
#t))
(add-after 'unpack 'fix-tests
@@ -947,6 +947,17 @@ the HTML documentation of TXR.")
"tests/017/realpath.expected")
(("/usr/bin") "/"))
#t))
+ (add-after 'unpack 'disable-failing-tests
+ ;; These tests pass when run manually in the directory left by
+ ;; --keep-failed.
+ (lambda _
+ (for-each delete-file
+ (map (lambda (f) (string-append "tests/" f))
+ '("002/query-1.txr"
+ "010/json.tl"
+ "018/path-test.tl"
+ "018/process.tl")))
+ #t))
(replace 'configure
;; ./configure is a hand-written script that can't handle standard
;; autotools arguments like CONFIG_SHELL.
--
2.32.0
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-11 0:37 [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265 Paul A. Patience
@ 2021-07-12 1:01 ` Paul A. Patience
2021-07-13 23:45 ` Paul A. Patience
0 siblings, 1 reply; 15+ messages in thread
From: Paul A. Patience @ 2021-07-12 1:01 UTC (permalink / raw)
To: 49517
[-- Attachment #1: Type: text/plain, Size: 200 bytes --]
I've managed to fix one of the failing tests
and narrowed down the problem of the others.
(Only the second patch is different, but I've
attached both for your convenience.)
Best regards,
Paul
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-gnu-txr-Build-documentation.patch --]
[-- Type: text/x-patch; name=0001-gnu-txr-Build-documentation.patch, Size: 7002 bytes --]
From 078e028b34497a928399151db1a5edd12d7c9196 Mon Sep 17 00:00:00 2001
From: "Paul A. Patience" <paul@apatience.com>
Date: Sat, 10 Jul 2021 20:23:49 -0400
Subject: [PATCH 1/2] gnu: txr: Build documentation.
* gnu/packages/lisp.scm (man-for-txr): New variable.
(txr)[native-inputs]: New field.
[inputs]: Move above the arguments field.
[arguments]<#:phases>{inhibit-doc-syms-generation, build-doc}
{install-doc}: New phases.
{fix-tests}: Add after the unpack phase rather than after the configure
phase so that all file-modifying phases are performed after unpacking.
---
gnu/packages/lisp.scm | 95 ++++++++++++++++++++++++++++++++++++++++---
1 file changed, 89 insertions(+), 6 deletions(-)
diff --git a/gnu/packages/lisp.scm b/gnu/packages/lisp.scm
index 382f48beb1..8f3be7dafe 100644
--- a/gnu/packages/lisp.scm
+++ b/gnu/packages/lisp.scm
@@ -18,6 +18,7 @@
;;; Copyright © 2020 Marius Bakke <mbakke@fastmail.com>
;;; Copyright © 2020 Zhu Zihao <all_but_last@163.com>
;;; Copyright © 2021 Sharlatan Hellseher <sharlatanus@gmail.com>
+;;; Copyright © 2021 Paul A. Patience <paul@apatience.com>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -59,8 +60,10 @@
#:use-module (gnu packages fontutils)
#:use-module (gnu packages gcc)
#:use-module (gnu packages gettext)
+ #:use-module (gnu packages ghostscript)
#:use-module (gnu packages gl)
#:use-module (gnu packages glib)
+ #:use-module (gnu packages groff)
#:use-module (gnu packages m4)
#:use-module (gnu packages maths)
#:use-module (gnu packages multiprecision)
@@ -846,6 +849,60 @@ enough to play the original mainframe Zork all the way through.")
(home-page "http://www.russotto.net/git/mrussotto/confusion/src/master/src/README")
(license license:gpl3+))))
+(define man-for-txr
+ (let ((commit "dfbf19b9a96474b8c1bacac85e43605e5691ceb2")
+ ;; Number of additional commits since the last tag (see the output of
+ ;; "git describe --tags").
+ (revision "41"))
+ (package
+ (name "man-for-txr")
+ (version (git-version "1.6g" revision commit))
+ (source
+ (origin
+ (method git-fetch)
+ (uri (git-reference
+ (url "http://www.kylheku.com/git/man/")
+ (commit commit)))
+ (file-name (git-file-name name version))
+ (sha256
+ (base32 "1zy0g8fj9nsfwzvg88hyaiy94r8j14xhs8vy2ln2niqdm6x2lvy2"))))
+ (build-system gnu-build-system)
+ (arguments
+ `(#:tests? #f ; There are no tests.
+ #:phases
+ (modify-phases %standard-phases
+ (add-after 'unpack 'fix-man2html-makefile
+ (lambda _
+ (substitute* "man2html/Makefile.in"
+ ;; It inadvertently ignores @bindir@.
+ (("^(bindir = \\$\\(DESTDIR\\)\\$\\(PREFIX\\)).*" _ prefix)
+ (string-append prefix "@bindir@\n")))
+ #t))
+ (add-after 'unpack 'delete-generated-files
+ (lambda _
+ (for-each delete-file
+ (append
+ (list "conf_script")
+ (map (lambda (d) (string-append d "/Makefile"))
+ '("." "man" "man2html" "src"))
+ (map (lambda (f) (string-append "src/" f))
+ '("makewhatis.in" "man.conf"
+ "paths.h" "version.h"))))
+ #t))
+ (replace 'configure
+ (lambda* (#:key outputs #:allow-other-keys)
+ (setenv "CC" ,(cc-for-target))
+ ;; Humor the manually written configure script.
+ (invoke "./configure" "+lang" "en" "+fhs"
+ (string-append "-prefix=" (assoc-ref outputs "out")))
+ #t)))))
+ (home-page "http://www.kylheku.com/cgit/man/")
+ (synopsis "Modifications to the man utilities, specifically man2html")
+ (description
+ "This is a fork of the man utilities intended specifically for building
+the HTML documentation of TXR.")
+ (license license:gpl2))))
+
(define-public txr
(package
(name "txr")
@@ -860,6 +917,13 @@ enough to play the original mainframe Zork all the way through.")
(sha256
(base32 "14zaziymnbr2ld79x4h7sf88bzzzj82w3xpavmcx7mhwannb2swh"))))
(build-system gnu-build-system)
+ (native-inputs
+ ;; Required to build the documentation.
+ `(("ghostscript" ,ghostscript)
+ ("groff" ,groff)
+ ("man2html" ,man-for-txr)))
+ (inputs
+ `(("libffi" ,libffi)))
(arguments
`(#:configure-flags
(list ,(string-append "cc=" (cc-for-target))
@@ -867,6 +931,22 @@ enough to play the original mainframe Zork all the way through.")
#:test-target "tests"
#:phases
(modify-phases %standard-phases
+ (add-after 'unpack 'inhibit-doc-syms-generation
+ (lambda _
+ (substitute* "genman.txr"
+ ;; Exit from genman.txr before it tries to write to
+ ;; stdlib/doc-syms.tl, which is anyway kept up to date with
+ ;; each release (and is already compiled to stdlib/doc-syms.tlo
+ ;; when genman.txr is run).
+ (("^@\\(output \"share/txr/stdlib/doc-syms\\.tl\"\\).*" line)
+ (string-append "@(do (exit))\n" line)))
+ #t))
+ (add-after 'unpack 'fix-tests
+ (lambda _
+ (substitute* (list "tests/017/realpath.tl"
+ "tests/017/realpath.expected")
+ (("/usr/bin") "/"))
+ #t))
(replace 'configure
;; ./configure is a hand-written script that can't handle standard
;; autotools arguments like CONFIG_SHELL.
@@ -874,14 +954,17 @@ enough to play the original mainframe Zork all the way through.")
(setenv "txr_shell" (which "bash"))
(apply invoke "./configure" configure-flags)
#t))
- (add-after 'configure 'fix-tests
+ (add-after 'build 'build-doc
(lambda _
- (substitute* (list "tests/017/realpath.tl"
- "tests/017/realpath.expected")
- (("/usr/bin") "/"))
+ (invoke "make" "txr-manpage.html" "txr-manpage.pdf")
+ #t))
+ (add-after 'install 'install-doc
+ (lambda* (#:key outputs #:allow-other-keys)
+ (let ((doc (string-append (assoc-ref outputs "out")
+ "/share/doc/" ,name "-" ,version)))
+ (for-each (lambda (f) (install-file f doc))
+ '("txr-manpage.html" "txr-manpage.pdf")))
#t)))))
- (inputs
- `(("libffi" ,libffi)))
(synopsis "General-purpose, multi-paradigm programming language")
(description
"TXR is a general-purpose, multi-paradigm programming language. It
--
2.32.0
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0002-gnu-txr-Update-to-265.patch --]
[-- Type: text/x-patch; name=0002-gnu-txr-Update-to-265.patch, Size: 2839 bytes --]
From 9b9649013442b856d6b5d73e7c8a707d96399306 Mon Sep 17 00:00:00 2001
From: "Paul A. Patience" <paul@apatience.com>
Date: Sun, 11 Jul 2021 20:56:41 -0400
Subject: [PATCH 2/2] gnu: txr: Update to 265.
* gnu/packages/lisp.scm (txr)[version]: Update to 265.
[arguments]<#:phases>{disable-failing-tests}: New phase.
---
gnu/packages/lisp.scm | 21 ++++++++++++++++++---
1 file changed, 18 insertions(+), 3 deletions(-)
diff --git a/gnu/packages/lisp.scm b/gnu/packages/lisp.scm
index 8f3be7dafe..37908f9ed3 100644
--- a/gnu/packages/lisp.scm
+++ b/gnu/packages/lisp.scm
@@ -906,7 +906,7 @@ the HTML documentation of TXR.")
(define-public txr
(package
(name "txr")
- (version "263")
+ (version "265")
(source
(origin
(method git-fetch)
@@ -915,7 +915,7 @@ the HTML documentation of TXR.")
(commit (string-append "txr-" version))))
(file-name (git-file-name name version))
(sha256
- (base32 "14zaziymnbr2ld79x4h7sf88bzzzj82w3xpavmcx7mhwannb2swh"))))
+ (base32 "0v39323rblhl3gr03midxkx9njzzvs0scm3kmfpw5s0n5jd6drr6"))))
(build-system gnu-build-system)
(native-inputs
;; Required to build the documentation.
@@ -938,7 +938,7 @@ the HTML documentation of TXR.")
;; stdlib/doc-syms.tl, which is anyway kept up to date with
;; each release (and is already compiled to stdlib/doc-syms.tlo
;; when genman.txr is run).
- (("^@\\(output \"share/txr/stdlib/doc-syms\\.tl\"\\).*" line)
+ (("^@\\(output \"stdlib/doc-syms\\.tl\"\\).*" line)
(string-append "@(do (exit))\n" line)))
#t))
(add-after 'unpack 'fix-tests
@@ -946,6 +946,21 @@ the HTML documentation of TXR.")
(substitute* (list "tests/017/realpath.tl"
"tests/017/realpath.expected")
(("/usr/bin") "/"))
+ (substitute* "tests/018/path-test.tl"
+ (("/bin") (dirname (which "sh"))))
+ #t))
+ (add-after 'unpack 'disable-failing-tests
+ (lambda _
+ (for-each delete-file
+ ;; These tests fail because their calls to some
+ ;; external commands fail.
+ ;; (They pass when run manually in the directory
+ ;; left by --keep-failed.)
+ (map (lambda (f) (string-append "tests/" f))
+ '("002/query-1.txr" ; Calls "ls".
+ "010/json.tl" ; Calls "cat".
+ "018/process.tl" ; Calls "echo".
+ )))
#t))
(replace 'configure
;; ./configure is a hand-written script that can't handle standard
--
2.32.0
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-12 1:01 ` Paul A. Patience
@ 2021-07-13 23:45 ` Paul A. Patience
2021-07-17 9:57 ` Guillaume Le Vaillant
0 siblings, 1 reply; 15+ messages in thread
From: Paul A. Patience @ 2021-07-13 23:45 UTC (permalink / raw)
To: 49517; +Cc: Kaz Kylheku
[-- Attachment #1: Type: text/plain, Size: 492 bytes --]
On Sunday, July 11th, 2021 at 21:01, Paul A. Patience <paul@apatience.com> wrote:
> I've managed to fix one of the failing tests
> and narrowed down the problem of the others.
Kaz Kylheku has determined the cause of the failing tests,
so I've updated the comment to reflect his conclusions.
There has been a new release so I've updated the package
to TXR version 266.
Once again, only the second attached patch is different
from my initial submission.
Best regards,
Paul
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-gnu-txr-Build-documentation.patch --]
[-- Type: text/x-patch; name=0001-gnu-txr-Build-documentation.patch, Size: 7002 bytes --]
From 078e028b34497a928399151db1a5edd12d7c9196 Mon Sep 17 00:00:00 2001
From: "Paul A. Patience" <paul@apatience.com>
Date: Sat, 10 Jul 2021 20:23:49 -0400
Subject: [PATCH 1/2] gnu: txr: Build documentation.
* gnu/packages/lisp.scm (man-for-txr): New variable.
(txr)[native-inputs]: New field.
[inputs]: Move above the arguments field.
[arguments]<#:phases>{inhibit-doc-syms-generation, build-doc}
{install-doc}: New phases.
{fix-tests}: Add after the unpack phase rather than after the configure
phase so that all file-modifying phases are performed after unpacking.
---
gnu/packages/lisp.scm | 95 ++++++++++++++++++++++++++++++++++++++++---
1 file changed, 89 insertions(+), 6 deletions(-)
diff --git a/gnu/packages/lisp.scm b/gnu/packages/lisp.scm
index 382f48beb1..8f3be7dafe 100644
--- a/gnu/packages/lisp.scm
+++ b/gnu/packages/lisp.scm
@@ -18,6 +18,7 @@
;;; Copyright © 2020 Marius Bakke <mbakke@fastmail.com>
;;; Copyright © 2020 Zhu Zihao <all_but_last@163.com>
;;; Copyright © 2021 Sharlatan Hellseher <sharlatanus@gmail.com>
+;;; Copyright © 2021 Paul A. Patience <paul@apatience.com>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -59,8 +60,10 @@
#:use-module (gnu packages fontutils)
#:use-module (gnu packages gcc)
#:use-module (gnu packages gettext)
+ #:use-module (gnu packages ghostscript)
#:use-module (gnu packages gl)
#:use-module (gnu packages glib)
+ #:use-module (gnu packages groff)
#:use-module (gnu packages m4)
#:use-module (gnu packages maths)
#:use-module (gnu packages multiprecision)
@@ -846,6 +849,60 @@ enough to play the original mainframe Zork all the way through.")
(home-page "http://www.russotto.net/git/mrussotto/confusion/src/master/src/README")
(license license:gpl3+))))
+(define man-for-txr
+ (let ((commit "dfbf19b9a96474b8c1bacac85e43605e5691ceb2")
+ ;; Number of additional commits since the last tag (see the output of
+ ;; "git describe --tags").
+ (revision "41"))
+ (package
+ (name "man-for-txr")
+ (version (git-version "1.6g" revision commit))
+ (source
+ (origin
+ (method git-fetch)
+ (uri (git-reference
+ (url "http://www.kylheku.com/git/man/")
+ (commit commit)))
+ (file-name (git-file-name name version))
+ (sha256
+ (base32 "1zy0g8fj9nsfwzvg88hyaiy94r8j14xhs8vy2ln2niqdm6x2lvy2"))))
+ (build-system gnu-build-system)
+ (arguments
+ `(#:tests? #f ; There are no tests.
+ #:phases
+ (modify-phases %standard-phases
+ (add-after 'unpack 'fix-man2html-makefile
+ (lambda _
+ (substitute* "man2html/Makefile.in"
+ ;; It inadvertently ignores @bindir@.
+ (("^(bindir = \\$\\(DESTDIR\\)\\$\\(PREFIX\\)).*" _ prefix)
+ (string-append prefix "@bindir@\n")))
+ #t))
+ (add-after 'unpack 'delete-generated-files
+ (lambda _
+ (for-each delete-file
+ (append
+ (list "conf_script")
+ (map (lambda (d) (string-append d "/Makefile"))
+ '("." "man" "man2html" "src"))
+ (map (lambda (f) (string-append "src/" f))
+ '("makewhatis.in" "man.conf"
+ "paths.h" "version.h"))))
+ #t))
+ (replace 'configure
+ (lambda* (#:key outputs #:allow-other-keys)
+ (setenv "CC" ,(cc-for-target))
+ ;; Humor the manually written configure script.
+ (invoke "./configure" "+lang" "en" "+fhs"
+ (string-append "-prefix=" (assoc-ref outputs "out")))
+ #t)))))
+ (home-page "http://www.kylheku.com/cgit/man/")
+ (synopsis "Modifications to the man utilities, specifically man2html")
+ (description
+ "This is a fork of the man utilities intended specifically for building
+the HTML documentation of TXR.")
+ (license license:gpl2))))
+
(define-public txr
(package
(name "txr")
@@ -860,6 +917,13 @@ enough to play the original mainframe Zork all the way through.")
(sha256
(base32 "14zaziymnbr2ld79x4h7sf88bzzzj82w3xpavmcx7mhwannb2swh"))))
(build-system gnu-build-system)
+ (native-inputs
+ ;; Required to build the documentation.
+ `(("ghostscript" ,ghostscript)
+ ("groff" ,groff)
+ ("man2html" ,man-for-txr)))
+ (inputs
+ `(("libffi" ,libffi)))
(arguments
`(#:configure-flags
(list ,(string-append "cc=" (cc-for-target))
@@ -867,6 +931,22 @@ enough to play the original mainframe Zork all the way through.")
#:test-target "tests"
#:phases
(modify-phases %standard-phases
+ (add-after 'unpack 'inhibit-doc-syms-generation
+ (lambda _
+ (substitute* "genman.txr"
+ ;; Exit from genman.txr before it tries to write to
+ ;; stdlib/doc-syms.tl, which is anyway kept up to date with
+ ;; each release (and is already compiled to stdlib/doc-syms.tlo
+ ;; when genman.txr is run).
+ (("^@\\(output \"share/txr/stdlib/doc-syms\\.tl\"\\).*" line)
+ (string-append "@(do (exit))\n" line)))
+ #t))
+ (add-after 'unpack 'fix-tests
+ (lambda _
+ (substitute* (list "tests/017/realpath.tl"
+ "tests/017/realpath.expected")
+ (("/usr/bin") "/"))
+ #t))
(replace 'configure
;; ./configure is a hand-written script that can't handle standard
;; autotools arguments like CONFIG_SHELL.
@@ -874,14 +954,17 @@ enough to play the original mainframe Zork all the way through.")
(setenv "txr_shell" (which "bash"))
(apply invoke "./configure" configure-flags)
#t))
- (add-after 'configure 'fix-tests
+ (add-after 'build 'build-doc
(lambda _
- (substitute* (list "tests/017/realpath.tl"
- "tests/017/realpath.expected")
- (("/usr/bin") "/"))
+ (invoke "make" "txr-manpage.html" "txr-manpage.pdf")
+ #t))
+ (add-after 'install 'install-doc
+ (lambda* (#:key outputs #:allow-other-keys)
+ (let ((doc (string-append (assoc-ref outputs "out")
+ "/share/doc/" ,name "-" ,version)))
+ (for-each (lambda (f) (install-file f doc))
+ '("txr-manpage.html" "txr-manpage.pdf")))
#t)))))
- (inputs
- `(("libffi" ,libffi)))
(synopsis "General-purpose, multi-paradigm programming language")
(description
"TXR is a general-purpose, multi-paradigm programming language. It
--
2.32.0
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0002-gnu-txr-Update-to-266.patch --]
[-- Type: text/x-patch; name=0002-gnu-txr-Update-to-266.patch, Size: 3033 bytes --]
From c1295a3b83c7d446ea42a683b1384acd5645bfe8 Mon Sep 17 00:00:00 2001
From: "Paul A. Patience" <paul@apatience.com>
Date: Tue, 13 Jul 2021 19:38:12 -0400
Subject: [PATCH 2/2] gnu: txr: Update to 266.
* gnu/packages/lisp.scm (txr)[version]: Update to 266.
[arguments]<#:phases>{inhibit-doc-syms-generation}: Correct the path to
doc-syms.tl to its new location.
{fix-tests}: Fix another test.
{disable-failing-tests}: New phase.
---
gnu/packages/lisp.scm | 22 +++++++++++++++++++---
1 file changed, 19 insertions(+), 3 deletions(-)
diff --git a/gnu/packages/lisp.scm b/gnu/packages/lisp.scm
index 8f3be7dafe..8d2acc81e2 100644
--- a/gnu/packages/lisp.scm
+++ b/gnu/packages/lisp.scm
@@ -906,7 +906,7 @@ the HTML documentation of TXR.")
(define-public txr
(package
(name "txr")
- (version "263")
+ (version "266")
(source
(origin
(method git-fetch)
@@ -915,7 +915,7 @@ the HTML documentation of TXR.")
(commit (string-append "txr-" version))))
(file-name (git-file-name name version))
(sha256
- (base32 "14zaziymnbr2ld79x4h7sf88bzzzj82w3xpavmcx7mhwannb2swh"))))
+ (base32 "1k9mj3zaxdsylgnb8g6cq0cmp6420x7fp3nnsqdmds4gh8ib95wn"))))
(build-system gnu-build-system)
(native-inputs
;; Required to build the documentation.
@@ -938,7 +938,7 @@ the HTML documentation of TXR.")
;; stdlib/doc-syms.tl, which is anyway kept up to date with
;; each release (and is already compiled to stdlib/doc-syms.tlo
;; when genman.txr is run).
- (("^@\\(output \"share/txr/stdlib/doc-syms\\.tl\"\\).*" line)
+ (("^@\\(output \"stdlib/doc-syms\\.tl\"\\).*" line)
(string-append "@(do (exit))\n" line)))
#t))
(add-after 'unpack 'fix-tests
@@ -946,6 +946,22 @@ the HTML documentation of TXR.")
(substitute* (list "tests/017/realpath.tl"
"tests/017/realpath.expected")
(("/usr/bin") "/"))
+ (substitute* "tests/018/path-test.tl"
+ (("/bin") (dirname (which "sh"))))
+ #t))
+ (add-after 'unpack 'disable-failing-tests
+ (lambda _
+ (for-each delete-file
+ ;; These tests fail because they call external commands
+ ;; (like ls and cat) that don't run because the forked
+ ;; child processes' execvp calls cannot find the
+ ;; hardcoded /bin/sh.
+ ;; (The tests pass when run manually in the directory
+ ;; left by --keep-failed.)
+ (map (lambda (f) (string-append "tests/" f))
+ '("002/query-1.txr"
+ "010/json.tl"
+ "018/process.tl")))
#t))
(replace 'configure
;; ./configure is a hand-written script that can't handle standard
--
2.32.0
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-13 23:45 ` Paul A. Patience
@ 2021-07-17 9:57 ` Guillaume Le Vaillant
2021-07-17 22:51 ` Kaz Kylheku
0 siblings, 1 reply; 15+ messages in thread
From: Guillaume Le Vaillant @ 2021-07-17 9:57 UTC (permalink / raw)
To: Paul A. Patience; +Cc: Kaz Kylheku, 49517
[-- Attachment #1.1: Type: text/plain, Size: 887 bytes --]
Paul A. Patience <paul@apatience.com> skribis:
> On Sunday, July 11th, 2021 at 21:01, Paul A. Patience <paul@apatience.com> wrote:
>
>> I've managed to fix one of the failing tests
>> and narrowed down the problem of the others.
>
> Kaz Kylheku has determined the cause of the failing tests,
> so I've updated the comment to reflect his conclusions.
>
> There has been a new release so I've updated the package
> to TXR version 266.
>
> Once again, only the second attached patch is different
> from my initial submission.
>
> Best regards,
> Paul
Hi,
When testing the patch to build the HTML and PDF documentation,
I noticed that the 'share/doc/txr-263/txr-manpage.pdf' file is not
reproducible. There are some timestamps and UUIDs in it that change at
each build (diffoscope output attached).
Could you take a look at that and see if there's a way to make it
reproducible?
Thanks.
[-- Attachment #1.2: txr-diffoscope.txt.lz --]
[-- Type: application/octet-stream, Size: 1717 bytes --]
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 247 bytes --]
^ permalink raw reply [flat|nested] 15+ messages in thread
* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-17 9:57 ` Guillaume Le Vaillant
@ 2021-07-17 22:51 ` Kaz Kylheku
2021-07-18 3:43 ` Kaz Kylheku
0 siblings, 1 reply; 15+ messages in thread
From: Kaz Kylheku @ 2021-07-17 22:51 UTC (permalink / raw)
To: Guillaume Le Vaillant; +Cc: Paul A. Patience, 49517
On 2021-07-17 02:57, Guillaume Le Vaillant wrote:
> Hi,
>
> When testing the patch to build the HTML and PDF documentation,
> I noticed that the 'share/doc/txr-263/txr-manpage.pdf' file is not
> reproducible. There are some timestamps and UUIDs in it that change at
> each build (diffoscope output attached).
>
> Could you take a look at that and see if there's a way to make it
> reproducible?
> Thanks.
Hi Guillaume,
Thank you for your report. I don't see anything in the pdfroff
documentation
about getting rid of this. I might use a program similar to this one
to just overwrite the UUIDs and dates:
(let* ((pdf (file-get-string "txr-manpage.pdf"))
(start (search-str pdf "<?xpacket begin="))
(end (if start (search-str pdf "<?xpacket end" start)))
(xml (if end [pdf start..end]))
(orig-len (len xml)))
(unless xml
(format *stderr* "XML block not found in PDF")
(exit nil))
(upd xml
(regsub #/uuid:........-....-....-....-............/
"uuid:00000000-0000-0000-0000-000000000000")
(regsub #/Date>....-..-..T..:..:..-..:../
"Date>1970-01-01T00:00:00-00:00"))
(assert (eql (len xml) orig-len))
(set [pdf start..end] xml)
(file-put-string "txr-manpage.pdf.temp" pdf)
(rename-path "txr-manpage.pdf.temp" "txr-manpage.pdf"))
I have some questions.
1. When, for the sake of reproducible binary builds,
we replace date stamps with fixed dates, is there a preference for
what date to use? I used the Unix epoch, as you can see.
I'm aware of the convention involving the environment
variable SOURCE_DATE_EPOCH.
Should I use that?
2. Is there some recommended practice with regard to some
./configure option or environment/make variable to react to
for ensuring reproducible builds? So that is to say, suppose
I don't wish to do the above embedded XML cleaning, except
when building for a distro that strives for reproducibility.
For opting in to reproducibilty, should I again rely on
SOURCE_DATE_EPOCH and have the build react to it?
Thanks ...
^ permalink raw reply [flat|nested] 15+ messages in thread
* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-17 22:51 ` Kaz Kylheku
@ 2021-07-18 3:43 ` Kaz Kylheku
2021-07-18 10:36 ` Guillaume Le Vaillant
0 siblings, 1 reply; 15+ messages in thread
From: Kaz Kylheku @ 2021-07-18 3:43 UTC (permalink / raw)
To: Guillaume Le Vaillant; +Cc: Paul A. Patience, 49517
On 2021-07-17 15:51, Kaz Kylheku wrote:
> On 2021-07-17 02:57, Guillaume Le Vaillant wrote:
>> Hi,
>>
>> When testing the patch to build the HTML and PDF documentation,
>> I noticed that the 'share/doc/txr-263/txr-manpage.pdf' file is not
>> reproducible. There are some timestamps and UUIDs in it that change at
>> each build (diffoscope output attached).
>>
>> Could you take a look at that and see if there's a way to make it
>> reproducible?
>> Thanks.
>
> Hi Guillaume,
>
> Thank you for your report. I don't see anything in the pdfroff
> documentation
> about getting rid of this. I might use a program similar to this one
> to just overwrite the UUIDs and dates:
I've noticed that there are some dates in the document which
respond to SOURCE_DATE_EPOCH:
2 0 obj
<</Producer(GPL Ghostscript 9.26)
/CreationDate(D:20210717203740-07'00')
/ModDate(D:20210717203740-07'00')
/Creator(groff version 1.22.3)>>endobj
If I build with the SOURCE_DATE_EPOCH environment variable,
these dates from Ghostscript follow that variable.
That's why Guillaume isn't seeing an issue in that section
of the file.
Here is what I am going with:
commit 8fbf3f55446427c06248ce222a05fd09d77ac878 (HEAD -> master)
Author: Kaz Kylheku <kaz@kylheku.com>
Date: Sat Jul 17 19:11:20 2021 -0700
doc: reproducible PDF.
* Makefile (txr-manpage.pdf): If SOURCE_DATE_EPOCH exists,
then run pdf-clobber-stamps.tl.
* pdf-clobber-stamps.tl: New file.
diff --git a/Makefile b/Makefile
index 0094985f..cac9b3c0 100644
--- a/Makefile
+++ b/Makefile
@@ -560,6 +560,7 @@ txr-manpage.html: txr.1 genman.txr
txr-manpage.pdf: txr.1 checkman.txr
$(TXR) checkman.txr $<
tbl $< | pdfroff -ww -man --no-toc - > $@
+ [ $$SOURCE_DATE_EPOCH ] && $(TXR) pdf-clobber-stamps.tl || true
#
# Special targets used by ./configure
diff --git a/pdf-clobber-stamps.tl b/pdf-clobber-stamps.tl
new file mode 100644
index 00000000..0e56a44d
--- /dev/null
+++ b/pdf-clobber-stamps.tl
@@ -0,0 +1,19 @@
+(let* ((epoch (or (tointz (getenv "SOURCE_DATE_EPOCH")) 0))
+ (isotime (time-string-utc epoch "%FT%T+00:00"))
+ (pdf (file-get-string "txr-manpage.pdf"))
+ (start (search-str pdf "<?xpacket begin="))
+ (end (if start (search-str pdf "<?xpacket end" start)))
+ (xml (if end [pdf start..end]))
+ (orig-len (len xml)))
+ (unless xml
+ (format *stderr* "XML block not found in PDF")
+ (exit nil))
+ (upd xml
+ (regsub #/uuid:........-....-....-....-............/
+ "uuid:00000000-0000-0000-0000-000000000000")
+ (regsub #/Date>....-..-..T..:..:..-..:../
+ `Date>@isotime`))
+ (assert (eql (len xml) orig-len))
+ (set [pdf start..end] xml)
+ (file-put-string "txr-manpage.pdf.temp" pdf)
+ (rename-path "txr-manpage.pdf.temp" "txr-manpage.pdf"))
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-18 3:43 ` Kaz Kylheku
@ 2021-07-18 10:36 ` Guillaume Le Vaillant
2021-07-18 12:59 ` Paul A. Patience
` (2 more replies)
0 siblings, 3 replies; 15+ messages in thread
From: Guillaume Le Vaillant @ 2021-07-18 10:36 UTC (permalink / raw)
To: Kaz Kylheku; +Cc: Paul A. Patience, 49517
[-- Attachment #1: Type: text/plain, Size: 2791 bytes --]
Kaz Kylheku <kaz@kylheku.com> skribis:
> On 2021-07-17 15:51, Kaz Kylheku wrote:
>> On 2021-07-17 02:57, Guillaume Le Vaillant wrote:
>>> Hi,
>>> When testing the patch to build the HTML and PDF documentation,
>>> I noticed that the 'share/doc/txr-263/txr-manpage.pdf' file is not
>>> reproducible. There are some timestamps and UUIDs in it that change at
>>> each build (diffoscope output attached).
>>> Could you take a look at that and see if there's a way to make it
>>> reproducible?
>>> Thanks.
>> Hi Guillaume,
>> Thank you for your report. I don't see anything in the pdfroff
>> documentation
>> about getting rid of this. I might use a program similar to this one
>> to just overwrite the UUIDs and dates:
>
> I've noticed that there are some dates in the document which
> respond to SOURCE_DATE_EPOCH:
>
> 2 0 obj
> <</Producer(GPL Ghostscript 9.26)
> /CreationDate(D:20210717203740-07'00')
> /ModDate(D:20210717203740-07'00')
> /Creator(groff version 1.22.3)>>endobj
>
> If I build with the SOURCE_DATE_EPOCH environment variable,
> these dates from Ghostscript follow that variable.
> That's why Guillaume isn't seeing an issue in that section
> of the file.
Hi Kaz,
I tried your patch and it doesn't fix all the timestamps in the
environment used to build Guix packages:
- Timestamps have the "YYYY-MM-DDTHH:MM:SSZ" format instead of
"YYYY-MM-DDTHH:MM:SS+00:00"
- There are two "...Date(D:YYYYMMDDHHMMSSZ..." timestamps after the XML
block, although SOURCE_DATE_EPOCH is set to 1 in the environment
With the following modified 'pdf-clobber-stamps.tl' the document becomes
reproducible with Guix (but probably not in some other environments,
depending on the timezone format):
--8<---------------cut here---------------start------------->8---
(let* ((epoch (or (tointz (getenv "SOURCE_DATE_EPOCH")) 0))
(isotime (time-string-utc epoch "%FT%TZ"))
(pdf (file-get-string "txr-manpage.pdf"))
(start (search-str pdf "<?xpacket begin="))
(end (if start (search-str pdf "<?xpacket end" start)))
(xml (if end [pdf start..end]))
(orig-len (len xml)))
(unless xml
(format *stderr* "XML block not found in PDF")
(exit nil))
(upd xml
(regsub #/uuid:........-....-....-....-............/
"uuid:00000000-0000-0000-0000-000000000000")
(regsub #/Date>....-..-..T..:..:..Z/
`Date>@isotime`))
(assert (eql (len xml) orig-len))
(set [pdf start..end] xml)
(upd pdf
(regsub #/Date\(D:..............Z/
"Date(D:19700101000001Z"))
(file-put-string "txr-manpage.pdf.temp" pdf)
(rename-path "txr-manpage.pdf.temp" "txr-manpage.pdf"))
--8<---------------cut here---------------end--------------->8---
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 247 bytes --]
^ permalink raw reply [flat|nested] 15+ messages in thread
* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-18 10:36 ` Guillaume Le Vaillant
@ 2021-07-18 12:59 ` Paul A. Patience
2021-07-20 9:07 ` bug#49517: " Guillaume Le Vaillant
2021-07-18 20:27 ` [bug#49517] " Kaz Kylheku
2021-07-19 3:23 ` Kaz Kylheku
2 siblings, 1 reply; 15+ messages in thread
From: Paul A. Patience @ 2021-07-18 12:59 UTC (permalink / raw)
To: Guillaume Le Vaillant; +Cc: Kaz Kylheku, 49517
[-- Attachment #1: Type: text/plain, Size: 3413 bytes --]
Hi Guillaume,
On Sunday, July 18th, 2021 at 06:36, Guillaume Le Vaillant <glv@posteo.net> wrote:
> Hi Kaz,
>
> I tried your patch and it doesn't fix all the timestamps in the
> environment used to build Guix packages:
I had sent an email last night but accidentally only to Kaz. Here it is below:
On Saturday, July 17th, 2021 at 18:51, Kaz Kylheku <kaz@kylheku.com> wrote:
> On 2021-07-17 02:57, Guillaume Le Vaillant wrote:
>> When testing the patch to build the HTML and PDF documentation,
>> I noticed that the 'share/doc/txr-263/txr-manpage.pdf' file is not
>> reproducible. There are some timestamps and UUIDs in it that change at
>> each build (diffoscope output attached).
I've updated the first patch to fix this by setting GS_GENERATE_UUIDS
to 0, which seems to be the standard Guix way to patch groff's use of
Ghostscript.
It removes most of the date (i.e., the hours, minutes and seconds) and
the UUID, but leaves the year, month and day:
$ xxd /gnu/store/h94iilsa2xsp2ymn3k9x3ckmvfjha731-txr-266/share/doc/txr-266/txr-manpage.pdf | grep -C 1 Date
00231430: 702f 312e 302f 273e 3c78 6d70 3a4d 6f64 p/1.0/'><xmp:Mod
00231440: 6966 7944 6174 653e 3230 3231 2d30 372d ifyDate>2021-07-
00231450: 3138 3c2f 786d 703a 4d6f 6469 6679 4461 18</xmp:ModifyDa
--
00231470: 6174 653e 3230 3231 2d30 372d 3138 3c2f ate>2021-07-18</
00231480: 786d 703a 4372 6561 7465 4461 7465 3e0a xmp:CreateDate>.
00231490: 3c78 6d70 3a43 7265 6174 6f72 546f 6f6c <xmp:CreatorTool
Is this acceptable?
Otherwise we may have to resort to a variation of the method Kaz
mentioned, though it's probably better to fix the Ghostscript patches
implementing GS_GENERATE_UUIDS, because otherwise any package relying on
groff to make PDFs will suffer from this very problem.
> Thank you for your report. I don't see anything in the pdfroff
> documentation about getting rid of this.
The problem is in fact with Ghostscript [1].
Ghostscript is the program adding the metadata.
> 2. Is there some recommended practice with regard to some
> ./configure option or environment/make variable to react to
> for ensuring reproducible builds? So that is to say, suppose
> I don't wish to do the above embedded XML cleaning, except
> when building for a distro that strives for reproducibility.
>
> For opting in to reproducibilty, should I again rely on
> SOURCE_DATE_EPOCH and have the build react to it?
I think the goal of SOURCE_DATE_EPOCH is for projects such as TXR to
need do nothing, and rather have Guix arrange for the "builder"
applications (i.e., Ghostscript here) to produce reproducible outputs.
In this case with GS_GENERATE_UUIDS=0.
So I don't think TXR need change anything.
Since I had to make a change in one of the patches, I have added a third
patch (squeezed in between the other two) adjusting the installation of
the license files.
The three patches are attached.
(Kaz, if there's anything TXR should change, perhaps it is the target
directory of the license files, i.e., $(datadir) -> $(docdir).
I think it's more common in general to install license files into
/usr/share/doc/APP rather than /usr/share/APP -- at least, that's where
Guix installs them.
This would render the second attached patch unnecessary.)
Best regards,
Paul
[1]: https://bugs.ghostscript.com/show_bug.cgi?id=696765
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-gnu-txr-Build-documentation.patch --]
[-- Type: text/x-patch; name=0001-gnu-txr-Build-documentation.patch, Size: 7049 bytes --]
From 693c520e8cc15fb3a3e2e85d561bbed9d2277841 Mon Sep 17 00:00:00 2001
From: "Paul A. Patience" <paul@apatience.com>
Date: Sat, 10 Jul 2021 20:23:49 -0400
Subject: [PATCH 1/3] gnu: txr: Build documentation.
* gnu/packages/lisp.scm (man-for-txr): New variable.
(txr)[native-inputs]: New field.
[inputs]: Move above the arguments field.
[arguments]<#:phases>{inhibit-doc-syms-generation, build-doc}
{install-doc}: New phases.
{fix-tests}: Add after the unpack phase rather than after the configure
phase so that all file-modifying phases are performed after unpacking.
---
gnu/packages/lisp.scm | 96 ++++++++++++++++++++++++++++++++++++++++---
1 file changed, 90 insertions(+), 6 deletions(-)
diff --git a/gnu/packages/lisp.scm b/gnu/packages/lisp.scm
index 382f48beb1..7625c57b60 100644
--- a/gnu/packages/lisp.scm
+++ b/gnu/packages/lisp.scm
@@ -18,6 +18,7 @@
;;; Copyright © 2020 Marius Bakke <mbakke@fastmail.com>
;;; Copyright © 2020 Zhu Zihao <all_but_last@163.com>
;;; Copyright © 2021 Sharlatan Hellseher <sharlatanus@gmail.com>
+;;; Copyright © 2021 Paul A. Patience <paul@apatience.com>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -59,8 +60,10 @@
#:use-module (gnu packages fontutils)
#:use-module (gnu packages gcc)
#:use-module (gnu packages gettext)
+ #:use-module (gnu packages ghostscript)
#:use-module (gnu packages gl)
#:use-module (gnu packages glib)
+ #:use-module (gnu packages groff)
#:use-module (gnu packages m4)
#:use-module (gnu packages maths)
#:use-module (gnu packages multiprecision)
@@ -846,6 +849,60 @@ enough to play the original mainframe Zork all the way through.")
(home-page "http://www.russotto.net/git/mrussotto/confusion/src/master/src/README")
(license license:gpl3+))))
+(define man-for-txr
+ (let ((commit "dfbf19b9a96474b8c1bacac85e43605e5691ceb2")
+ ;; Number of additional commits since the last tag (see the output of
+ ;; "git describe --tags").
+ (revision "41"))
+ (package
+ (name "man-for-txr")
+ (version (git-version "1.6g" revision commit))
+ (source
+ (origin
+ (method git-fetch)
+ (uri (git-reference
+ (url "http://www.kylheku.com/git/man/")
+ (commit commit)))
+ (file-name (git-file-name name version))
+ (sha256
+ (base32 "1zy0g8fj9nsfwzvg88hyaiy94r8j14xhs8vy2ln2niqdm6x2lvy2"))))
+ (build-system gnu-build-system)
+ (arguments
+ `(#:tests? #f ; There are no tests.
+ #:phases
+ (modify-phases %standard-phases
+ (add-after 'unpack 'fix-man2html-makefile
+ (lambda _
+ (substitute* "man2html/Makefile.in"
+ ;; It inadvertently ignores @bindir@.
+ (("^(bindir = \\$\\(DESTDIR\\)\\$\\(PREFIX\\)).*" _ prefix)
+ (string-append prefix "@bindir@\n")))
+ #t))
+ (add-after 'unpack 'delete-generated-files
+ (lambda _
+ (for-each delete-file
+ (append
+ (list "conf_script")
+ (map (lambda (d) (string-append d "/Makefile"))
+ '("." "man" "man2html" "src"))
+ (map (lambda (f) (string-append "src/" f))
+ '("makewhatis.in" "man.conf"
+ "paths.h" "version.h"))))
+ #t))
+ (replace 'configure
+ (lambda* (#:key outputs #:allow-other-keys)
+ (setenv "CC" ,(cc-for-target))
+ ;; Humor the manually written configure script.
+ (invoke "./configure" "+lang" "en" "+fhs"
+ (string-append "-prefix=" (assoc-ref outputs "out")))
+ #t)))))
+ (home-page "http://www.kylheku.com/cgit/man/")
+ (synopsis "Modifications to the man utilities, specifically man2html")
+ (description
+ "This is a fork of the man utilities intended specifically for building
+the HTML documentation of TXR.")
+ (license license:gpl2))))
+
(define-public txr
(package
(name "txr")
@@ -860,6 +917,13 @@ enough to play the original mainframe Zork all the way through.")
(sha256
(base32 "14zaziymnbr2ld79x4h7sf88bzzzj82w3xpavmcx7mhwannb2swh"))))
(build-system gnu-build-system)
+ (native-inputs
+ ;; Required to build the documentation.
+ `(("ghostscript" ,ghostscript)
+ ("groff" ,groff)
+ ("man2html" ,man-for-txr)))
+ (inputs
+ `(("libffi" ,libffi)))
(arguments
`(#:configure-flags
(list ,(string-append "cc=" (cc-for-target))
@@ -867,6 +931,22 @@ enough to play the original mainframe Zork all the way through.")
#:test-target "tests"
#:phases
(modify-phases %standard-phases
+ (add-after 'unpack 'inhibit-doc-syms-generation
+ (lambda _
+ (substitute* "genman.txr"
+ ;; Exit from genman.txr before it tries to write to
+ ;; stdlib/doc-syms.tl, which is anyway kept up to date with
+ ;; each release (and is already compiled to stdlib/doc-syms.tlo
+ ;; when genman.txr is run).
+ (("^@\\(output \"share/txr/stdlib/doc-syms\\.tl\"\\).*" line)
+ (string-append "@(do (exit))\n" line)))
+ #t))
+ (add-after 'unpack 'fix-tests
+ (lambda _
+ (substitute* (list "tests/017/realpath.tl"
+ "tests/017/realpath.expected")
+ (("/usr/bin") "/"))
+ #t))
(replace 'configure
;; ./configure is a hand-written script that can't handle standard
;; autotools arguments like CONFIG_SHELL.
@@ -874,14 +954,18 @@ enough to play the original mainframe Zork all the way through.")
(setenv "txr_shell" (which "bash"))
(apply invoke "./configure" configure-flags)
#t))
- (add-after 'configure 'fix-tests
+ (add-after 'build 'build-doc
(lambda _
- (substitute* (list "tests/017/realpath.tl"
- "tests/017/realpath.expected")
- (("/usr/bin") "/"))
+ (setenv "GS_GENERATE_UUIDS" "0")
+ (invoke "make" "txr-manpage.html" "txr-manpage.pdf")
+ #t))
+ (add-after 'install 'install-doc
+ (lambda* (#:key outputs #:allow-other-keys)
+ (let ((doc (string-append (assoc-ref outputs "out")
+ "/share/doc/" ,name "-" ,version)))
+ (for-each (lambda (f) (install-file f doc))
+ '("txr-manpage.html" "txr-manpage.pdf")))
#t)))))
- (inputs
- `(("libffi" ,libffi)))
(synopsis "General-purpose, multi-paradigm programming language")
(description
"TXR is a general-purpose, multi-paradigm programming language. It
--
2.32.0
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0002-gnu-txr-Fix-license-installation.patch --]
[-- Type: text/x-patch; name=0002-gnu-txr-Fix-license-installation.patch, Size: 1702 bytes --]
From e19c5b58ec8cd829f3f2bfb900f079fa801fda31 Mon Sep 17 00:00:00 2001
From: "Paul A. Patience" <paul@apatience.com>
Date: Sat, 17 Jul 2021 23:19:31 -0400
Subject: [PATCH 2/3] gnu: txr: Fix license installation.
The install-license-files phase was installing LICENSE-CYG when it
shouldn't have, because that license applies only to TXR builds for
Microsoft Windows; and it was also ignoring the METALICENSE file.
However, TXR's Makefile was already installing the LICENSE and
METALICENSE files into share/txr (the datadir), so redirect them into
the appropriate doc directory and delete the install-license-files
phase.
* gnu/packages/lisp.scm (txr)[arguments]<#:phases>
{fix-license-installation}: New phase.
{install-license-files}: Delete phase.
---
gnu/packages/lisp.scm | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/gnu/packages/lisp.scm b/gnu/packages/lisp.scm
index 7625c57b60..6a1cc4dcfd 100644
--- a/gnu/packages/lisp.scm
+++ b/gnu/packages/lisp.scm
@@ -931,6 +931,15 @@ the HTML documentation of TXR.")
#:test-target "tests"
#:phases
(modify-phases %standard-phases
+ (add-after 'unpack 'fix-license-installation
+ (lambda* (#:key outputs #:allow-other-keys)
+ (substitute* "Makefile"
+ (("INSTALL(,.*LICENSE,.*)\\$\\(datadir\\)" _ match)
+ (string-append "INSTALL" match
+ (assoc-ref outputs "out")
+ "/share/doc/" ,name "-" ,version)))
+ #t))
+ (delete 'install-license-files)
(add-after 'unpack 'inhibit-doc-syms-generation
(lambda _
(substitute* "genman.txr"
--
2.32.0
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #4: 0003-gnu-txr-Update-to-266.patch --]
[-- Type: text/x-patch; name=0003-gnu-txr-Update-to-266.patch, Size: 3033 bytes --]
From dfd4147f5992b561ac1a72bbc32c738724c855f9 Mon Sep 17 00:00:00 2001
From: "Paul A. Patience" <paul@apatience.com>
Date: Tue, 13 Jul 2021 19:38:12 -0400
Subject: [PATCH 3/3] gnu: txr: Update to 266.
* gnu/packages/lisp.scm (txr)[version]: Update to 266.
[arguments]<#:phases>{inhibit-doc-syms-generation}: Correct the path to
doc-syms.tl to its new location.
{fix-tests}: Fix another test.
{disable-failing-tests}: New phase.
---
gnu/packages/lisp.scm | 22 +++++++++++++++++++---
1 file changed, 19 insertions(+), 3 deletions(-)
diff --git a/gnu/packages/lisp.scm b/gnu/packages/lisp.scm
index 6a1cc4dcfd..6ec59f5231 100644
--- a/gnu/packages/lisp.scm
+++ b/gnu/packages/lisp.scm
@@ -906,7 +906,7 @@ the HTML documentation of TXR.")
(define-public txr
(package
(name "txr")
- (version "263")
+ (version "266")
(source
(origin
(method git-fetch)
@@ -915,7 +915,7 @@ the HTML documentation of TXR.")
(commit (string-append "txr-" version))))
(file-name (git-file-name name version))
(sha256
- (base32 "14zaziymnbr2ld79x4h7sf88bzzzj82w3xpavmcx7mhwannb2swh"))))
+ (base32 "1k9mj3zaxdsylgnb8g6cq0cmp6420x7fp3nnsqdmds4gh8ib95wn"))))
(build-system gnu-build-system)
(native-inputs
;; Required to build the documentation.
@@ -947,7 +947,7 @@ the HTML documentation of TXR.")
;; stdlib/doc-syms.tl, which is anyway kept up to date with
;; each release (and is already compiled to stdlib/doc-syms.tlo
;; when genman.txr is run).
- (("^@\\(output \"share/txr/stdlib/doc-syms\\.tl\"\\).*" line)
+ (("^@\\(output \"stdlib/doc-syms\\.tl\"\\).*" line)
(string-append "@(do (exit))\n" line)))
#t))
(add-after 'unpack 'fix-tests
@@ -955,6 +955,22 @@ the HTML documentation of TXR.")
(substitute* (list "tests/017/realpath.tl"
"tests/017/realpath.expected")
(("/usr/bin") "/"))
+ (substitute* "tests/018/path-test.tl"
+ (("/bin") (dirname (which "sh"))))
+ #t))
+ (add-after 'unpack 'disable-failing-tests
+ (lambda _
+ (for-each delete-file
+ ;; These tests fail because they call external commands
+ ;; (like ls and cat) that don't run because the forked
+ ;; child processes' execvp calls cannot find the
+ ;; hardcoded /bin/sh.
+ ;; (The tests pass when run manually in the directory
+ ;; left by --keep-failed.)
+ (map (lambda (f) (string-append "tests/" f))
+ '("002/query-1.txr"
+ "010/json.tl"
+ "018/process.tl")))
#t))
(replace 'configure
;; ./configure is a hand-written script that can't handle standard
--
2.32.0
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-18 10:36 ` Guillaume Le Vaillant
2021-07-18 12:59 ` Paul A. Patience
@ 2021-07-18 20:27 ` Kaz Kylheku
2021-07-18 21:28 ` Paul A. Patience
2021-07-19 3:23 ` Kaz Kylheku
2 siblings, 1 reply; 15+ messages in thread
From: Kaz Kylheku @ 2021-07-18 20:27 UTC (permalink / raw)
To: Guillaume Le Vaillant; +Cc: Paul A. Patience, 49517
On 2021-07-18 03:36, Guillaume Le Vaillant wrote:
> Hi Kaz,
>
> I tried your patch and it doesn't fix all the timestamps in the
> environment used to build Guix packages:
> - Timestamps have the "YYYY-MM-DDTHH:MM:SSZ" format instead of
> "YYYY-MM-DDTHH:MM:SS+00:00"
> - There are two "...Date(D:YYYYMMDDHHMMSSZ..." timestamps after the
> XML
> block, although SOURCE_DATE_EPOCH is set to 1 in the environment
These are precisely the entries I was referring to in my other post.
In the Ubuntu environment, these are following SOURCE_DATE_EPOCH.
In fact, all the dates follow SOURCE_DATE_EPOCH. Even with my
hack commented out, if we do this:
$ SOURCE_DATE_EPOCH=0 make txr-manpage.pdf
./txr checkman.txr txr.1
tbl txr.1 | pdfroff -ww -man --no-toc - > txr-manpage.pdf
./pdfroff-eCdDwXuD8U/pdf29977.cmp:1: warning: macro `pdfhref' not
defined
txr.1:36: warning: number register `M2' not defined
# [ $SOURCE_DATE_EPOCH ] && ./txr pdf-clobber-stamps.tl || true
the resulting dates are all set to 1970-01-01:
$ strings txr-manpage.pdf | grep -E 'Mod|Crea'
<rdf:Description rdf:about='uuid:9f558000-55ee-11bd-0000-096f2d10ec33'
xmlns:xmp='http://ns.adobe.com/xap/1.0/'><xmp:ModifyDate>1970-01-01T00:00:00Z</xmp:ModifyDate>
<xmp:CreateDate>1970-01-01T00:00:00Z</xmp:CreateDate>
<xmp:CreatorTool>groff version
1.22.3</xmp:CreatorTool></rdf:Description>
/CreationDate(D:19700101000000Z00'00')
/ModDate(D:19700101000000Z00'00')
/Creator(groff version 1.22.3)>>endobj
Moreover, the uuid: strings are not changing between repetitions.
Either Ubuntu has a different upstream for these tools, or else they
have
some patches (which would be worth stealing instead of repeating the
work).
Moreover, if Ubuntu has patches for this, it might be getting them from
Debian.
> With the following modified 'pdf-clobber-stamps.tl' the document
> becomes
> reproducible with Guix (but probably not in some other environments,
> depending on the timezone format):
This is interesting, not to mention an annoying variation. I wonder
where this timezone format is coming from? It doesn't seem to be any
local variable under LC_TIME.
It's also weird how the timezone is expressed with a colon in the
Ubuntu build, as -07:00. I don't see anything in strftime for that,
looking at the latest Glibc documentation online.
In the Ghostscript code it seems that the latter dates: /CreationDate
and all, are the source of the values put into the XML.
The /CreationDate is being printed using a gs_sprintf call. Here is
the link to the Debian repo, inside a function called
pdf_image_finish_file:
https://sources.debian.org/src/ghostscript/9.53.3%7Edfsg-7/devices/gdevpdfimg.c/?hl=670#L753
gs_sprintf(CreationDate,
"(D:%04d%02d%02d%02d%02d%02d%c%02d\'%02d\')",
tms.tm_year + 1900, tms.tm_mon + 1, tms.tm_mday,
tms.tm_hour, tms.tm_min, tms.tm_sec,
timesign, timeoffset / 60, timeoffset % 60);
I found the code which converst the date with the colon in the timezone,
the function pdf_xmp_convert_time:
https://sources.debian.org/src/ghostscript/9.53.3%7Edfsg-7/devices/vector/gdevpdfe.c/#L222
It looks the same as in the ArtifexSoftware ghostpd upstream. It is
ad-hoc
code not using strftime, which puts in the colon.
This behavior is conditional depending on the input, though.
There is a case in which it puts in a Z and terminates, resulting
(I am guessing) in the format seen on Guix:
dt[19] = buf[14]; /* designator */
if (dt[19] == 'Z')
return 20;
The pdf_image_finish_function writes a Z if it is compiled with #ifdef
CLUSTER.
This CLUSTER compile-time switch has to do with some "cluster testing"
that
requires reproducible files.
It will also write a Z if it finds that the time offset is zero:
#ifdef CLUSTER
memset(&t, 0, sizeof(t));
memset(&tms, 0, sizeof(tms));
timesign = 'Z';
timeoffset = 0;
#else
time(&t);
tms = *gmtime(&t);
tms.tm_isdst = -1;
timeoffset = (int)difftime(t, mktime(&tms)); /* tz+dst in
seconds */
timesign = (timeoffset == 0 ? 'Z' : timeoffset < 0 ? '-' : '+');
timeoffset = any_abs(timeoffset) / 60;
tms = *localtime(&t);
#endif
Aha, this may be what is going on in the Guix build: that the time
offset has
been set to zero and so the 'Z' character is written; then the
conversion function to the other date format writes a 'Z' and quits.
I don't see where this code reacts to SOURCE_DATE_EPOCH like I'm seeing
on Ubuntu; maybe I'm looking at the wrote branch of the Debian repo,
or it really is Ubuntu who did that?
In any case, if we end up needing any aspect of my hack, I think I can
make it
account for all the variations we can expect to see out of this code.
Cheers ...
^ permalink raw reply [flat|nested] 15+ messages in thread
* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-18 20:27 ` [bug#49517] " Kaz Kylheku
@ 2021-07-18 21:28 ` Paul A. Patience
2021-07-19 12:08 ` Guillaume Le Vaillant
0 siblings, 1 reply; 15+ messages in thread
From: Paul A. Patience @ 2021-07-18 21:28 UTC (permalink / raw)
To: Kaz Kylheku; +Cc: Guillaume Le Vaillant, 49517
On Sunday, July 18th, 2021 at 16:27, Kaz Kylheku <kaz@kylheku.com> wrote:
> Either Ubuntu has a different upstream for these tools, or else they
> have some patches (which would be worth stealing instead of repeating
> the work).
>
> Moreover, if Ubuntu has patches for this, it might be getting them from
> Debian.
I know Debian is making great efforts to obtain reproducible builds [1],
and in fact if you look at the first message of the bug report I
previously linked [2], they mention that they have been using some
custom patches to get Ghostscript to produce reproducible output
(on Debian).
In fact, we can find some information about Debian's Ghostscript patch
here [3], though unfortunately the link to the patch is dead.
(There is also more information about reproducible builds here [4].)
Best regards,
Paul
[1]: https://isdebianreproducibleyet.com/
[2]: https://bugs.ghostscript.com/show_bug.cgi?id=696765
[3]: https://wiki.debian.org/ReproducibleBuilds/PdfGeneratedByGhostscript
[4]: https://wiki.debian.org/ReproducibleBuilds/Howto
^ permalink raw reply [flat|nested] 15+ messages in thread
* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-18 10:36 ` Guillaume Le Vaillant
2021-07-18 12:59 ` Paul A. Patience
2021-07-18 20:27 ` [bug#49517] " Kaz Kylheku
@ 2021-07-19 3:23 ` Kaz Kylheku
2 siblings, 0 replies; 15+ messages in thread
From: Kaz Kylheku @ 2021-07-19 3:23 UTC (permalink / raw)
To: Guillaume Le Vaillant; +Cc: Paul A. Patience, 49517
On 2021-07-18 03:36, Guillaume Le Vaillant wrote:
> Hi Kaz,
>
> I tried your patch and it doesn't fix all the timestamps in the
> environment used to build Guix packages:
OK,
I have a new patch which works for both the observed time
formats issued by Ghostscript, which I reproduced and tested.
Patch follows.
I extended the capture region to extract not only the XML
but that bit of PostScript with the dates which follows right
after it.
(I structured the script this way to avoid doing a regex search
and replace of the whole file, which is not only more time
consuming but risks more false positives than necessary.)
The replacement argument of regsub can be a function; the function
receives the original string and calculates its replacement.
So we can check for a trailing Z and act accordingly.
commit 920ae93cd768222db7387ee026f2d779d5e6de09 (HEAD -> master)
Author: Kaz Kylheku <kaz@kylheku.com>
Date: Sat Jul 17 19:11:20 2021 -0700
doc: reproducible PDF.
* Makefile (txr-manpage.pdf): If SOURCE_DATE_EPOCH exists,
then run pdf-clobber-stamps.tl.
* pdf-clobber-stamps.tl: New file.
diff --git a/Makefile b/Makefile
index 0094985f..cac9b3c0 100644
--- a/Makefile
+++ b/Makefile
@@ -560,6 +560,7 @@ txr-manpage.html: txr.1 genman.txr
txr-manpage.pdf: txr.1 checkman.txr
$(TXR) checkman.txr $<
tbl $< | pdfroff -ww -man --no-toc - > $@
+ [ $$SOURCE_DATE_EPOCH ] && $(TXR) pdf-clobber-stamps.tl || true
#
# Special targets used by ./configure
diff --git a/pdf-clobber-stamps.tl b/pdf-clobber-stamps.tl
new file mode 100644
index 00000000..78ea06c6
--- /dev/null
+++ b/pdf-clobber-stamps.tl
@@ -0,0 +1,22 @@
+(let* ((epoch (or (tointz (getenv "SOURCE_DATE_EPOCH")) 0))
+ (pdf (file-get-string "txr-manpage.pdf"))
+ (start (search-str pdf "<?xpacket begin="))
+ (end (if start (search-str pdf "/Creator(" start)))
+ (xml (if end [pdf start..end]))
+ (orig-len (len xml))
+ (isotime (time-string-utc epoch "%FT%T"))
+ (gstime (time-string-utc epoch "%Y%m%d%H%M%SZ0000")))
+ (unless xml
+ (format *stderr* "XML block not found in PDF")
+ (exit nil))
+ (upd xml
+ (regsub #/uuid:........-....-....-....-............/
+ "uuid:00000000-0000-0000-0000-000000000000")
+ (regsub #/Date>....-..-..T..:..:..(Z|[+\-]..:..)/
+ (ret `Date>@isotime@(if (ends-with "Z" @1) "Z" "+00:00")`))
+ (regsub #/Date\(D:..............[Z+\-]..../
+ `Date(D:@gstime`))
+ (assert (eql (len xml) orig-len))
+ (set [pdf start..end] xml)
+ (file-put-string "txr-manpage.pdf.temp" pdf)
+ (rename-path "txr-manpage.pdf.temp" "txr-manpage.pdf"))
^ permalink raw reply related [flat|nested] 15+ messages in thread
* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-18 21:28 ` Paul A. Patience
@ 2021-07-19 12:08 ` Guillaume Le Vaillant
2021-07-19 21:31 ` Kaz Kylheku
0 siblings, 1 reply; 15+ messages in thread
From: Guillaume Le Vaillant @ 2021-07-19 12:08 UTC (permalink / raw)
To: Paul A. Patience; +Cc: Kaz Kylheku, 49517
[-- Attachment #1: Type: text/plain, Size: 1825 bytes --]
Paul A. Patience <paul@apatience.com> skribis:
> On Sunday, July 18th, 2021 at 16:27, Kaz Kylheku <kaz@kylheku.com> wrote:
>> Either Ubuntu has a different upstream for these tools, or else they
>> have some patches (which would be worth stealing instead of repeating
>> the work).
>>
>> Moreover, if Ubuntu has patches for this, it might be getting them from
>> Debian.
>
> I know Debian is making great efforts to obtain reproducible builds [1],
> and in fact if you look at the first message of the bug report I
> previously linked [2], they mention that they have been using some
> custom patches to get Ghostscript to produce reproducible output
> (on Debian).
> In fact, we can find some information about Debian's Ghostscript patch
> here [3], though unfortunately the link to the patch is dead.
>
> (There is also more information about reproducible builds here [4].)
>
> Best regards,
> Paul
>
> [1]: https://isdebianreproducibleyet.com/
> [2]: https://bugs.ghostscript.com/show_bug.cgi?id=696765
> [3]: https://wiki.debian.org/ReproducibleBuilds/PdfGeneratedByGhostscript
> [4]: https://wiki.debian.org/ReproducibleBuilds/Howto
So Debian indeed has a patch adding the possibility to set the timestamp
based on SOURCE_DATE_EPOCH (see '2010_add_build_timestamp_setting.patch'
in [1] for example).
Guix also has a patch, but a different one based on GS_GENERATE_UUIDS.
However this patch is missing a part disabling two of the timestamps.
I proposed a patch to fix that (see [2]).
With this fix, 'pdf-clobber-stamps.tl' is not necessary anymore to build
the documentation reproducibly in Guix, but it might still be useful for
some other build environments.
[1] http://security.debian.org/debian-security/pool/updates/main/g/ghostscript/ghostscript_9.26a~dfsg-0+deb9u7.debian.tar.xz
[2] https://bugs.gnu.org/49640
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 247 bytes --]
^ permalink raw reply [flat|nested] 15+ messages in thread
* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-19 12:08 ` Guillaume Le Vaillant
@ 2021-07-19 21:31 ` Kaz Kylheku
2021-07-20 9:18 ` Guillaume Le Vaillant
0 siblings, 1 reply; 15+ messages in thread
From: Kaz Kylheku @ 2021-07-19 21:31 UTC (permalink / raw)
To: Guillaume Le Vaillant; +Cc: Paul A. Patience, 49517
On 2021-07-19 05:08, Guillaume Le Vaillant wrote:
> So Debian indeed has a patch adding the possibility to set the
> timestamp
> based on SOURCE_DATE_EPOCH (see
> '2010_add_build_timestamp_setting.patch'
> in [1] for example).
Looks like they rolled out this patch into production in 2015.
Is there a reason why Guix can't just steal the Debian patches
related to reproducibility? (Like underlying differences it the overall
approach which lead to incompatibilities?)
It would probably be best if distros did this the same way, so
there are no surprises.
GNU/Linux could set a precedent for other platforms, even.
If I'm building something on, say, Cygwin, OpenBSD or MacOS, if the
reproducbility stuff works the same way like on GNU/Linuxes, that's
great.
Here is a powerful argument why Just One Way of doing it is better:
Distros should not be carrying patches for this in the first place;
the programs themselves should be upstreaming the changes for
reproducibility.
If there is an agreed-upon /de facto/ (or /de jure/) standard way
of doing it, it is easier to persuade the individual program developers
to
accept the changes. They have a single target to hit which covers
all platforms.
In contrast, if reproducibility is an /ad hoc/ OS-and-distro-specific
matter, they are going to be understandably less motivated to upstream
the changes.
Nobody wants a situation in their source tree like:
patches/for-debian
/for-guix
/for-solaris
...
Just one implementation, committed into trunk, with with no #ifdefs.
^ permalink raw reply [flat|nested] 15+ messages in thread
* bug#49517: [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-18 12:59 ` Paul A. Patience
@ 2021-07-20 9:07 ` Guillaume Le Vaillant
0 siblings, 0 replies; 15+ messages in thread
From: Guillaume Le Vaillant @ 2021-07-20 9:07 UTC (permalink / raw)
To: Paul A. Patience; +Cc: Kaz Kylheku, 49517-done
[-- Attachment #1: Type: text/plain, Size: 1633 bytes --]
Paul A. Patience <paul@apatience.com> skribis:
> I've updated the first patch to fix this by setting GS_GENERATE_UUIDS
> to 0, which seems to be the standard Guix way to patch groff's use of
> Ghostscript.
> It removes most of the date (i.e., the hours, minutes and seconds) and
> the UUID, but leaves the year, month and day:
>
> $ xxd /gnu/store/h94iilsa2xsp2ymn3k9x3ckmvfjha731-txr-266/share/doc/txr-266/txr-manpage.pdf | grep -C 1 Date
> 00231430: 702f 312e 302f 273e 3c78 6d70 3a4d 6f64 p/1.0/'><xmp:Mod
> 00231440: 6966 7944 6174 653e 3230 3231 2d30 372d ifyDate>2021-07-
> 00231450: 3138 3c2f 786d 703a 4d6f 6469 6679 4461 18</xmp:ModifyDa
> --
> 00231470: 6174 653e 3230 3231 2d30 372d 3138 3c2f ate>2021-07-18</
> 00231480: 786d 703a 4372 6561 7465 4461 7465 3e0a xmp:CreateDate>.
> 00231490: 3c78 6d70 3a43 7265 6174 6f72 546f 6f6c <xmp:CreatorTool
>
> Is this acceptable?
> Otherwise we may have to resort to a variation of the method Kaz
> mentioned, though it's probably better to fix the Ghostscript patches
> implementing GS_GENERATE_UUIDS, because otherwise any package relying on
> groff to make PDFs will suffer from this very problem.
Hi Paul,
I pushed your patches as 75922458af60081bf6964006d5b9c180ff9ec8ca and
following with some modifications. I added a phase replacing the
hardcoded "/bin/sh" by the real path to bash in "/gnu/store/...", which
makes all the tests pass.
For now the PDF documentation still has the "ModifyDate" and
"CreateDate" fields. The fix for this is in the core-updates branch, so
when core-updates gets merged into master, the PDF should become
reproducible.
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 247 bytes --]
^ permalink raw reply [flat|nested] 15+ messages in thread
* [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265.
2021-07-19 21:31 ` Kaz Kylheku
@ 2021-07-20 9:18 ` Guillaume Le Vaillant
0 siblings, 0 replies; 15+ messages in thread
From: Guillaume Le Vaillant @ 2021-07-20 9:18 UTC (permalink / raw)
To: Kaz Kylheku; +Cc: Paul A. Patience, 49517
[-- Attachment #1: Type: text/plain, Size: 1907 bytes --]
Kaz Kylheku <kaz@kylheku.com> skribis:
> On 2021-07-19 05:08, Guillaume Le Vaillant wrote:
>> So Debian indeed has a patch adding the possibility to set the timestamp
>> based on SOURCE_DATE_EPOCH (see '2010_add_build_timestamp_setting.patch'
>> in [1] for example).
>
> Looks like they rolled out this patch into production in 2015.
>
> Is there a reason why Guix can't just steal the Debian patches
> related to reproducibility? (Like underlying differences it the overall
> approach which lead to incompatibilities?)
I don't think so, the developer who made the patch for Guix probably
just didn't know about Debian's patch.
> It would probably be best if distros did this the same way, so
> there are no surprises.
>
> GNU/Linux could set a precedent for other platforms, even.
> If I'm building something on, say, Cygwin, OpenBSD or MacOS, if the
> reproducbility stuff works the same way like on GNU/Linuxes, that's
> great.
>
> Here is a powerful argument why Just One Way of doing it is better:
>
> Distros should not be carrying patches for this in the first place;
> the programs themselves should be upstreaming the changes for
> reproducibility.
>
> If there is an agreed-upon /de facto/ (or /de jure/) standard way
> of doing it, it is easier to persuade the individual program developers to
> accept the changes. They have a single target to hit which covers
> all platforms.
>
> In contrast, if reproducibility is an /ad hoc/ OS-and-distro-specific
> matter, they are going to be understandably less motivated to upstream
> the changes.
>
> Nobody wants a situation in their source tree like:
>
> patches/for-debian
> /for-guix
> /for-solaris
> ...
>
> Just one implementation, committed into trunk, with with no #ifdefs.
In this case upstream explicitly refused merging the patches for
reproducibility (https://bugs.ghostscript.com/show_bug.cgi?id=698208).
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 247 bytes --]
^ permalink raw reply [flat|nested] 15+ messages in thread
end of thread, other threads:[~2021-07-20 9:19 UTC | newest]
Thread overview: 15+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-07-11 0:37 [bug#49517] [PATCH] gnu: txr: Build documentation and update to 265 Paul A. Patience
2021-07-12 1:01 ` Paul A. Patience
2021-07-13 23:45 ` Paul A. Patience
2021-07-17 9:57 ` Guillaume Le Vaillant
2021-07-17 22:51 ` Kaz Kylheku
2021-07-18 3:43 ` Kaz Kylheku
2021-07-18 10:36 ` Guillaume Le Vaillant
2021-07-18 12:59 ` Paul A. Patience
2021-07-20 9:07 ` bug#49517: " Guillaume Le Vaillant
2021-07-18 20:27 ` [bug#49517] " Kaz Kylheku
2021-07-18 21:28 ` Paul A. Patience
2021-07-19 12:08 ` Guillaume Le Vaillant
2021-07-19 21:31 ` Kaz Kylheku
2021-07-20 9:18 ` Guillaume Le Vaillant
2021-07-19 3:23 ` Kaz Kylheku
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).