Skip to content

bpo-46044: Annotate deprecated sdists formats #30043

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Dec 16, 2021
Merged

bpo-46044: Annotate deprecated sdists formats #30043

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0e7266
bpo-46044: Annotate deprecated sdists formats
Carreau Dec 10, 2021
4fdd46d
Update Doc/distutils/sourcedist.rst
Carreau Dec 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 22 additions & 19 deletions Doc/distutils/sourcedist.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,25 @@ option, for example::

to create a gzipped tarball and a zip file. The available formats are:

+-----------+-------------------------+---------+
| Format | Description | Notes |
+===========+=========================+=========+
| ``zip`` | zip file (:file:`.zip`) | (1),(3) |
+-----------+-------------------------+---------+
| ``gztar`` | gzip'ed tar file | \(2) |
| | (:file:`.tar.gz`) | |
+-----------+-------------------------+---------+
| ``bztar`` | bzip2'ed tar file | |
| | (:file:`.tar.bz2`) | |
+-----------+-------------------------+---------+
| ``xztar`` | xz'ed tar file | |
| | (:file:`.tar.xz`) | |
+-----------+-------------------------+---------+
| ``ztar`` | compressed tar file | \(4) |
| | (:file:`.tar.Z`) | |
+-----------+-------------------------+---------+
| ``tar`` | tar file (:file:`.tar`) | |
+-----------+-------------------------+---------+
+-----------+-------------------------+-------------+
| Format | Description | Notes |
+===========+=========================+=============+
| ``zip`` | zip file (:file:`.zip`) | (1),(3) |
+-----------+-------------------------+-------------+
| ``gztar`` | gzip'ed tar file | \(2) |
| | (:file:`.tar.gz`) | |
+-----------+-------------------------+-------------+
| ``bztar`` | bzip2'ed tar file | \(5) |
| | (:file:`.tar.bz2`) | |
+-----------+-------------------------+-------------+
| ``xztar`` | xz'ed tar file | \(5) |
| | (:file:`.tar.xz`) | |
+-----------+-------------------------+-------------+
| ``ztar`` | compressed tar file | \(5) |
Copy link
Contributor

Choose a reason for hiding this comment

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

Note 4 should probably remain here? Or else it should be removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hum sorry, not sure how it got removed, likely a repeat command with vim that I messed up.

| | (:file:`.tar.Z`) | |
+-----------+-------------------------+-------------+
| ``tar`` | tar file (:file:`.tar`) | \(5) |
+-----------+-------------------------+-------------+

.. versionchanged:: 3.5
Added support for the ``xztar`` format.
Expand All @@ -61,6 +61,9 @@ Notes:
(4)
requires the :program:`compress` program. Notice that this format is now
pending for deprecation and will be removed in the future versions of Python.
(5)
deprecated by `PEP 527 <https://www.python.org/dev/peps/pep-0527/>`_;
`PyPI <https://pypi.org>`_ only accepts ``.zip`` and ``.tar.gz`` files.

When using any ``tar`` format (``gztar``, ``bztar``, ``xztar``, ``ztar`` or
``tar``), under Unix you can specify the ``owner`` and ``group`` names
Expand Down