summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Bussonnier <bussonniermatthias@gmail.com>2021-12-16 20:57:39 +0100
committerGitHub <noreply@github.com>2021-12-16 11:57:39 -0800
commitecdc0ccede5f9ac4042ff56f295d81df2f428950 (patch)
treeb38f33df86a406a1bdc62c548ba88301d890f7e0
parent86f42851c050d756679ae7797f8720adaef381c4 (diff)
downloadcpython-git-ecdc0ccede5f9ac4042ff56f295d81df2f428950.tar.gz
bpo-46044: Annotate deprecated sdists formats (GH-30043)
While this page have deprecated informations it is still heavily index by Google. Discussed on twitter: https://twitter.com/brettsky/status/1469465729082662916
-rw-r--r--Doc/distutils/sourcedist.rst41
1 files changed, 22 insertions, 19 deletions
diff --git a/Doc/distutils/sourcedist.rst b/Doc/distutils/sourcedist.rst
index 0600663d00..43fbb03547 100644
--- a/Doc/distutils/sourcedist.rst
+++ b/Doc/distutils/sourcedist.rst
@@ -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.
@@ -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