Skip to content

Commit

Permalink
bpo-46044: Annotate deprecated sdists formats (pythonGH-30043)
Browse files Browse the repository at this point in the history
While this page have deprecated informations it is still heavily index
by Google.

Discussed on twitter: https://twitter.com/brettsky/status/1469465729082662916
  • Loading branch information
Carreau authored Dec 16, 2021
1 parent 86f4285 commit ecdc0cc
Showing 1 changed file with 22 additions and 19 deletions.
41 changes: 22 additions & 19 deletions Doc/distutils/sourcedist.rst
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) |
| | (: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

0 comments on commit ecdc0cc

Please sign in to comment.