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

Reply or subscribe to this bug.

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 build reproducible

Date: Fri, 09 Dec 2022 11:59:07 +0000

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

Source: sphinx
Version: 5.3.0-2
Severity: wishlist
Tags: patch
User: reproducible-builds@lists.alioth.debian.org
Usertags: buildpath
X-Debbugs-Cc: reproducible-bugs@lists.alioth.debian.org

Hi,

Whilst working on the Reproducible Builds effort [0] we noticed that
sphinx could not be built reproducibly.

This is because a default argument for a method uses the path in
which that method is implemented (ie. it uses Python's __file__)
and then that (non-deterministic) default argument is included in
Sphinx's documentation. 

Patch attached that uses the typical; "fn(arg1=None) // if arg1 is
None: arg1=defaultval" pattern to avoid this.

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


Regards,

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

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

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

From: Dmitry Shachnev <mitya57@debian.org>

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

Subject: Re: Bug#1025801: sphinx: please make the build reproducible

Date: Sat, 10 Dec 2022 11:47:30 +0300

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

Hi Chris!

On Fri, Dec 09, 2022 at 11:59:07AM +0000, Chris Lamb wrote:
> Hi,
>
> Whilst working on the Reproducible Builds effort [0] we noticed that
> sphinx could not be built reproducibly.
>
> This is because a default argument for a method uses the path in
> which that method is implemented (ie. it uses Python's __file__)
> and then that (non-deterministic) default argument is included in
> Sphinx's documentation. 
>
> Patch attached that uses the typical; "fn(arg1=None) // if arg1 is
> None: arg1=defaultval" pattern to avoid this.

Can you please forward your patch upstream to [1]?

[1]: https://github.com/sphinx-doc/sphinx/pulls

--
Dmitry Shachnev

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

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

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

To: "Dmitry Shachnev" <mitya57@debian.org>, 1025801@bugs.debian.org

Subject: Re: Bug#1025801: sphinx: please make the build reproducible

Date: Mon, 19 Dec 2022 15:33:19 +0000

forwarded 1025801 https://github.com/sphinx-doc/sphinx/pull/11037
thanks

Dmitry Shachnev wrote:

> Can you please forward your patch upstream to [1]?
>
> [1]: https://github.com/sphinx-doc/sphinx/pulls

Done.


Regards,

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

Send a report that this bug log contains spam.