(original) (raw)

changeset: 75264:7c22281e967c branch: 2.7 parent: 75257:020364d3e359 user: Éric Araujo merwok@netwok.org date: Sun Feb 26 01:10:14 2012 +0100 files: Doc/library/archiving.rst Doc/library/bz2.rst Doc/library/gzip.rst Doc/library/shutil.rst Doc/library/tarfile.rst Doc/library/zipfile.rst Doc/library/zlib.rst description: Improve interlinking of archiving/compression modules docs. - Remove duplicate list of links to the other modules from each module’s doc (people can already go up to library/archiving and there they can see the list). - Link to shutil high-level operations. Reviewed by Nadeem Vawda in #6715. diff -r 020364d3e359 -r 7c22281e967c Doc/library/archiving.rst --- a/Doc/library/archiving.rst Sat Feb 25 16:24:59 2012 +0100 +++ b/Doc/library/archiving.rst Sun Feb 26 01:10:14 2012 +0100 @@ -7,6 +7,7 @@ The modules described in this chapter support data compression with the zlib, gzip, and bzip2 algorithms, and the creation of ZIP- and tar-format archives. +See also :ref:`archiving-operations` provided by the :mod:`shutil` module. .. toctree:: diff -r 020364d3e359 -r 7c22281e967c Doc/library/bz2.rst --- a/Doc/library/bz2.rst Sat Feb 25 16:24:59 2012 +0100 +++ b/Doc/library/bz2.rst Sun Feb 26 01:10:14 2012 +0100 @@ -14,9 +14,6 @@ It implements a complete file interface, one-shot (de)compression functions, and types for sequential (de)compression. -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 diff -r 020364d3e359 -r 7c22281e967c Doc/library/gzip.rst --- a/Doc/library/gzip.rst Sat Feb 25 16:24:59 2012 +0100 +++ b/Doc/library/gzip.rst Sun Feb 26 01:10:14 2012 +0100 @@ -22,9 +22,6 @@ :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 -r 020364d3e359 -r 7c22281e967c Doc/library/shutil.rst --- a/Doc/library/shutil.rst Sat Feb 25 16:24:59 2012 +0100 +++ b/Doc/library/shutil.rst Sun Feb 26 01:10:14 2012 +0100 @@ -31,6 +31,8 @@ are not copied. +.. _file-operations: + Directory and files operations ------------------------------ @@ -185,7 +187,7 @@ .. versionadded:: 2.3 -.. _shutil-example: +.. _copytree-example: copytree example :::::::::::::::: @@ -254,8 +256,13 @@ copytree(source, destination, ignore=_logpath) -Archives operations -------------------- +.. _archiving-operations: + +Archiving operations +-------------------- + +High-level utilities to create and read compressed and archived files are also +provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules. .. function:: make_archive(base_name, format, [root_dir, [base_dir, [verbose, [dry_run, [owner, [group, [logger]]]]]]]) @@ -322,6 +329,8 @@ .. versionadded:: 2.7 +.. _archiving-example: + Archiving example ::::::::::::::::: @@ -346,5 +355,3 @@ -rw------- tarek/staff 1675 2008-06-09 13:26:54 ./id_rsa -rw-r--r-- tarek/staff 397 2008-06-09 13:26:54 ./id_rsa.pub -rw-r--r-- tarek/staff 37192 2010-02-06 18:23:10 ./known_hosts - - diff -r 020364d3e359 -r 7c22281e967c Doc/library/tarfile.rst --- a/Doc/library/tarfile.rst Sat Feb 25 16:24:59 2012 +0100 +++ b/Doc/library/tarfile.rst Sun Feb 26 01:10:14 2012 +0100 @@ -16,7 +16,8 @@ The :mod:`tarfile` module makes it possible to read and write tar archives, including those using gzip or bz2 compression. -(:file:`.zip` files can be read and written using the :mod:`zipfile` module.) +Use the :mod:`zipfile` module to read or write :file:`.zip` files, or the +higher-level functions in :ref:`shutil `. Some facts and figures: diff -r 020364d3e359 -r 7c22281e967c Doc/library/zipfile.rst --- a/Doc/library/zipfile.rst Sat Feb 25 16:24:59 2012 +0100 +++ b/Doc/library/zipfile.rst Sun Feb 26 01:10:14 2012 +0100 @@ -25,9 +25,6 @@ create an encrypted file. Decryption is extremely slow as it is implemented in native Python rather than C. -For other archive formats, see the :mod:`bz2`, :mod:`gzip`, and -:mod:`tarfile` modules. - The module defines the following items: .. exception:: BadZipfile diff -r 020364d3e359 -r 7c22281e967c Doc/library/zlib.rst --- a/Doc/library/zlib.rst Sat Feb 25 16:24:59 2012 +0100 +++ b/Doc/library/zlib.rst Sun Feb 26 01:10:14 2012 +0100 @@ -19,9 +19,7 @@ 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. +For reading and writing ``.gz`` files see the :mod:`gzip` module. The available exception and functions in this module are:/merwok@netwok.org