Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-30661: Improve doc for tarfile pax change and effect on shutil #12635

Merged
merged 1 commit into from
Apr 7, 2019

Conversation

CAM-Gerlach
Copy link
Member

@CAM-Gerlach CAM-Gerlach commented Mar 30, 2019

As a followup to bpo-36268 and PR #12355 , to fully resolve bpo-30661 this PR makes the following documentation changes:

  • Adds a mention of the now-default pax format to the tar shutil.make_archive format, and adds a versionchanged note to this effect to shutil.make_archive.
  • Adds a mention of the change to the shutil section of the What's New document.
  • Makes some minor textual fixes, clarifications and improvements to the tarfile formats section, and fixes an incorrect indent level for the versionchanged section there.

I didn't add a NEWS item for this change, but I can do so if desired (@ncoghlan ?).

https://bugs.python.org/issue30661

@@ -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 modern pax (POSIX.1-2001) format is now used instead of
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was doubling modern meant to distract me from noticing 2001 is eighteen years ago? :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Heh. "modern"-est, I suppose, although to be fair it took even libarchive (modern bsdtar) 10 years to implement fully complete support (ironically, GNU tar had it far earlier). And would you believe I've worked as a freelance copyeditor?

In any case, fixed, thanks.

Copy link
Contributor

@ncoghlan ncoghlan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! And I agree this doesn't need a separate NEWS item - it's covered by the existing one for the tarfile change, as it's just updating the docs to explain shutil inherits that change in defaults.

@ncoghlan ncoghlan merged commit 89a8944 into python:master Apr 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants