Merge pull request #8688 from brainwane/deprecation-opt-in-resolver

Docs: Add details on old resolver deprecation and removal

docs/html/development/release-process.rst

@@ -2,6 +2,7 @@
 Release process
 ===============
 
+.. _`Release Cadence`:
 
 Release Cadence
 ===============
@@ -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
 =============
 

docs/html/user_guide.rst

@@ -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/

news/8371.doc

@@ -0,0 +1 @@
+Add details on old resolver deprecation and removal to migration documentation.