From: Andrés Delfino Date: Sat, 29 Sep 2018 16:57:35 +0000 (-0300) Subject: [2.7] bpo-13407: Mention that bz2/tarfile doesn't support multi-stream bzip2 files... X-Git-Tag: v2.7.16rc1~129 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8d3b0f49021e6cd25030a1eb979218cfceb44061;p=thirdparty%2FPython%2Fcpython.git [2.7] bpo-13407: Mention that bz2/tarfile doesn't support multi-stream bzip2 files (GH-8428) * bpo-13407: Mention that tarfile doesn't support multistream bzip2 files * Add mention to bz2 module also --- diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst index e764f3939544..478a8423f3ff 100644 --- a/Doc/library/bz2.rst +++ b/Doc/library/bz2.rst @@ -35,6 +35,10 @@ Here is a summary of the features offered by the bz2 module: * Thread safety uses individual locking mechanism. +.. note:: + Handling of multi-stream bzip2 files is not supported. Modules such as + `bz2file `_ let you overcome this. + (De)compression of files ------------------------ diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst index c819bf500a19..5789e5efd5a9 100644 --- a/Doc/library/tarfile.rst +++ b/Doc/library/tarfile.rst @@ -37,6 +37,10 @@ Some facts and figures: character devices and block devices and is able to acquire and restore file information like timestamp, access permissions and owner. +.. note:: + Handling of multi-stream bzip2 files is not supported. Modules such as + `bz2file `_ let you overcome this. + .. function:: open(name=None, mode='r', fileobj=None, bufsize=10240, \*\*kwargs) diff --git a/Misc/NEWS.d/next/Documentation/2018-09-29-13-40-06.bpo-13407.BRI-_D.rst b/Misc/NEWS.d/next/Documentation/2018-09-29-13-40-06.bpo-13407.BRI-_D.rst new file mode 100644 index 000000000000..e1766932c86c --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2018-09-29-13-40-06.bpo-13407.BRI-_D.rst @@ -0,0 +1,2 @@ +Add a note to :mod:`bz2` and :mod:`tarfile` stating that handling of +multi-stream bzip2 files is not supported.