Skip to content

Commit

Permalink
Document use of the backtracking resolver (jazzband#1718)
Browse files Browse the repository at this point in the history
  • Loading branch information
maxfenv authored and Dan Dees committed Nov 12, 2022
1 parent ef879cf commit 26915b1
Showing 1 changed file with 15 additions and 0 deletions.
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

0 comments on commit 26915b1

Please sign in to comment.