Skip to content

Commit

Permalink
Docs: Add details on old resolver deprecation and removal
Browse files Browse the repository at this point in the history
Relevant to pypa#8371, pypa#6536, pypa#8076.

Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
  • Loading branch information
brainwane committed Aug 3, 2020
1 parent 89d8cba commit 3744340
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 5 deletions.
1 change: 1 addition & 0 deletions docs/8371.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add details on old resolver deprecation and removal to migration documentation.
3 changes: 3 additions & 0 deletions docs/html/development/release-process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
Release process
===============

.. _`Release Cadence`:

Release Cadence
===============
Expand Down Expand Up @@ -72,6 +73,8 @@ only bugs will be considered, and merged (subject to normal review processes).
Note that there may be delays due to the lack of developer resources for
reviewing such pull requests.

.. _`Feature Flags`:

Feature Flags
=============

Expand Down
30 changes: 25 additions & 5 deletions docs/html/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1223,22 +1223,42 @@ Specific things we'd love to get feedback on:

Please let us know through the `resolver testing survey`_.

Deprecation timeline
--------------------

We plan for the resolver changeover to proceed as follows, using
:ref:`Feature Flags` and following our :ref:`Release Cadence`:

* pip 20.2: a beta of the new resolver is available, opt-in, using
the flag ``--use-feature=2020-resolver``. pip defaults to
legacy behavior.

* pip 20.3: pip defaults to the new resolver, but a user can opt-out
and choose the old resolver behavior, using the flag
``--use-deprecated=legacy-resolver``.

* pip 21.0: pip uses new resolver, and the old resolver is no longer
available.

Since this work will not change user-visible behavior described in the
pip documentation, this change is not covered by the :ref:`Deprecation
Policy`.

Context and followup
--------------------

As discussed in `our announcement on the PSF blog`_, the pip team are
in the process of developing a new "dependency resolver" (the part of
pip that works out what to install based on your requirements). Since
this work will not change user-visible behavior described in the pip
documentation, this change is not covered by the :ref:`Deprecation
Policy`.
pip that works out what to install based on your requirements).

We're tracking our rollout in :issue:`6536` and you can watch for
announcements on the `low-traffic packaging announcements list`_.
announcements on the `low-traffic packaging announcements list`_ and
`the official Python blog`_.

.. _freeze: https://pip.pypa.io/en/latest/reference/pip_freeze/
.. _resolver testing survey: https://tools.simplysecure.org/survey/index.php?r=survey/index&sid=989272&lang=en
.. _our announcement on the PSF blog: http://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html
.. _tensorflow: https://pypi.org/project/tensorflow/
.. _low-traffic packaging announcements list: https://mail.python.org/mailman3/lists/pypi-announce.python.org/
.. _our survey on upgrades that create conflicts: https://docs.google.com/forms/d/e/1FAIpQLSeBkbhuIlSofXqCyhi3kGkLmtrpPOEBwr6iJA6SzHdxWKfqdA/viewform
.. _the official Python blog: https://blog.python.org/

0 comments on commit 3744340

Please sign in to comment.