summaryrefslogtreecommitdiffstats
path: root/Doc/library/shutil.rst
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2014-08-06 15:50:19 (GMT)
committerSerhiy Storchaka <storchaka@gmail.com>2014-08-06 15:50:19 (GMT)
commit1121377cdb0bef5a4a07699ae3d93c69a1f47071 (patch)
tree13cd19069226278293cc35e2f7b2b7171a695be1 /Doc/library/shutil.rst
parentaf78ef18241040a91e793bfc511a182d9e5d0bc2 (diff)
downloadcpython-1121377cdb0bef5a4a07699ae3d93c69a1f47071.zip
cpython-1121377cdb0bef5a4a07699ae3d93c69a1f47071.tar.gz
cpython-1121377cdb0bef5a4a07699ae3d93c69a1f47071.tar.bz2
Issue #5411: Added support for the "xztar" format in the shutil module.
Diffstat (limited to 'Doc/library/shutil.rst')
-rw-r--r--Doc/library/shutil.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 7a62367..9a3aa82 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -469,7 +469,8 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
*base_name* is the name of the file to create, including the path, minus
any format-specific extension. *format* is the archive format: one of
- "zip", "tar", "bztar" (if the :mod:`bz2` module is available) or "gztar".
+ "zip", "tar", "bztar" (if the :mod:`bz2` module is available), "xztar"
+ (if the :mod:`lzma` module is available) or "gztar".
*root_dir* is a directory that will be the root directory of the
archive; for example, we typically chdir into *root_dir* before creating the
@@ -487,6 +488,9 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
*logger* must be an object compatible with :pep:`282`, usually an instance of
:class:`logging.Logger`.
+ .. versionchanged:: 3.4
+ Added support for the *xztar* format.
+
.. function:: get_archive_formats()
@@ -497,6 +501,7 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
- *gztar*: gzip'ed tar-file
- *bztar*: bzip2'ed tar-file (if the :mod:`bz2` module is available.)
+ - *xztar*: xz'ed tar-file (if the :mod:`lzma` module is available.)
- *tar*: uncompressed tar file
- *zip*: ZIP file
@@ -567,6 +572,7 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
- *gztar*: gzip'ed tar-file
- *bztar*: bzip2'ed tar-file (if the :mod:`bz2` module is available.)
+ - *xztar*: xz'ed tar-file (if the :mod:`lzma` module is available.)
- *tar*: uncompressed tar file
- *zip*: ZIP file