summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2014-10-04 00:18:48 (GMT)
committerR David Murray <rdmurray@bitdance.com>2014-10-04 00:18:48 (GMT)
commitbf92bceaaab32983707f076fabb327ba6861b9af (patch)
tree966295aec8eee04fddc6cc0b0ed14fe11c8d9223 /Doc
parent91244e01bbe0dcd1a1183ad4e80cd6cb33b553de (diff)
downloadcpython-bf92bceaaab32983707f076fabb327ba6861b9af.zip
cpython-bf92bceaaab32983707f076fabb327ba6861b9af.tar.gz
cpython-bf92bceaaab32983707f076fabb327ba6861b9af.tar.bz2
#14056: Small improvements to the tarfile documentation.
Patch by Éric Araujo with help from Lars Gustäbel.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/tarfile.rst23
1 files changed, 13 insertions, 10 deletions
diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst
index d3956fd..b07850f 100644
--- a/Doc/library/tarfile.rst
+++ b/Doc/library/tarfile.rst
@@ -19,7 +19,8 @@ higher-level functions in :ref:`shutil <archiving-operations>`.
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 @@ The :mod:`tarfile` module defines the following exceptions:
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 @@ details.
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.