summaryrefslogtreecommitdiffstats
path: root/Doc/library/shutil.rst
diff options
context:
space:
mode:
authorCAM Gerlach <CAM.Gerlach@Gerlach.CAM>2019-04-07 04:47:49 (GMT)
committerNick Coghlan <ncoghlan@gmail.com>2019-04-07 04:47:49 (GMT)
commit89a894403cfa880d7f9d1d67070f61456d14cbde (patch)
treeec5675bbc8f5b7b3eff5fbc0bc91e87660f0c483 /Doc/library/shutil.rst
parent2ea8099523581cf2ecc060831a53debb57ff98ee (diff)
downloadcpython-89a894403cfa880d7f9d1d67070f61456d14cbde.zip
cpython-89a894403cfa880d7f9d1d67070f61456d14cbde.tar.gz
cpython-89a894403cfa880d7f9d1d67070f61456d14cbde.tar.bz2
bpo-30661: Improve docs for tarfile pax change and effect on shutil (GH-12635)
The shutil archive creation helpers use the default tarfile format, so that API is also switching to use `pax` by default.
Diffstat (limited to 'Doc/library/shutil.rst')
-rw-r--r--Doc/library/shutil.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 587be3b..2dc872f 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -559,6 +559,10 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
The *verbose* argument is unused and deprecated.
+ .. versionchanged:: 3.8
+ The modern pax (POSIX.1-2001) format is now used instead of
+ the legacy GNU format for archives created with ``format="tar"``.
+
.. function:: get_archive_formats()
@@ -568,7 +572,7 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
By default :mod:`shutil` provides these formats:
- *zip*: ZIP file (if the :mod:`zlib` module is available).
- - *tar*: uncompressed tar file.
+ - *tar*: Uncompressed tar file. Uses POSIX.1-2001 pax format for new archives.
- *gztar*: gzip'ed tar-file (if the :mod:`zlib` module is available).
- *bztar*: bzip2'ed tar-file (if the :mod:`bz2` module is available).
- *xztar*: xz'ed tar-file (if the :mod:`lzma` module is available).