]> granicus.if.org Git - python/commitdiff
Added cross-references between the various archive file formats.
authorMark Summerfield <list@qtrac.plus.com>
Mon, 5 Nov 2007 09:22:48 +0000 (09:22 +0000)
committerMark Summerfield <list@qtrac.plus.com>
Mon, 5 Nov 2007 09:22:48 +0000 (09:22 +0000)
Doc/library/bz2.rst
Doc/library/gzip.rst
Doc/library/tarfile.rst
Doc/library/zipfile.rst
Doc/library/zlib.rst

index b58d427f9ede1a171421819ceb358688df3cfeea..1749809ce364b103247ca08bfd1400a17792a655 100644 (file)
@@ -14,7 +14,10 @@ This module provides a comprehensive interface for the bz2 compression library.
 It implements a complete file interface, one-shot (de)compression functions, and
 types for sequential (de)compression.
 
-Here is a resume of the features offered by the bz2 module:
+For other archive formats, see the :mod:`gzip`, :mod:`zipfile`, and
+:mod:`tarfile` modules.
+
+Here is a summary of the features offered by the bz2 module:
 
 * :class:`BZ2File` class implements a complete file interface, including
   :meth:`readline`, :meth:`readlines`, :meth:`writelines`, :meth:`seek`, etc;
@@ -32,9 +35,7 @@ Here is a resume of the features offered by the bz2 module:
 * One-shot (de)compression supported by :func:`compress` and :func:`decompress`
   functions;
 
-* Thread safety uses individual locking mechanism;
-
-* Complete inline documentation;
+* Thread safety uses individual locking mechanism.
 
 
 (De)compression of files
index 5978031eb65cafec021ed2eb0c3d9d866de01609..d298f8820e3e90395bfc2ccd3eb2311670d299e8 100644 (file)
@@ -15,6 +15,9 @@ formats which can be decompressed by the :program:`gzip` and :program:`gunzip`
 programs, such  as those produced by :program:`compress` and :program:`pack`,
 are not supported by this module.
 
+For other archive formats, see the :mod:`bz2`, :mod:`zipfile`, and
+:mod:`tarfile` modules.
+
 The module defines the following items:
 
 
index f7e339f7fdb7525f6b992291fcdc6fff41e76fbb..c2f3ac6b155b3a0fae8ca257a42d7117fae2ccfd 100644 (file)
 .. sectionauthor:: Lars Gustäbel <lars@gustaebel.de>
 
 
-The :mod:`tarfile` module makes it possible to read and create tar archives.
+The :mod:`tarfile` module makes it possible to read and write tar
+archives, including those using gzip or bz2 compression.
+(`.zip` files can be read and written using the :mod:`zipfile` module.)
+
 Some facts and figures:
 
-* reads and writes :mod:`gzip` and :mod:`bzip2` compressed archives.
+* reads and writes :mod:`gzip` and :mod:`bz2` compressed archives.
 
 * read/write support for the POSIX.1-1988 (ustar) format.
 
index 7257b35139d0d81bc34f24a3cfeb172ca79617ce..0fa741f301d0bfb70cbd29a2e541a72007ee8b39 100644 (file)
@@ -21,11 +21,13 @@ defined in `PKZIP Application Note
 This module does not currently handle ZIP files which have appended comments, or
 multi-disk ZIP files. It can handle ZIP files that use the ZIP64 extensions
 (that is ZIP files that are more than 4 GByte in size).  It supports decryption
-of encrypted files in ZIP archives, but it cannot currently create an encrypted
+of encrypted files in ZIP archives, but it currently cannot create an encrypted
 file.
 
-The available attributes of this module are:
+For other archive formats, see the :mod:`bz2`, :mod:`gzip`, and
+:mod:`tarfile` modules.
 
+The module defines the following items:
 
 .. exception:: BadZipfile
 
index e57a1562c22fe8c1b4f889e5b513a8c177eba90f..edf5240dd52da7a3b801fb3fbb5bdf5add5e00ad 100644 (file)
@@ -19,6 +19,10 @@ order.  This documentation doesn't attempt to cover all of the permutations;
 consult the zlib manual at http://www.zlib.net/manual.html for authoritative
 information.
 
+For reading and writing ``.gz`` files see the :mod:`gzip` module. For
+other archive formats, see the :mod:`bz2`, :mod:`zipfile`, and
+:mod:`tarfile` modules.
+
 The available exception and functions in this module are: