summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSumana Harihareswara <sh@changeset.nyc>2020-12-13 17:25:59 -0500
committerSumana Harihareswara <sh@changeset.nyc>2020-12-13 17:25:59 -0500
commitc7591bf973bc4977ab645cda7d67841e20096174 (patch)
tree8d6643d458ba06f93a0ec73ee1b7024dd084c2e4
parent0f8f3d7295ba33d78b70e63b5d5abf1b4743f34c (diff)
downloadpip-c7591bf973bc4977ab645cda7d67841e20096174.tar.gz
docs: Clarify that old resolver is default with Python 2
Partially addresses #9194. Signed-off-by: Sumana Harihareswara <sh@changeset.nyc>
-rw-r--r--README.rst13
-rw-r--r--docs/html/development/release-process.rst5
-rw-r--r--docs/html/index.rst13
-rw-r--r--docs/html/user_guide.rst24
4 files changed, 39 insertions, 16 deletions
diff --git a/README.rst b/README.rst
index d8d12c850..ef0dd0eca 100644
--- a/README.rst
+++ b/README.rst
@@ -19,7 +19,16 @@ We release updates regularly, with a new version every 3 months. Find more detai
* `Release notes`_
* `Release process`_
-In pip 20.3, we're `making a big improvement to the heart of pip`_; `learn more`_. We want your input, so `sign up for our user experience research studies`_ to help us do it right.
+.. warning::
+
+ In pip 20.3, we've `made a big improvement to the heart of pip`_;
+ :ref:`Resolver changes 2020`. We want your input, so `sign up for
+ our user experience research studies`_ to help us do it right.
+
+.. warning::
+
+ pip 21.0, in January 2021, will remove Python 2 support, per pip's
+ :ref:`Python 2 Support` policy. Please migrate to Python 3.
If you find bugs, need help, or want to talk to the developers, please use our mailing lists or chat rooms:
@@ -48,7 +57,7 @@ rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_.
.. _Release process: https://pip.pypa.io/en/latest/development/release-process/
.. _GitHub page: https://github.com/pypa/pip
.. _Development documentation: https://pip.pypa.io/en/latest/development
-.. _making a big improvement to the heart of pip: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html
+.. _made a big improvement to the heart of pip: https://pyfound.blogspot.com/2020/11/pip-20-3-new-resolver.html
.. _learn more: https://pip.pypa.io/en/latest/user_guide/#changes-to-the-pip-dependency-resolver-in-20-3-2020
.. _sign up for our user experience research studies: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html
.. _Issue tracking: https://github.com/pypa/pip/issues
diff --git a/docs/html/development/release-process.rst b/docs/html/development/release-process.rst
index e8c4f5795..91ce3e233 100644
--- a/docs/html/development/release-process.rst
+++ b/docs/html/development/release-process.rst
@@ -70,8 +70,8 @@ their merits.
Python 2 Support
----------------
-pip will continue to ensure that it runs on Python 2.7 after the CPython 2.7
-EOL date. Support for Python 2.7 will be dropped, if bugs in Python 2.7 itself
+pip will continue to ensure that it runs on Python 2.7 after the `CPython 2.7
+EOL date`_. Support for Python 2.7 will be dropped, if bugs in Python 2.7 itself
make this necessary (which is unlikely) or in pip 21.0 (Jan 2021), whichever is
earlier.
@@ -180,3 +180,4 @@ order to create one of these the changes should already be merged into the
.. _`get-pip repository`: https://github.com/pypa/get-pip
.. _`psf-salt repository`: https://github.com/python/psf-salt
.. _`CPython`: https://github.com/python/cpython
+.. _`CPython 2.7 EOL date`: https://www.python.org/doc/sunset-python-2/
diff --git a/docs/html/index.rst b/docs/html/index.rst
index ce40b49fa..1ac460bd9 100644
--- a/docs/html/index.rst
+++ b/docs/html/index.rst
@@ -17,7 +17,16 @@ Please take a look at our documentation for how to install and use pip:
ux_research_design
news
-In pip 20.3, we're `making a big improvement to the heart of pip`_; :ref:`Resolver changes 2020`. We want your input, so `sign up for our user experience research studies`_ to help us do it right.
+.. warning::
+
+ In pip 20.3, we've `made a big improvement to the heart of pip`_;
+ :ref:`Resolver changes 2020`. We want your input, so `sign up for
+ our user experience research studies`_ to help us do it right.
+
+.. warning::
+
+ pip 21.0, in January 2021, will remove Python 2 support, per pip's
+ :ref:`Python 2 Support` policy. Please migrate to Python 3.
If you find bugs, need help, or want to talk to the developers, please use our mailing lists or chat rooms:
@@ -40,7 +49,7 @@ rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_.
.. _package installer: https://packaging.python.org/guides/tool-recommendations/
.. _Python Package Index: https://pypi.org
-.. _making a big improvement to the heart of pip: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html
+.. _made a big improvement to the heart of pip: https://pyfound.blogspot.com/2020/11/pip-20-3-new-resolver.html
.. _sign up for our user experience research studies: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html
.. _Installation: https://pip.pypa.io/en/stable/installing.html
.. _Documentation: https://pip.pypa.io/en/stable/
diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst
index e3aa5dc33..873d41310 100644
--- a/docs/html/user_guide.rst
+++ b/docs/html/user_guide.rst
@@ -1610,11 +1610,12 @@ of ability. Some examples that you could consider include:
Changes to the pip dependency resolver in 20.3 (2020)
=====================================================
-pip 20.3 has a new dependency resolver, on by default. (pip 20.1 and
-20.2 included pre-release versions of the new dependency resolver,
-hidden behind optional user flags.) Read below for a migration guide,
-how to invoke the legacy resolver, and the deprecation timeline. We
-also made a `two-minute video explanation`_ you can watch.
+pip 20.3 has a new dependency resolver, on by default for Python 3
+users. (pip 20.1 and 20.2 included pre-release versions of the new
+dependency resolver, hidden behind optional user flags.) Read below
+for a migration guide, how to invoke the legacy resolver, and the
+deprecation timeline. We also made a `two-minute video explanation`_
+you can watch.
We will continue to improve the pip dependency resolver in response to
testers' feedback. Please give us feedback through the `resolver
@@ -1815,7 +1816,7 @@ Specific things we'd love to get feedback on:
* Cases where the new resolver produces the wrong result,
obviously. We hope there won't be too many of these, but we'd like
- to trap such bugs now.
+ to trap such bugs before we remove the legacy resolver.
* Cases where the resolver produced an error when you believe it
should have been able to work out what to do.
@@ -1850,12 +1851,15 @@ We plan for the resolver changeover to proceed as follows, using
``PIP_USE_FEATURE`` environment variable option, see `issue
8661`_).
-* 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 20.3: pip defaults to the new resolver in Python 3 environments,
+ but a user can opt-out and choose the old resolver behavior,
+ using the flag ``--use-deprecated=legacy-resolver``. In Python 2
+ environments, pip defaults to the old resolver, and the new one ia
+ available using the flag ``--use-feature=2020-resolver``.
* pip 21.0: pip uses new resolver, and the old resolver is no longer
- available.
+ available. Python 2 support is removed per our :ref:`Python 2
+ Support` policy.
Since this work will not change user-visible behavior described in the
pip documentation, this change is not covered by the :ref:`Deprecation