Skip to content

Commit c7591bf

Browse files
committed
docs: Clarify that old resolver is default with Python 2
Partially addresses pypa#9194. Signed-off-by: Sumana Harihareswara <[email protected]>
1 parent 0f8f3d7 commit c7591bf

File tree

4 files changed

+39
-16
lines changed

4 files changed

+39
-16
lines changed

README.rst

+11-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,16 @@ We release updates regularly, with a new version every 3 months. Find more detai
1919
* `Release notes`_
2020
* `Release process`_
2121

22-
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.
22+
.. warning::
23+
24+
In pip 20.3, we've `made a big improvement to the heart of pip`_;
25+
:ref:`Resolver changes 2020`. We want your input, so `sign up for
26+
our user experience research studies`_ to help us do it right.
27+
28+
.. warning::
29+
30+
pip 21.0, in January 2021, will remove Python 2 support, per pip's
31+
:ref:`Python 2 Support` policy. Please migrate to Python 3.
2332

2433
If you find bugs, need help, or want to talk to the developers, please use our mailing lists or chat rooms:
2534

@@ -48,7 +57,7 @@ rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_.
4857
.. _Release process: https://pip.pypa.io/en/latest/development/release-process/
4958
.. _GitHub page: https://github.com/pypa/pip
5059
.. _Development documentation: https://pip.pypa.io/en/latest/development
51-
.. _making a big improvement to the heart of pip: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html
60+
.. _made a big improvement to the heart of pip: https://pyfound.blogspot.com/2020/11/pip-20-3-new-resolver.html
5261
.. _learn more: https://pip.pypa.io/en/latest/user_guide/#changes-to-the-pip-dependency-resolver-in-20-3-2020
5362
.. _sign up for our user experience research studies: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html
5463
.. _Issue tracking: https://github.com/pypa/pip/issues

docs/html/development/release-process.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ their merits.
7070
Python 2 Support
7171
----------------
7272

73-
pip will continue to ensure that it runs on Python 2.7 after the CPython 2.7
74-
EOL date. Support for Python 2.7 will be dropped, if bugs in Python 2.7 itself
73+
pip will continue to ensure that it runs on Python 2.7 after the `CPython 2.7
74+
EOL date`_. Support for Python 2.7 will be dropped, if bugs in Python 2.7 itself
7575
make this necessary (which is unlikely) or in pip 21.0 (Jan 2021), whichever is
7676
earlier.
7777

@@ -180,3 +180,4 @@ order to create one of these the changes should already be merged into the
180180
.. _`get-pip repository`: https://github.com/pypa/get-pip
181181
.. _`psf-salt repository`: https://github.com/python/psf-salt
182182
.. _`CPython`: https://github.com/python/cpython
183+
.. _`CPython 2.7 EOL date`: https://www.python.org/doc/sunset-python-2/

docs/html/index.rst

+11-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,16 @@ Please take a look at our documentation for how to install and use pip:
1717
ux_research_design
1818
news
1919

20-
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.
20+
.. warning::
21+
22+
In pip 20.3, we've `made a big improvement to the heart of pip`_;
23+
:ref:`Resolver changes 2020`. We want your input, so `sign up for
24+
our user experience research studies`_ to help us do it right.
25+
26+
.. warning::
27+
28+
pip 21.0, in January 2021, will remove Python 2 support, per pip's
29+
:ref:`Python 2 Support` policy. Please migrate to Python 3.
2130

2231
If you find bugs, need help, or want to talk to the developers, please use our mailing lists or chat rooms:
2332

@@ -40,7 +49,7 @@ rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_.
4049

4150
.. _package installer: https://packaging.python.org/guides/tool-recommendations/
4251
.. _Python Package Index: https://pypi.org
43-
.. _making a big improvement to the heart of pip: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html
52+
.. _made a big improvement to the heart of pip: https://pyfound.blogspot.com/2020/11/pip-20-3-new-resolver.html
4453
.. _sign up for our user experience research studies: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html
4554
.. _Installation: https://pip.pypa.io/en/stable/installing.html
4655
.. _Documentation: https://pip.pypa.io/en/stable/

docs/html/user_guide.rst

+14-10
Original file line numberDiff line numberDiff line change
@@ -1610,11 +1610,12 @@ of ability. Some examples that you could consider include:
16101610
Changes to the pip dependency resolver in 20.3 (2020)
16111611
=====================================================
16121612

1613-
pip 20.3 has a new dependency resolver, on by default. (pip 20.1 and
1614-
20.2 included pre-release versions of the new dependency resolver,
1615-
hidden behind optional user flags.) Read below for a migration guide,
1616-
how to invoke the legacy resolver, and the deprecation timeline. We
1617-
also made a `two-minute video explanation`_ you can watch.
1613+
pip 20.3 has a new dependency resolver, on by default for Python 3
1614+
users. (pip 20.1 and 20.2 included pre-release versions of the new
1615+
dependency resolver, hidden behind optional user flags.) Read below
1616+
for a migration guide, how to invoke the legacy resolver, and the
1617+
deprecation timeline. We also made a `two-minute video explanation`_
1618+
you can watch.
16181619

16191620
We will continue to improve the pip dependency resolver in response to
16201621
testers' feedback. Please give us feedback through the `resolver
@@ -1815,7 +1816,7 @@ Specific things we'd love to get feedback on:
18151816

18161817
* Cases where the new resolver produces the wrong result,
18171818
obviously. We hope there won't be too many of these, but we'd like
1818-
to trap such bugs now.
1819+
to trap such bugs before we remove the legacy resolver.
18191820

18201821
* Cases where the resolver produced an error when you believe it
18211822
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
18501851
``PIP_USE_FEATURE`` environment variable option, see `issue
18511852
8661`_).
18521853

1853-
* pip 20.3: pip defaults to the new resolver, but a user can opt-out
1854-
and choose the old resolver behavior, using the flag
1855-
``--use-deprecated=legacy-resolver``.
1854+
* pip 20.3: pip defaults to the new resolver in Python 3 environments,
1855+
but a user can opt-out and choose the old resolver behavior,
1856+
using the flag ``--use-deprecated=legacy-resolver``. In Python 2
1857+
environments, pip defaults to the old resolver, and the new one ia
1858+
available using the flag ``--use-feature=2020-resolver``.
18561859

18571860
* pip 21.0: pip uses new resolver, and the old resolver is no longer
1858-
available.
1861+
available. Python 2 support is removed per our :ref:`Python 2
1862+
Support` policy.
18591863

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

0 commit comments

Comments
 (0)