Skip to content

Commit

Permalink
docs: Clarify that old resolver is default with Python 2
Browse files Browse the repository at this point in the history
Partially addresses pypa#9194.

Signed-off-by: Sumana Harihareswara <[email protected]>
  • Loading branch information
brainwane committed Dec 13, 2020
1 parent 0f8f3d7 commit c7591bf
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 16 deletions.
13 changes: 11 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions docs/html/development/release-process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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/
13 changes: 11 additions & 2 deletions docs/html/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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/
Expand Down
24 changes: 14 additions & 10 deletions docs/html/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit c7591bf

Please sign in to comment.