cpython: 378f3d237ac2 (original) (raw)

Mercurial > cpython

changeset 92784:378f3d237ac2 2.7

#14056: Small improvements to the tarfile documentation. Patch by Éric Araujo with help from Lars Gustäbel. [#14056]

R David Murray rdmurray@bitdance.com
date	Fri, 03 Oct 2014 20:30:42 -0400
parents	fb9255d0b0f9
children	911da1072099
files	Doc/library/tarfile.rst
diffstat	1 files changed, 14 insertions(+), 10 deletions(-)[+] [-] Doc/library/tarfile.rst 24

line wrap: on

line diff

--- a/Doc/library/tarfile.rst +++ b/Doc/library/tarfile.rst @@ -21,7 +21,8 @@ higher-level functions in :ref:shutil <[](#l1.3) [](#l1.4) Some facts and figures:[](#l1.5) [](#l1.6) -* reads and writes :mod:gzip and :mod:bz2 compressed archives.[](#l1.7) +* 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 @@ Some facts and figures: :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 @@ 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 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[](#l1.47)

 standard :mod:`shutil` module.[](#l1.48)

+ 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.