From d0e7266ad7b7844080597a8e1b30af30e50ea07c Mon Sep 17 00:00:00 2001 From: Matthias Bussonnier Date: Fri, 10 Dec 2021 13:04:58 -0800 Subject: [PATCH 1/2] bpo-46044: Annotate deprecated sdists formats While this page have deprecated informations it is still heavily index by Google. Discussed on twitter: https://twitter.com/brettsky/status/1469465729082662916 --- Doc/distutils/sourcedist.rst | 41 +++++++++++++++++++----------------- 1 file changed, 22 insertions(+), 19 deletions(-) diff --git a/Doc/distutils/sourcedist.rst b/Doc/distutils/sourcedist.rst index 0600663d00e9dc..1d42d6bbd94f93 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) + Those have been deprecated by `Pep 527 `_, + and PyPI only accepts ``.zip`` and ``.tar.gz`` file. When using any ``tar`` format (``gztar``, ``bztar``, ``xztar``, ``ztar`` or ``tar``), under Unix you can specify the ``owner`` and ``group`` names From 4fdd46dda2bfbe52fc5a7752d551380158644f09 Mon Sep 17 00:00:00 2001 From: Matthias Bussonnier Date: Thu, 16 Dec 2021 12:53:02 +0100 Subject: [PATCH 2/2] Update Doc/distutils/sourcedist.rst Co-authored-by: Brett Cannon --- Doc/distutils/sourcedist.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/distutils/sourcedist.rst b/Doc/distutils/sourcedist.rst index 1d42d6bbd94f93..43fbb03547f781 100644 --- a/Doc/distutils/sourcedist.rst +++ b/Doc/distutils/sourcedist.rst @@ -62,8 +62,8 @@ Notes: 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) - Those have been deprecated by `Pep 527 `_, - and PyPI only accepts ``.zip`` and ``.tar.gz`` file. + deprecated by `PEP 527 `_; + `PyPI `_ 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