From aea6e5913b66e9dfc8b9099a83b7becac7e74177 Mon Sep 17 00:00:00 2001 From: Mark Summerfield Date: Mon, 5 Nov 2007 09:22:48 +0000 Subject: Added cross-references between the various archive file formats. --- Doc/library/bz2.rst | 9 +++++---- Doc/library/gzip.rst | 3 +++ Doc/library/tarfile.rst | 7 +++++-- Doc/library/zipfile.rst | 6 ++++-- Doc/library/zlib.rst | 4 ++++ 5 files changed, 21 insertions(+), 8 deletions(-) diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst index b58d427..1749809 100644 --- a/Doc/library/bz2.rst +++ b/Doc/library/bz2.rst @@ -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 diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst index 5978031..d298f88 100644 --- a/Doc/library/gzip.rst +++ b/Doc/library/gzip.rst @@ -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: diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst index f7e339f..c2f3ac6 100644 --- a/Doc/library/tarfile.rst +++ b/Doc/library/tarfile.rst @@ -13,10 +13,13 @@ .. sectionauthor:: Lars Gustäbel -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. diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst index 7257b35..0fa741f 100644 --- a/Doc/library/zipfile.rst +++ b/Doc/library/zipfile.rst @@ -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 diff --git a/Doc/library/zlib.rst b/Doc/library/zlib.rst index e57a156..edf5240 100644 --- a/Doc/library/zlib.rst +++ b/Doc/library/zlib.rst @@ -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: -- cgit v0.12