Debian Bug report logs - #921513
sphinx: please make the build reproducible

version graph

Package: src:sphinx; Maintainer for src:sphinx is Debian Python Team <team+python@tracker.debian.org>;

Reported by: Chris Lamb <lamby@debian.org>

Date: Wed, 6 Feb 2019 12:00:02 UTC

Severity: wishlist

Tags: patch

Found in version sphinx/1.8.3-2

Fixed in version sphinx/1.8.4-1

Done: Dmitry Shachnev <mitya57@debian.org>

Bug is archived. No further changes may be made.

Forwarded to https://github.com/sphinx-doc/sphinx/pull/6028

Toggle useless messages

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to debian-bugs-dist@lists.debian.org, reproducible-bugs@lists.alioth.debian.org, Debian Python Modules Team <python-modules-team@lists.alioth.debian.org>:
Bug#921513; Package src:sphinx. (Wed, 06 Feb 2019 12:00:10 GMT) (full text, mbox, link).


Acknowledgement sent to Chris Lamb <lamby@debian.org>:
New Bug report received and forwarded. Copy sent to reproducible-bugs@lists.alioth.debian.org, Debian Python Modules Team <python-modules-team@lists.alioth.debian.org>. (Wed, 06 Feb 2019 12:00:10 GMT) (full text, mbox, link).


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

From: Chris Lamb <lamby@debian.org>
To: submit@bugs.debian.org
Subject: sphinx: please make the build reproducible
Date: Wed, 06 Feb 2019 12:57:40 +0100
[Message part 1 (text/plain, inline)]
Source: sphinx
Version: 1.8.3-2
Severity: wishlist
Tags: patch
User: reproducible-builds@lists.alioth.debian.org
Usertags: buildpath toolchain
X-Debbugs-Cc: reproducible-bugs@lists.alioth.debian.org

Hi,

Whilst working on the Reproducible Builds effort [0], we noticed
that sphinx could generate output that is not reproducible.

In particular, the graphviz extension module would construct
filenames based on, inter alia, the contents of the `options`
dictionary.

As this contained the absolute build path of the source file
embedded in the `docname` variable this meant that builds of
documentation were not independent of where on a filesystem they
were built from.

Example filenames might be:

  -  html/_images/graphviz-9e71e0f9ba91d0842b51211b676ec4adb7e7afb8.png
  +  html/_images/graphviz-6241bbfd7ac6bd4e2ad9af451ab0dfb8719988d2.png

We fix this by limiting how much of the `docname` variable ends up
in the final constructed filename; I assume there is a good reason
for including the `options` dictionary in the first place, otherwise
we could simply omit it.

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

(Patch attached.)


Regards,

