Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix documentation on --index-strategy values (#3290) 

## Summary

Dropped the `--` prefix from the values of the `--index-strategy` option
mistakenly added to documentation in #3138.

## Test Plan

Verified that actually accepted values of `--index-strategy` don't use a
`--` prefix.
This commit is contained in:
Sergey Kolosov 2024-04-27 23:44:26 +03:00 committed by GitHub
parent 42a44dcfff
commit 748ed66a4d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
PIP_COMPATIBILITY.md
View File

@ -132,15 +132,15 @@ As of v0.1.39, users can opt in to `pip`-style behavior for multiple indexes via
`--index-strategy` command-line option, or the `UV_INDEX_STRATEGY` environment `--index-strategy` command-line option, or the `UV_INDEX_STRATEGY` environment
variable, which supports the following values: variable, which supports the following values:
- `--first-match` (default): Search for each package across all indexes, limiting the candidate - `first-match` (default): Search for each package across all indexes, limiting the candidate
versions to those present in the first index that contains the package, prioritizing the versions to those present in the first index that contains the package, prioritizing the
`--extra-index-url` indexes over the default index URL. `--extra-index-url` indexes over the default index URL.
- `--unsafe-first-match`: Search for each package across all indexes, but prefer the first index - `unsafe-first-match`: Search for each package across all indexes, but prefer the first index
with a compatible version, even if newer versions are available on other indexes. with a compatible version, even if newer versions are available on other indexes.
- `--unsafe-best-match`: Search for each package across all indexes, and select the best version - `unsafe-best-match`: Search for each package across all indexes, and select the best version
from the combined set of candidate versions. from the combined set of candidate versions.
While `--unsafe-best-match` is the closest to `pip`'s behavior, it exposes users to the risk of While `unsafe-best-match` is the closest to `pip`'s behavior, it exposes users to the risk of
"dependency confusion" attacks. "dependency confusion" attacks.
In the future, uv will support pinning packages to dedicated indexes (see: [#171](https://github.com/astral-sh/uv/issues/171)). In the future, uv will support pinning packages to dedicated indexes (see: [#171](https://github.com/astral-sh/uv/issues/171)).