Debian Bug report logs - #1010316
python-cai-doc: documentation contains error message instead of documentation

Toggle useless messages

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

From: "Chris Lamb" <lamby@debian.org>

To: submit@bugs.debian.org

Subject: python-cai-doc: documentation contains error message instead of documentation

Date: Thu, 28 Apr 2022 11:17:55 -0700

Package: python-cai-doc
Version: 1.0.2-2
Severity: minor
User: reproducible-builds@lists.alioth.debian.org
Usertags: buildpath
X-Debbugs-Cc: reproducible-bugs@lists.alioth.debian.org

Hi,

The cli.html documentation file contains the following:

  System Message: ERROR/6 (/build/python-cai-AL0f0J/python-cai-1.0.2/docs/cli.rst, line 4)

  Command ['CAI', '--help'] failed: [Errno 2] No such file or directory: 'CAI'

... instead of, presumably, the output of calling --help. This is
actually affecting reproducibility. I can't quite find the right
combination of setting PYTHONPATH and PATH to get this to work,
unfortunately...


Regards,

-- 
      ,''`.
     : :'  :     Chris Lamb
     `. `'`      lamby@debian.org / chris-lamb.co.uk
       `-

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

From: Vagrant Cascadian <vagrant@reproducible-builds.org>

To: Chris Lamb <lamby@debian.org>, 1010316@bugs.debian.org

Subject: Re: Bug#1010316: python-cai-doc: documentation contains error message instead of documentation

Date: Thu, 28 Apr 2022 16:16:47 -0700

[Message part 1 (text/plain, inline)]

Control: tags 1010316 +patch

On 2022-04-28, Chris Lamb wrote:
> The cli.html documentation file contains the following:
>
>   System Message: ERROR/6 (/build/python-cai-AL0f0J/python-cai-1.0.2/docs/cli.rst, line 4)
>
>   Command ['CAI', '--help'] failed: [Errno 2] No such file or directory: 'CAI'
>
> ... instead of, presumably, the output of calling --help. This is
> actually affecting reproducibility. I can't quite find the right
> combination of setting PYTHONPATH and PATH to get this to work,
> unfortunately...

By coincidence, I happened to be working on this about the same time,
and eventually figured out that "CAI" did not exist after dh_auto_build,
but noticed it did exist during the dh_installman phase, as it was used
with help2man to generate manpages.

Through a lot of trial and error, I eventually moved it just before
dh_installdocs and specified PATH and PYTHONPATH and it appears to
work. There may be a better place to put it, but this appears to
work. Patch attached!

I also had success with PYTHONPATH=$(CURDIR) instead of PYTHONPATH=.. if
that is somehow more ideal.


live well,
  vagrant

[0001-debian-rules-Move-documentation-building-phase-befor.patch (text/x-diff, inline)]

From 7a6e146bdf6472a17ffa8d82348f6633fc750171 Mon Sep 17 00:00:00 2001
From: Vagrant Cascadian <vagrant@reproducible-builds.org>
Date: Thu, 28 Apr 2022 23:03:04 +0000
Subject: [PATCH] debian/rules: Move documentation building phase before
 running dh_installdocs, and specify PATH and PYTHONPATH.

The "CAI" binary is not available after dh_auto_build, so run in the
dh_installdocs target instead.

Specify PYTHONPATH=.. as sphinx is run from the docs subdir.
---
 debian/rules | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/debian/rules b/debian/rules
index 93b614c..57ded76 100755
--- a/debian/rules
+++ b/debian/rules
@@ -10,15 +10,13 @@ export https_proxy = 127.0.0.1:9
 %:
 	dh $@ --buildsystem pybuild --with python3,sphinxdoc
 
-override_dh_auto_build:
-	dh_auto_build
-	PYTHONPATH=. python3 -m sphinx -N -bhtml docs build/html
-	find build/html -name .doctrees | xargs --no-run-if-empty rm -rf
-
 override_dh_auto_test:
 	dh_auto_test -- --test-pytest
 
 override_dh_installdocs:
+	PATH=$(CURDIR)/debian/python3-cai/usr/bin:$(PATH) PYTHONPATH=.. python3 -m sphinx -N -bhtml docs build/html
+	find build/html -name .doctrees | xargs --no-run-if-empty rm -rf
+
 	dh_installdocs
 	dh_installdocs -p python-cai-doc --doc-main-package python3-cai build/html
 
-- 
2.36.0

[signature.asc (application/pgp-signature, inline)]

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

From: Debian FTP Masters <ftpmaster@ftp-master.debian.org>

To: 1010316-close@bugs.debian.org

Subject: Bug#1010316: fixed in python-cai 1.0.2-3

Date: Sat, 30 Apr 2022 07:18:45 +0000

Source: python-cai
Source-Version: 1.0.2-3
Done: Andrius Merkys <merkys@debian.org>

We believe that the bug you reported is fixed in the latest version of
python-cai, 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 1010316@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Andrius Merkys <merkys@debian.org> (supplier of updated python-cai 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: SHA512

Format: 1.8
Date: Sat, 30 Apr 2022 02:46:08 -0400
Source: python-cai
Architecture: source
Version: 1.0.2-3
Distribution: unstable
Urgency: medium
Maintainer: Debian Python Team <team+python@tracker.debian.org>
Changed-By: Andrius Merkys <merkys@debian.org>
Closes: 1010316
Changes:
 python-cai (1.0.2-3) unstable; urgency=medium
 .
   * Fix documentation build (Closes: #1010316). Thanks Vagrant Cascadian.
   * Clean up debian/rules.
Checksums-Sha1:
 9d83b9f9486135f2ed07479d0f4e3f49bc79b26e 2331 python-cai_1.0.2-3.dsc
 5d86e770ff2ca5910c3d9782ce16ceb5eec0c480 3256 python-cai_1.0.2-3.debian.tar.xz
 8353dd59cac1289c8aaf747d462eb9897e7bf509 10388 python-cai_1.0.2-3_source.buildinfo
Checksums-Sha256:
 36fbd8620aa105e681907f02cc9d3198904bba6fedb5d51d9a9b6eddaf2c00e7 2331 python-cai_1.0.2-3.dsc
 69203f8847d4d3295a64d506184cb3250a9cff11c614835c4e10839051cc36f1 3256 python-cai_1.0.2-3.debian.tar.xz
 ef46c175d6f8cdb0f5d0d36504514bf930c95b1cec641fb83150efb7a2f971a1 10388 python-cai_1.0.2-3_source.buildinfo
Files:
 9e22c215e2892b3fb90dc6980cb5767c 2331 python optional python-cai_1.0.2-3.dsc
 c0fb0f13820240ba91d2d5d0515a65f0 3256 python optional python-cai_1.0.2-3.debian.tar.xz
 58be7505867af7d85225515753eb4c4a 10388 python optional python-cai_1.0.2-3_source.buildinfo

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

iQJGBAEBCgAwFiEEdyKS9veshfrgQdQe5fQ/nCc08ocFAmJs3XoSHG1lcmt5c0Bk
ZWJpYW4ub3JnAAoJEOX0P5wnNPKHLekQAIWz0B49i9aw0fTd7Gd8tkh+8t4CoD0h
0TBwoiYy21gfygsra6W1ny3x/FVobzMRvl9sGypnDF2sEpdWcoYCedk+lozDmt3g
oywLN1lsx2r9UGQm5xRHflPti+VzEjLZK1gwq15XK+2x7JA5sMySgw/kpkueVnFP
SA1EbdCSK1WYGRzOZrbWRbeJpaZbcPsX13QX+SBQ0dUKPOCnw/+qFz+XYouwaL/j
kZ9KAWiG/Lz5mJjOVitcY+JlRjpUEti4PvrUzkxuE4FrJxwkasRKgDjmOe+aYeRF
0wkNiWy32hrPIVg0fTv1ZoP6nQ9kv4h80aElOVN0t9y3N6cv7bU+e+qPcWt8nZiR
FI4U6MxzD2oOvqHOUSXc3Os7oBzp3LoT+mmSHhqGBWITGQIdo3jauIarE6Suise5
83S6repksnNhMp+7LAjUl+UzFkiuHkcT7b0dmzpKGKoSHVZnn5O+CuQAlHijNVav
tHjevIw5r01Xic+4ANPliHKuyYkckI3JrPU0mlAQMgp3DnV24TZL0dK/9wrPg0Xl
UT/vxRmcj/36h3zo5aBbKc7NoZMsFUOwWY4A1sKvj6hekVIQQPNI8Hsa5LqIWN3t
1ypXerEBXzIL6PL5h5R7PVojUbQjCPN9FWE4R5dAIugbuo+dz23rNI1GBt5bTwq/
bcT2edkZATcq
=/Ew3
-----END PGP SIGNATURE-----

Message #20 received at 1010316-submitter@bugs.debian.org (full text, mbox, reply):

From: Andrius Merkys <noreply@salsa.debian.org>

To: 1010316-submitter@bugs.debian.org

Subject: Bug#1010316 marked as pending in python-cai

Date: Sat, 30 Apr 2022 07:19:18 +0000

Control: tag -1 pending

Hello,

Bug #1010316 in python-cai reported by you has been fixed in the
Git repository and is awaiting an upload. You can see the commit
message below and you can check the diff of the fix at:

https://salsa.debian.org/python-team/packages/python-cai/-/commit/0e664c969928b84185a45a00828f595e2d422528

------------------------------------------------------------------------
Fix documentation build (Closes: #1010316). Thanks Vagrant Cascadian.
------------------------------------------------------------------------

(this message was generated automatically)
-- 
Greetings

https://bugs.debian.org/1010316

Send a report that this bug log contains spam.