Your message dated Fri, 17 Jun 2016 16:46:23 +0000
with message-id <[email protected]>
and subject line Bug#822197: fixed in sphinx 1.4.4-1
has caused the Debian Bug report #822197,
regarding sphinx: please remove memory addresses from generated python
documentation
to be marked as done.
This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.
(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact [email protected]
immediately.)
--
822197: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=822197
Debian Bug Tracking System
Contact [email protected] with problems
--- Begin Message ---
Source: sphinx
Version: 1.3.6-2
Severity: wishlist
Tags: patch upstream
User: [email protected]
Usertags: toolchain
X-Debbugs-Cc: [email protected]
Control: forwarded -1 https://github.com/sphinx-doc/sphinx/pull/2480
Dear Maintainer,
While working on the “reproducible builds” effort [1], we have noticed
that the documentation generated by sphinx can include the memory
address of some python objects that are used at build time. See for
example, in file
/usr/share/doc/python-kombu-doc/html/reference/kombu.transport.qpid.html
from package python-kombu-doc_3.0.35-1.1 :
Transport.Connection.Channel.codecs = {'base64':
<kombu.transport.virtual.Base64 object at 0x7f10fff1a590>}
This memory address is irrelevant in the documentation, and prevents the
package building to be reproducible.
The attached patch strips these memory addresses, leading to better
reproducibility.
Regards,
Alexis Bienvenüe.
[1] https://wiki.debian.org/ReproducibleBuilds
diff -Nru sphinx-1.3.6/debian/changelog sphinx-1.3.6/debian/changelog
--- sphinx-1.3.6/debian/changelog 2016-03-03 18:22:21.000000000 +0100
+++ sphinx-1.3.6/debian/changelog 2016-04-22 00:37:33.000000000 +0200
@@ -1,3 +1,9 @@
+sphinx (1.3.6-3) unstable; urgency=medium
+
+ * Strips memory addresses from python documentation
+
+ -- Alexis Bienvenüe <[email protected]> Fri, 22 Apr 2016 00:37:33 +0200
+
sphinx (1.3.6-2) unstable; urgency=medium
* Use implementation of jstest from Iain Lane in hope it succeeds on
diff -Nru sphinx-1.3.6/debian/patches/remove_memaddress.patch sphinx-1.3.6/debian/patches/remove_memaddress.patch
--- sphinx-1.3.6/debian/patches/remove_memaddress.patch 1970-01-01 01:00:00.000000000 +0100
+++ sphinx-1.3.6/debian/patches/remove_memaddress.patch 2016-04-22 00:36:39.000000000 +0200
@@ -0,0 +1,36 @@
+Description: Removes memory addresses from generated documentation
+ Some modules have eg. functions in some default arguments values, so
+ that sphinx generates signatures with some memory addresses in it.
+ This strips thes addresses.
+Author: Alexis Bienvenüe <[email protected]>
+
+Index: sphinx-1.3.6/sphinx/domains/python.py
+===================================================================
+--- sphinx-1.3.6.orig/sphinx/domains/python.py
++++ sphinx-1.3.6/sphinx/domains/python.py
+@@ -34,6 +34,8 @@ py_sig_re = re.compile(
+ )? $ # and nothing more
+ ''', re.VERBOSE)
+
++# RE for memory address in variable description
++py_memaddr_re = re.compile(r' at 0x[0-9a-f]{4,}(?=>)')
+
+ def _pseudo_parse_arglist(signode, arglist):
+ """"Parse" a list of arguments separated by commas.
+@@ -62,6 +64,7 @@ def _pseudo_parse_arglist(signode, argli
+ ends_open += 1
+ argument = argument[:-1].strip()
+ if argument:
++ argument = py_memaddr_re.sub('',argument)
+ stack[-1] += addnodes.desc_parameter(argument, argument)
+ while ends_open:
+ stack.append(addnodes.desc_optional())
+@@ -220,6 +223,8 @@ class PyObject(ObjectDescription):
+ if retann:
+ signode += addnodes.desc_returns(retann, retann)
+ if anno:
++ if anno[0] == '=':
++ anno = py_memaddr_re.sub('',anno)
+ signode += addnodes.desc_annotation(' ' + anno, ' ' + anno)
+ return fullname, name_prefix
+
diff -Nru sphinx-1.3.6/debian/patches/series sphinx-1.3.6/debian/patches/series
--- sphinx-1.3.6/debian/patches/series 2016-03-03 18:22:21.000000000 +0100
+++ sphinx-1.3.6/debian/patches/series 2016-04-22 00:34:39.000000000 +0200
@@ -7,3 +7,4 @@
reproducible_inventory.diff
reproducible_js_locale.diff
reproducible_searchindex.diff
+remove_memaddress.patch
--- End Message ---
--- Begin Message ---
Source: sphinx
Source-Version: 1.4.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 [email protected],
and the maintainer will reopen the bug report if appropriate.
Debian distribution maintenance software
pp.
Dmitry Shachnev <[email protected]> (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 [email protected])
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256
Format: 1.8
Date: Fri, 17 Jun 2016 18:42:56 +0300
Source: sphinx
Binary: python-sphinx python3-sphinx sphinx-common sphinx-doc libjs-sphinxdoc
Architecture: source
Version: 1.4.4-1
Distribution: unstable
Urgency: medium
Maintainer: Debian Python Modules Team
<[email protected]>
Changed-By: Dmitry Shachnev <[email protected]>
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: 822197
Changes:
sphinx (1.4.4-1) unstable; urgency=medium
.
* New upstream bugfix release.
- Autodoc now removes all memory addresses (closes: #822197).
* Drop python3-xapian build-dependency for unstable upload: it is not
yet available in unstable.
* Build-depend on graphviz so that the corresponding tests are not
skipped.
* Do not install the bundled TeX files from texinput directory:
- fncychap.sty (available in texlive-latex-extra)
- iftex.sty (available in texlive-generic-extra)
- needspace.sty (available in texlive-latex-extra)
- newfloat.sty (available in texlive-latex-recommended)
* Suggest texlive-generic-extra instead (the other packages are already in
the Suggests list).
* Upload to unstable.
Checksums-Sha1:
716b9769b06eba1a2c28685771f31d29164e4cd8 3037 sphinx_1.4.4-1.dsc
87ef31c2ce8c556a1644c53d21526eac7ad45f38 4335455 sphinx_1.4.4.orig.tar.gz
cfca3c8f6c4d18bd0448f3fefa49e8040db41673 33048 sphinx_1.4.4-1.debian.tar.xz
Checksums-Sha256:
955f04f072829f4da54c8314e9442cd7e20d94018cb3fb9bdfb5e1ccbf532262 3037
sphinx_1.4.4-1.dsc
3effd6373734bd59f7457fed2f0bd4ba7ec3c70b4598d7c2e5193a42209dbfa0 4335455
sphinx_1.4.4.orig.tar.gz
9c0ccf8eeb372cec52797067e6025d3443fae87f0dce1806bc50d28ae8687204 33048
sphinx_1.4.4-1.debian.tar.xz
Files:
dc2de5d81f1c01105e2f4ce9c940f5b8 3037 python optional sphinx_1.4.4-1.dsc
64ce2ec08d37ed56313a98232cbe2aee 4335455 python optional
sphinx_1.4.4.orig.tar.gz
a638fcda9fe9600c260853ee8b27e8e5 33048 python optional
sphinx_1.4.4-1.debian.tar.xz
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2
iQIcBAEBCAAGBQJXZBsbAAoJENb+cQNj+F3TipYP+wS2BaJu/p6r318jUDIfpgub
QY1xkyHraa9BeC80G08fgVxcpEmQ86yKYYRaMLOXE4IqcSuv68GuDk5dWD1A5+Fu
EZuqBcjZVbUe2ds3zB4oPHQFG+UhHa2jPIj37TkFATL6qSu9wwZVSn9kkfWXIsBu
tAr0lIOTF0zEBqjsH8wwxTer+xjfBzlvixO72D35C9+PpiygJZpnKwiCBFQr2X2t
Y5hNyMQ7A/TKe142etJQqNcbOenPVObSrC924fv2tx2vgh08JSrOrw7wD3pIIVjD
lhH5QEUy1NZu6vokH5ZJzQIQSuCZhWKOcS4rIMvr0VJTNAsyrNKQv0JXX6aqG5x2
GChb9z+Ob1e4cXaDFz7JTaqNmQPYDdHzNcMYjkwNMTCosf/eYeB3XjMxtmrPOr8B
Ll6JVQiqYmgo9GJE+ZULFsonI4lUPZ1R0cJomaxsxMp2DmigqDxf7pT3D+OOPPp8
sheA45Ra+Yoydhid902rWaY1WUVeCXqUv3AI+J2SQu/R1aNXNLxr96vkNr//G++T
68yR3vSjLP3vV3AKJ+vOlAyquCvlOcu3F03gZxXFDYT0DsZBopMXZPmHdycShZrE
2GUAQg7DhhGsRMk2XGDUrSubH/eZIynfeoJ8e4LjiRoMXOgslhB1yjL2mQoBzudt
rLCcEF5yBOMHM1k7PdWC
=Si0O
-----END PGP SIGNATURE-----
--- End Message ---
_______________________________________________
Python-modules-team mailing list
[email protected]
http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/python-modules-team
