Debian Bug report logs - #996948
sphinx: please make the output of instance aliases reproducible

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: sphinx: please make the output of instance aliases reproducible

Date: Thu, 21 Oct 2021 10:17:08 +0100

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

Source: sphinx
Version: 4.2.0-4
Severity: wishlist
Tags: patch
User: reproducible-builds@lists.alioth.debian.org
Usertags: randomness toolchain
X-Debbugs-Cc: reproducible-bugs@lists.alioth.debian.org

Hi,

Whilst working on the Reproducible Builds effort [0] we noticed that
sphinx generates output that is not reproducible, causing a number of
packages in Debian to be reproducible.

Specifically, when Sphinx locates an alias of an instance when
generating 'autodoc' documentation it uses the raw Python repr(...) of
the object and does not sanitise it for memory addresses (etc.) like
elsewhere in Sphinx.

This can result in documentation like this:

  -<dd><p>alias of &lt;webob.client.SendRequest object at 0x7fd769189df0&gt;</p>
  +<dd><p>alias of &lt;webob.client.SendRequest object at 0x7f0f02233df0&gt;</p>

Patch attached that uses the object_description method, which was
added to fix precisely this category of issue.


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


Regards,

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

[sphinx.diff.txt (text/plain, attachment)]

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

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

To: 996948@bugs.debian.org

Subject: Re: Bug#996948: sphinx: please make the output of instance aliases reproducible

Date: Thu, 21 Oct 2021 10:27:54 +0100

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

Chris Lamb wrote:

> Whilst working on the Reproducible Builds effort [0] we noticed that
> sphinx generates output that is not reproducible, causing a number of
> packages in Debian to be reproducible.
                        ^^^^^^^^^^^^^^^

This, of course, should read "be UN-reproducible".

> Patch attached that uses the object_description method, which was
> added to fix precisely this category of issue.

Updated patch attached.


Regards,

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

[sphinx.diff.txt (text/plain, attachment)]

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

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

To: 996948@bugs.debian.org

Subject: Re: sphinx: please make the output of instance aliases reproducible

Date: Thu, 21 Oct 2021 05:32:37 -0400 (EDT)

forwarded 996948 https://github.com/sphinx-doc/sphinx/pull/9755
thanks

I've forwarded this upstream here:

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


Regards,

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

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

From: Dmitry Shachnev <noreply@salsa.debian.org>

To: 996948-submitter@bugs.debian.org

Subject: Bug#996948 marked as pending in sphinx

Date: Sat, 23 Oct 2021 11:32:17 +0000

Control: tag -1 pending

Hello,

Bug #996948 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/packages/sphinx/-/commit/e9b35569f907ab74da882dad1e5bc51e3455d100

------------------------------------------------------------------------
Add a patch to make util.typing.restify sanitize unreproducible output.

Closes: #996948.
Thanks Chris Lamb!
------------------------------------------------------------------------

(this message was generated automatically)
-- 
Greetings

https://bugs.debian.org/996948

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

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

To: 996948-close@bugs.debian.org

Subject: Bug#996948: fixed in sphinx 4.2.0-5

Date: Sat, 23 Oct 2021 12:50:32 +0000

Source: sphinx
Source-Version: 4.2.0-5
Done: Dmitry Shachnev <mitya57@debian.org>

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 996948@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, 23 Oct 2021 14:21:42 +0300
Source: sphinx
Architecture: source
Version: 4.2.0-5
Distribution: unstable
Urgency: medium
Maintainer: Debian Python Team <team+python@tracker.debian.org>
Changed-By: Dmitry Shachnev <mitya57@debian.org>
Closes: 996948
Changes:
 sphinx (4.2.0-5) unstable; urgency=medium
 .
   * Remove Built-Using field from sphinx-doc. We do not incorporate any parts
     of other source packages during sphinx-doc build.
   * Run wrap-and-sort.
   * Add a patch to make util.typing.restify sanitize unreproducible output
     (closes: #996948). Thanks Chris Lamb!
   * Update debian/source/lintian-overrides for Lintian 2.109.
Checksums-Sha1:
 f7c95c738b764ff8755096a6d2a84e3614cffc58 3502 sphinx_4.2.0-5.dsc
 7ed71b9f32d27cd8d0b85f0a3e9a84c94c28b919 40388 sphinx_4.2.0-5.debian.tar.xz
 4d8bc15fcc98844371c7fe2a30d5fa46b37d5a02 6125 sphinx_4.2.0-5_source.buildinfo
Checksums-Sha256:
 37ef66fee8457de51b6e069b0f182b62083f739c589f5fd8a59d8d04ddc4eeb9 3502 sphinx_4.2.0-5.dsc
 bd19bd6858e26dd1f61b0bb0eab5d8282553de1e70ef26bd3743419fa4f8d93a 40388 sphinx_4.2.0-5.debian.tar.xz
 4fdffb59eaf35fae289080626fb6094fc96b8f6e73d0e9edeadd1abbc175a612 6125 sphinx_4.2.0-5_source.buildinfo
Files:
 e5d2039dbdbe398201e95bbf95b6e82e 3502 python optional sphinx_4.2.0-5.dsc
 c20ae0e509220cf461d8265671cb12ac 40388 python optional sphinx_4.2.0-5.debian.tar.xz
 ee94bbe4dbcf93113660b01567ce1100 6125 python optional sphinx_4.2.0-5_source.buildinfo

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

iQJGBAEBCgAxFiEE5688gqe4PSusUZcLZkYmW1hrg8sFAmF0ABsTHG1pdHlhNTdA
ZGViaWFuLm9yZwAKCRBmRiZbWGuDy9BvD/jz01CAUpZopz5LC8IwLMkdOiQWIQcI
mn9Gl2O8GEQAkHd7b3PotoKB0vMvHLBHLUqpZeYd4njV0+SqRfq0+bvns+D3K13a
hmqKbqK9b0SpCOMZB8lr0KlQhrDE4pxy76fUsqju5lLk+bi6FVzcWV8FcmwD1fuF
2wa6VMDiPXrt2LsGEXe6braTiOdZeRwpjilohtdXgRRcxR1AMK07+VIf0roPo7De
X7HwYVWAGCdHA4XRKFFIiWEsAuM34D4kn3ezauTHaA45yIefoX0evc25LNsfgx3+
C0Vs+BVQkjb1S33+DSet0HTvp8Xqe6DA9rFaiV7jWmrd6fvr8CcblRDz8pnJADKL
dFqqKe1e3jx34n16PFPM1mZ5FCn+QvBWT/ymgj/68D1BOPUhVEGNzRZc4V6LKuCV
6Cg2mDNh2dP/Hq4k2EYZvblmF8l8gbvShnPnkIK/DUFAD85vHtPlPj3ML6x+xmyX
75+NAV9pQ36Kt1gdBVNAjmPOVxUCVfP/HfT8sv9PK3/FdulKMZL06Yn5HiO4ot9o
4QhlNq+PpB2XwXu2NPcRLN9XKOBLTRAn7vFJc/AW1rA1RXjcTE7qlCa6EX0rOBVf
IegJAKI4EXhaCltD4zpn60KVFdTZMEkI98xqIXAMovASytdvMrYw7KSsQ/x41kF+
PWs+gAs2NnHV
=kAO3
-----END PGP SIGNATURE-----

Send a report that this bug log contains spam.