Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document use of the backtracking resolver #1718

Merged
merged 5 commits into from
Nov 8, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -572,6 +572,21 @@ This section lists ``pip-tools`` features that are currently deprecated.
recommended to pass the ``--allow-unsafe`` now to adapt to the upcoming
change.

A Note on Resolvers
===================

You can choose from either the legacy or the backtracking resolver.
The backtracking resolver is recommended, and will become the default
with the 7.0 release.

Use it now with the ``--resolver=backtracking`` option to ``pip-compile``.

The legacy resolver will occasionally fail to resolve dependencies. The
backtracking resolver is more robust, but can take longer to run in
general.

You can continue using the legacy resolver with ``--resolver=legacy``.

Versions and compatibility
==========================

Expand Down