[Python-checkins] cpython (2.7): #14056: Small improvements to the tarfile documentation.

[r.david.murray]

https://hg.python.org/cpython/rev/378f3d237ac2
changeset:   92784:378f3d237ac2
branch:      2.7
parent:      92779:fb9255d0b0f9
user:        R David Murray <rdmurray at bitdance.com>
date:        Fri Oct 03 20:30:42 2014 -0400
summary:
  #14056: Small improvements to the tarfile documentation.

Patch by Éric Araujo with help from Lars Gustäbel.

files:
  Doc/library/tarfile.rst |  24 ++++++++++++++----------
  1 files changed, 14 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
@@ -21,7 +21,8 @@
 
 Some facts and figures:
 
-* reads and writes :mod:`gzip` and :mod:`bz2` compressed archives.
+* reads and writes :mod:`gzip` and :mod:`bz2` compressed archives
+  if the respective modules are available.
 
 * read/write support for the POSIX.1-1988 (ustar) format.
 
@@ -179,6 +180,14 @@
    :attr:`TarFile.errorlevel`\ ``== 2``.
 
 
+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.
+
+
 .. exception:: HeaderError
 
    Is raised by :meth:`TarInfo.frombuf` if the buffer it gets is invalid.
@@ -211,20 +220,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 i.e. the value from either
-   :func:`sys.getfilesystemencoding` or :func:`sys.getdefaultencoding`.
-
-
 .. 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