Skip to content

Commit 49b765c

Browse files
committed
Docs: Add details on old resolver deprecation and removal
Relevant to pypa#8371, pypa#6536, pypa#8076. Signed-off-by: Sumana Harihareswara <[email protected]>
1 parent 89d8cba commit 49b765c

File tree

2 files changed

+28
-5
lines changed

2 files changed

+28
-5
lines changed

docs/html/development/release-process.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
Release process
33
===============
44

5+
.. _`Release Cadence`:
56

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

76+
.. _`Feature Flags`:
77+
7578
Feature Flags
7679
=============
7780

docs/html/user_guide.rst

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1223,22 +1223,42 @@ Specific things we'd love to get feedback on:
12231223

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

1226+
Deprecation timeline
1227+
--------------------
1228+
1229+
We plan for the resolver changeover to proceed as follows, using
1230+
:ref:`Feature Flags` and following our :ref:`Release Cadence`:
1231+
1232+
* pip 20.2: a beta of the new resolver is available, opt-in, using
1233+
the flag ``--use-feature=2020-resolver``. pip defaults to
1234+
legacy behavior.
1235+
1236+
* pip 20.3: pip defaults to the new resolver, but a user can opt-out
1237+
and choose the old resolver behavior, using the flag
1238+
``--use-deprecated=legacy-resolver``.
1239+
1240+
* pip 21.0: pip uses new resolver, and the old resolver is no longer
1241+
available.
1242+
1243+
Since this work will not change user-visible behavior described in the
1244+
pip documentation, this change is not covered by the :ref:`Deprecation
1245+
Policy`.
1246+
12261247
Context and followup
12271248
--------------------
12281249

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

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

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

0 commit comments

Comments
 (0)