Debian Bug report logs - #844232
daisy-player: man page title is wrong if build directory isn't named ${package}-${version}

Toggle useless messages

Message #5 received at submit@bugs.debian.org (full text, mbox, reply):

From: Daniel Shahaf <danielsh@apache.org>

To: Debian Bug Tracking System <submit@bugs.debian.org>

Subject: daisy-player: man page title is wrong if build directory isn't named ${package}-${version}

Date: Sun, 13 Nov 2016 16:22:29 +0000

Source: daisy-player
Version: 10.3-2
Severity: minor
Tags: upstream patch
User: reproducible-builds@lists.alioth.debian.org
Usertags: buildpath

Dear Maintainer,

Whilst working on the Reproducible Builds effort [0], we noticed
that daisy-player could not be built reproducibly, due to `txt2man -p`
parsing the last component of the build directory.

Patch attached.

 [0] https://reproducible-builds.org/

Cheers,

Daniel

P.S. The patch as written is upstreamable.  For Debian it might make
sense to use «$$(cd .. && dpkg-parsechangelog -SVersion)» so as to have
a more detailed version number.

[[[
diff --git a/debian/patches/build-path-agnostic.diff b/debian/patches/build-path-agnostic.diff
new file mode 100644
index 0000000..94c89c2
--- /dev/null
+++ b/debian/patches/build-path-agnostic.diff
@@ -0,0 +1,16 @@
+Description: Make the build reproducible
+  Avoid 'txt2man -p' because it parses the build path.
+Bug-Debian: https://bugs.debian.org/-1
+Last-Update: 2016-11-13
+
+--- daisy-player-10.3.orig/man/Makefile.am
++++ daisy-player-10.3/man/Makefile.am
+@@ -3,7 +3,7 @@ man_MANS = daisy-player.1
+ all: daisy-player
+ 
+ daisy-player:
+-	@which txt2man > /dev/null && txt2man -p ${srcdir}/../doc/$@.txt > ${srcdir}/$@.1
++	@which txt2man > /dev/null && txt2man -t $@ -s 1 -v "Linux Reference Manual" -r $(VERSION) ${srcdir}/../doc/$@.txt > ${srcdir}/$@.1
+ 	@file ${srcdir}/$@.1 && \
+ 	   man2html ${srcdir}/$@.1 | tail -n +3 > ${srcdir}/../doc/$@.html
+ 
diff --git a/debian/patches/series b/debian/patches/series
new file mode 100644
index 0000000..222072b
--- /dev/null
+++ b/debian/patches/series
@@ -0,0 +1 @@
+build-path-agnostic.diff
]]]

Message #12 received at submit@bugs.debian.org (full text, mbox, reply):

From: Jos Lemmens <jos@jlemmens.nl>

To: Daniel Shahaf <danielsh@apache.org>, 844232@bugs.debian.org, Debian Bug Tracking System <submit@bugs.debian.org>

Subject: Re: Bug#844232: daisy-player: man page title is wrong if build directory isn't named ${package}-${version}

Date: Mon, 14 Nov 2016 19:49:38 +0100

Is changed in the next release of daisy-player.

   Thanks.

