summaryrefslogtreecommitdiff
path: root/Doc
diff options
context:
space:
mode:
authorAndrés Delfino <adelfino@gmail.com>2018-09-29 13:57:35 -0300
committerBrian Curtin <brian@python.org>2018-09-29 10:57:35 -0600
commit8d3b0f49021e6cd25030a1eb979218cfceb44061 (patch)
tree25b1dcb9d6144bed53a4dd45851b3ee9c198e35a /Doc
parent911231e70843fb255fc395473e668361532e00a6 (diff)
downloadcpython-git-8d3b0f49021e6cd25030a1eb979218cfceb44061.tar.gz
[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
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/bz2.rst4
-rw-r--r--Doc/library/tarfile.rst4
2 files changed, 8 insertions, 0 deletions
diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst
index e764f39395..478a8423f3 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 <https://github.com/nvawda/bz2file>`_ let you overcome this.
+
(De)compression of files
------------------------
diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst
index c819bf500a..5789e5efd5 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 <https://github.com/nvawda/bz2file>`_ let you overcome this.
+
.. function:: open(name=None, mode='r', fileobj=None, bufsize=10240, \*\*kwargs)