-- 
      ,''`.
     : :'  :     Chris Lamb
     `. `'`      lamby@debian.org 🍥 chris-lamb.co.uk
       `-
[sphinx.diff.txt (text/plain, attachment)]

Information forwarded to debian-bugs-dist@lists.debian.org, Debian Python Modules Team <python-modules-team@lists.alioth.debian.org>:
Bug#921513; Package src:sphinx. (Wed, 06 Feb 2019 12:03:03 GMT) (full text, mbox, link).


Acknowledgement sent to Chris Lamb <lamby@debian.org>:
Extra info received and forwarded to list. Copy sent to Debian Python Modules Team <python-modules-team@lists.alioth.debian.org>. (Wed, 06 Feb 2019 12:03:03 GMT) (full text, mbox, link).


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

From: Chris Lamb <lamby@debian.org>
To: 921513@bugs.debian.org
Subject: Re: sphinx: please make the build reproducible
Date: Wed, 06 Feb 2019 13:01:43 +0100
forwarded 921513 https://github.com/sphinx-doc/sphinx/pull/6028
thanks

I've forwarded this upstream here:

  https://github.com/sphinx-doc/sphinx/pull/6028


Regards,

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



Set Bug forwarded-to-address to 'https://github.com/sphinx-doc/sphinx/pull/6028'. Request was from Chris Lamb <lamby@debian.org> to control@bugs.debian.org. (Wed, 06 Feb 2019 12:03:05 GMT) (full text, mbox, link).


Message sent on to Chris Lamb <lamby@debian.org>:
Bug#921513. (Sat, 16 Feb 2019 14:09:04 GMT) (full text, mbox, link).


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

From: Dmitry Shachnev <noreply@salsa.debian.org>
To: 921513-submitter@bugs.debian.org
Subject: Bug #921513 in sphinx marked as pending
Date: Sat, 16 Feb 2019 14:04:53 +0000
Control: tag -1 pending

Hello,

Bug #921513 in sphinx 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/modules/sphinx/commit/9b97a1f90ff0341248b327754802d739a4e99ca4

------------------------------------------------------------------------
Ensure the graphviz filenames are reproducible.

Closes: #921513.
------------------------------------------------------------------------

(this message was generated automatically)
-- 
Greetings

https://bugs.debian.org/921513



Added tag(s) pending. Request was from Dmitry Shachnev <noreply@salsa.debian.org> to 921513-submitter@bugs.debian.org. (Sat, 16 Feb 2019 14:09:04 GMT) (full text, mbox, link).


Reply sent to Dmitry Shachnev <mitya57@debian.org>:
You have taken responsibility. (Sun, 17 Feb 2019 05:54:03 GMT) (full text, mbox, link).


Notification sent to Chris Lamb <lamby@debian.org>:
Bug acknowledged by developer. (Sun, 17 Feb 2019 05:54:03 GMT) (full text, mbox, link).


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

From: Dmitry Shachnev <mitya57@debian.org>
To: 921513-close@bugs.debian.org
Subject: Bug#921513: fixed in sphinx 1.8.4-1
Date: Sun, 17 Feb 2019 05:51:18 +0000
Source: sphinx
Source-Version: 1.8.4-1

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

Debian distribution maintenance software
pp.
Dmitry Shachnev <mitya57@debian.org> (supplier of updated sphinx 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, 16 Feb 2019 16:55:01 +0300
Source: sphinx
Binary: python-sphinx python3-sphinx sphinx-common sphinx-doc libjs-sphinxdoc
Architecture: source
Version: 1.8.4-1
Distribution: unstable
Urgency: medium
Maintainer: Debian Python Modules Team <python-modules-team@lists.alioth.debian.org>
Changed-By: Dmitry Shachnev <mitya57@debian.org>
Description:
 libjs-sphinxdoc - JavaScript support for Sphinx documentation
 python-sphinx - documentation generator for Python projects (implemented in Pytho
 python3-sphinx - documentation generator for Python projects (implemented in Pytho
 sphinx-common - documentation generator for Python projects - common data
 sphinx-doc - documentation generator for Python projects - documentation
Closes: 921513
Changes:
 sphinx (1.8.4-1) unstable; urgency=medium
 .
   * New upstream release.
   * Ensure the graphviz filenames are reproducible (closes: #921513).
   * Bump year in debian/copyright.
Checksums-Sha1:
 27becb776ae4b9e4bda1a4edb6c4d49cf6b625a7 4016 sphinx_1.8.4-1.dsc
 ca77a4b3a63db251e1a14823d6095592cf05088d 5754841 sphinx_1.8.4.orig.tar.gz
 302ee958dadd02656fae4194a0d9ef4c26d958c9 833 sphinx_1.8.4.orig.tar.gz.asc
 5ede76984f145601adc5855f958d94cb44b5a526 36844 sphinx_1.8.4-1.debian.tar.xz
 1f3a4dbe8ca0c850bf9fcdb4300b336037a19128 5744 sphinx_1.8.4-1_source.buildinfo
Checksums-Sha256:
 c2990df91e387bdb4664d9baf1c9a3eb7d336eb53c4dc7e2d00ba6824f98c2f7 4016 sphinx_1.8.4-1.dsc
 c1c00fc4f6e8b101a0d037065043460dffc2d507257f2f11acaed71fd2b0c83c 5754841 sphinx_1.8.4.orig.tar.gz
 3b64557d12c432b806210f3f505b323c6b9fcf59f080cc50dbd99253b78dc931 833 sphinx_1.8.4.orig.tar.gz.asc
 1d4036ad0c056f9fe7a398f491d1c0f61a35963067032ad83d88df9b1ca64830 36844 sphinx_1.8.4-1.debian.tar.xz
 2f801c04173088d0c13f1a5f6ab9dbdc74ed60f422136c7e855657991cb482f3 5744 sphinx_1.8.4-1_source.buildinfo
Files:
 2143f27c29784cffe66137c938a5562a 4016 python optional sphinx_1.8.4-1.dsc
 8466f512322e81ef2f4da4d1ba61ff2f 5754841 python optional sphinx_1.8.4.orig.tar.gz
 8f47ab437e78980c142de4e602aee2b5 833 python optional sphinx_1.8.4.orig.tar.gz.asc
 78b5c0478e5734c31699ab55c1e0d4e1 36844 python optional sphinx_1.8.4-1.debian.tar.xz
 29212ea71021f05799724d74e5451daa 5744 python optional sphinx_1.8.4-1_source.buildinfo

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

iQJHBAEBCgAxFiEE8kKZ/xu8kBi5BqTLYCaTbS8ciuAFAlxob8cTHG1pdHlhNTdA
ZGViaWFuLm9yZwAKCRBgJpNtLxyK4H3FEACHg08Su17yaN7WhREVKAyarZFv5k4m
zCgpbgCxVcMkiaHBXGqCElMIZlX/Iu7ifyU+HLcRKjTz09z9NHMH25HkqlKVxdc+
7LjD+b01MYfiKPuMEbOede9xciENhb4s+H5OqwsJychkeHNMizZT8U0mEirrqcCt
LTPwoQFUAp5jtgP2iyu1ks3HHDw0EriYMzyAlOYIBT4FcRTOh1FTjJf0uTv6i5Kd
PcbP3S679zZkBo8VIISbROqkvthehx+bE9B5g0Bw7HHitHXscVXtPSM4cuXeHhzE
N6SjZk/av4gt8oRr41bVfyk9Oytqo9wybe8ZK4v+B35tTPRUREineliT7h/FvRF1
c1WXQ3Xr1E2e/OaOfCjrcYOaBcTWjl42IKFx09tmLI4j56Ry8XQcec+EAFPev850
6+4r6ZLc5a0HPOGDOeLmwGfQn6mlzj4akmnd/ZSD0Ns6Gw0H1qxw+RUxlEQVWNGY
Ao3jxuHP255EK/9dh9l+jruKEycciD0K2O3XLAuSBCwJEYNV0QwE6l5VibeU0HcI
1eLE8+m0YejOUdahzcCi9tjSVGAIaZwSw2DRp+6FBHhRiAH8cDNEMdK7BTKW4Vih
nNh0uJ+MCHgEXhKX/Oofnv+8BYJ6IJEB1f3eTzc/aERXQtUWZ/c+U1puxG6C493V
Eng4V0sdhySL2A==
=JvcV
-----END PGP SIGNATURE-----




Bug archived. Request was from Debbugs Internal Request <owner@bugs.debian.org> to internal_control@bugs.debian.org. (Wed, 27 Mar 2019 07:26:21 GMT) (full text, mbox, link).


Send a report that this bug log contains spam.


Debian bug tracking system administrator <owner@bugs.debian.org>. Last modified: Wed May 17 11:34:28 2023; Machine Name: buxtehude

Debian Bug tracking system

Debbugs is free software and licensed under the terms of the GNU Public License version 2. The current version can be obtained from https://bugs.debian.org/debbugs-source/.

Copyright © 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson, 2005-2017 Don Armstrong, and many other contributors.