On Sun, Nov 13, 2016 at 04:22:29PM +0000, Daniel Shahaf wrote:
> Source: daisy-player
> Version: 10.3-2
> Severity: minor
> Tags: upstream patch
> User: reproducible-builds@lists.alioth.debian.org
> Usertags: buildpath
> 
> Dear Maintainer,
> 
> Whilst working on the Reproducible Builds effort [0], we noticed
> that daisy-player could not be built reproducibly, due to `txt2man -p`
> parsing the last component of the build directory.
> 
> Patch attached.
> 
>  [0] https://reproducible-builds.org/
> 
> Cheers,
> 
> Daniel
> 
> P.S. The patch as written is upstreamable.  For Debian it might make
> sense to use «$$(cd .. && dpkg-parsechangelog -SVersion)» so as to have
> a more detailed version number.
> 
> [[[
> diff --git a/debian/patches/build-path-agnostic.diff b/debian/patches/build-path-agnostic.diff
> new file mode 100644
> index 0000000..94c89c2
> --- /dev/null
> +++ b/debian/patches/build-path-agnostic.diff
> @@ -0,0 +1,16 @@
> +Description: Make the build reproducible
> +  Avoid 'txt2man -p' because it parses the build path.
> +Bug-Debian: https://bugs.debian.org/-1
> +Last-Update: 2016-11-13
> +
> +--- daisy-player-10.3.orig/man/Makefile.am
> ++++ daisy-player-10.3/man/Makefile.am
> +@@ -3,7 +3,7 @@ man_MANS = daisy-player.1
> + all: daisy-player
> + 
> + daisy-player:
> +-	@which txt2man > /dev/null && txt2man -p ${srcdir}/../doc/$@.txt > ${srcdir}/$@.1
> ++	@which txt2man > /dev/null && txt2man -t $@ -s 1 -v "Linux Reference Manual" -r $(VERSION) ${srcdir}/../doc/$@.txt > ${srcdir}/$@.1
> + 	@file ${srcdir}/$@.1 && \
> + 	   man2html ${srcdir}/$@.1 | tail -n +3 > ${srcdir}/../doc/$@.html
> + 
> diff --git a/debian/patches/series b/debian/patches/series
> new file mode 100644
> index 0000000..222072b
> --- /dev/null
> +++ b/debian/patches/series
> @@ -0,0 +1 @@
> +build-path-agnostic.diff
> ]]]

-- 

   Sent from Ubuntu 16.10

   -------------------------------
   Jos Lemmens
   Insulindesingel 37/A
   3131 LM  Vlaardingen
   The Netherlands
   Tel.: + 31-(0)10-248 0 266
   E-mail: jos@jlemmens.nl
   Homepage: www.jlemmens.nl

Message #24 received at 844232@bugs.debian.org (full text, mbox, reply):

From: Paul Gevers <elbrus@debian.org>

To: Daniel Shahaf <danielsh@apache.org>

Cc: 844232@bugs.debian.org

Subject: Re: Bug#844232: daisy-player: man page title is wrong if build directory isn't named ${package}-${version}

Date: Tue, 15 Nov 2016 20:31:33 +0100

Hi Daniel,

On 13-11-16 17:22, Daniel Shahaf wrote:
> Whilst working on the Reproducible Builds effort [0], we noticed
> that daisy-player could not be built reproducibly, due to `txt2man -p`
> parsing the last component of the build directory.

While upstream (thanks Jos) already accepted your patch, I challenge 
your approach. While this CAN be fixed in each package that uses 
txt2man, shouldn't txt2man be fixed instead (I don't see why the parent 
directory should matter for the output)? At least, can you explain why 
you didn't go that route?

Paul

Message #29 received at 844232@bugs.debian.org (full text, mbox, reply):

From: Daniel Shahaf <danielsh@apache.org>

To: Paul Gevers <elbrus@debian.org>, 844232@bugs.debian.org

Subject: Re: Bug#844232: daisy-player: man page title is wrong if build directory isn't named ${package}-${version}

Date: Wed, 16 Nov 2016 00:08:55 +0000

Paul Gevers wrote on Tue, Nov 15, 2016 at 20:31:33 +0100:
> Hi Daniel,
> 
> On 13-11-16 17:22, Daniel Shahaf wrote:
> >Whilst working on the Reproducible Builds effort [0], we noticed
> >that daisy-player could not be built reproducibly, due to `txt2man -p`
> >parsing the last component of the build directory.
> 
> While upstream (thanks Jos) already accepted your patch, I challenge your
> approach. While this CAN be fixed in each package that uses txt2man,
> shouldn't txt2man be fixed instead (I don't see why the parent directory
> should matter for the output)? At least, can you explain why you didn't go
> that route?
> 

