[Python-checkins] cpython (merge 3.4 -> default): Merge: #14056: Small improvements to the tarfile documentation.

Sat Oct 4 02:19:18 CEST 2014

https://hg.python.org/cpython/rev/ab828eeee2b2
changeset: 92783:ab828eeee2b2
parent: 92781:01db4c47c6eb
parent: 92782:a486b673b57f
user: R David Murray <rdmurray at bitdance.com>
date: Fri Oct 03 20:19:09 2014 -0400
summary:
 Merge: #14056: Small improvements to the tarfile documentation.
files:
 Doc/library/tarfile.rst | 23 +++++++++++++----------
 1 files changed, 13 insertions(+), 10 deletions(-)

diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst
--- a/Doc/library/tarfile.rst
+++ b/Doc/library/tarfile.rst
@@ -19,7 +19,8 @@
 
 Some facts and figures:
 
-* reads and writes :mod:`gzip`, :mod:`bz2` and :mod:`lzma` compressed archives.
+* reads and writes :mod:`gzip`, :mod:`bz2` and :mod:`lzma` compressed archives
+ if the respective modules are available.
 
 * read/write support for the POSIX.1-1988 (ustar) format.
 
@@ -176,6 +177,13 @@
 Is raised by :meth:`TarInfo.frombuf` if the buffer it gets is invalid.
 
 
+The following constants are available at the module level:
+
+.. data:: ENCODING
+
+ The default character encoding: ``'utf-8'`` on Windows, the value returned by
+ :func:`sys.getfilesystemencoding` otherwise.
+
 
 Each of the following constants defines a tar archive format that the
 :mod:`tarfile` module is able to create. See section :ref:`tar-formats` for
@@ -202,20 +210,15 @@
 The default format for creating archives. This is currently :const:`GNU_FORMAT`.
 
 
-The following variables are available on module level:
-
-
-.. data:: ENCODING
-
- The default character encoding: ``'utf-8'`` on Windows,
- :func:`sys.getfilesystemencoding` otherwise.
-
-
 .. seealso::
 
 Module :mod:`zipfile`
 Documentation of the :mod:`zipfile` standard module.
 
+ :ref:`archiving-operations`
+ Documentation of the higher-level archiving facilities provided by the
+ standard :mod:`shutil` module.
+
 `GNU tar manual, Basic Tar Format <http://www.gnu.org/software/tar/manual/html_node/Standard.html>`_
 Documentation for tar archive files, including GNU tar extensions.
 
-- 
Repository URL: https://hg.python.org/cpython