I assumed that txt2man's -p (probe) option's incumbent behaviour was
intentional and desirable behaviour in some use-cases.  Granted,
"building Debian packages" is not one of those use-cases, but we can't
change the behaviour of an upstream tool just because package builds
happen to use it.

Perhaps there's a way for txt2man to probe the package name and version
in another way, that works both for Debian package builds and for
upstream txt2man's other usecases.  I'm afraid I injured my hand
yesterday so I can't look into this possibility presently, but I can
look into it once my hand is better.

Thanks for your prompt response the the two bugs!

Cheers,

Daniel

> Paul
> 

Message #34 received at 844232-close@bugs.debian.org (full text, mbox, reply):

From: Paul Gevers <elbrus@debian.org>

To: 844232-close@bugs.debian.org

Subject: Bug#844232: fixed in daisy-player 10.3-3

Date: Sat, 10 Dec 2016 21:04:49 +0000

Source: daisy-player
Source-Version: 10.3-3

We believe that the bug you reported is fixed in the latest version of
daisy-player, which is due to be installed in the Debian FTP archive.

A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to 844232@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Paul Gevers <elbrus@debian.org> (supplier of updated daisy-player package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@ftp-master.debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Format: 1.8
Date: Sat, 10 Dec 2016 20:30:26 +0100
Source: daisy-player
Binary: daisy-player
Architecture: source
Version: 10.3-3
Distribution: unstable
Urgency: medium
Maintainer: Debian Accessibility Team <debian-accessibility@lists.debian.org>
Changed-By: Paul Gevers <elbrus@debian.org>
Description:
 daisy-player - player for DAISY Digital Talking Books
Closes: 844232
Changes:
 daisy-player (10.3-3) unstable; urgency=medium
 .
   * Prevent txt2man -p to pick up the build dir to enable reproducible
     builds. Will be fixed in next upstream release (Closes: #844232)
   * Bump compat level to 10
   * Convert Vcs-* URLs to https
   * Enable hardening
Checksums-Sha1:
 9f629cbc2e77a26d875025908dfa45b5966f112b 1758 daisy-player_10.3-3.dsc
 8bd21bc4ffe996b2a65b8245ab3595b63b954724 8716 daisy-player_10.3-3.debian.tar.xz
Checksums-Sha256:
 d4617786cf8ad44fe24a551f3c0ba2d2d05c4cf73c5f98fcb30c49d5e15ef202 1758 daisy-player_10.3-3.dsc
 3269e1069c11739b24d4ecc9a55ef67ad516dc569053b164ebe8dd1ae9a87e47 8716 daisy-player_10.3-3.debian.tar.xz
Files:
 6654fcb4097d5c95deb6d1279e038057 1758 sound optional daisy-player_10.3-3.dsc
 d8e19f7081549058eea59b354c91d823 8716 sound optional daisy-player_10.3-3.debian.tar.xz

-----BEGIN PGP SIGNATURE-----

iQEzBAEBCAAdFiEEWLZtSHNr6TsFLeZynFyZ6wW9dQoFAlhMXSQACgkQnFyZ6wW9
dQpSDwf+Ij6cOCdwQkE8TMO95jLJL4hZi1ANAof7elG7NJhSYeEMRgmTXj2bJcVw
IwEcmUmHU9zj7GH0D4U57Yg4Nkv42hQPtumwEKGCpu4fEWbPyGT0v1CdEd5eupkt
yA7nxS3lf4j/fOfrBIXhpAvjfLaFNbMb/3bDHr6cIWNEw3ybQ2O4yWdH1cdkv8Zq
A5rrSpOndguUJy2JX6PulROSZl2nxVtt4rvx8Wi+8osehWW8pfRCaPJIf4gcXSXu
EZCgavrMO4Xxs1B2G3O4hmm1qJ1gsqaX5YqL9VycbCjx8di8mJm9B+iMjBL7SQG+
ihWiby7jx0eYvNWHBe2qFlZ8yfYQww==
=NMUp
-----END PGP SIGNATURE-----

Send a report that this bug log contains spam.