From 5c57a95c54bcf143d9dfff81165127f373209617 Mon Sep 17 00:00:00 2001 From: Aditya-PS-05 Date: Thu, 12 Sep 2024 19:27:00 +0530 Subject: [PATCH] fix/7315-build-constraint-typo --- CHANGELOG.md | 2 +- crates/uv-cli/src/lib.rs | 2 +- docs/concepts/projects.md | 4 ++-- docs/reference/cli.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0a1d7dd22367..15eeb68b9453 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,7 +22,7 @@ ### Enhancements -- Accept `--build-constraints` in `uv build` ([#7085](https://github.com/astral-sh/uv/pull/7085)) +- Accept `--build-constraint` in `uv build` ([#7085](https://github.com/astral-sh/uv/pull/7085)) - Add `--require-hashes` and `--verify-hashes` to `uv build` ([#7094](https://github.com/astral-sh/uv/pull/7094)) - Add `--show-version-specifiers` to `uv tool list` ([#7050](https://github.com/astral-sh/uv/pull/7050)) - Respect hashes in constraints files ([#7093](https://github.com/astral-sh/uv/pull/7093)) diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index c6e9d3e429c2..bd5df9cb8690 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -1991,7 +1991,7 @@ pub struct BuildArgs { /// Require a matching hash for each build requirement. /// /// Hash-checking mode is all or nothing. If enabled, _all_ build requirements must be provided - /// with a corresponding hash or set of hashes via the `--build-constraints` argument. + /// with a corresponding hash or set of hashes via the `--build-constraint` argument. /// Additionally, if enabled, _all_ requirements must either be pinned to exact versions /// (e.g., `==1.0.0`), or be specified via direct URL. /// diff --git a/docs/concepts/projects.md b/docs/concepts/projects.md index 16063d97f2b7..3697e018511a 100644 --- a/docs/concepts/projects.md +++ b/docs/concepts/projects.md @@ -585,7 +585,7 @@ You can limit `uv build` to building a source distribution with `uv build --sdis distribution with `uv build --wheel`, or build both distributions from source with `uv build --sdist --wheel`. -`uv build` accepts `--build-constraints`, which can be used to constrain the versions of any build +`uv build` accepts `--build-constraint`, which can be used to constrain the versions of any build requirements during the build process. When coupled with `--require-hashes`, uv will enforce that the requirement used to build the project match specific, known hashes, for reproducibility. @@ -599,7 +599,7 @@ Running the following would build the project with the specified version of `set that the downloaded `setuptools` distribution matches the specified hash: ```console -$ uv build --build-constraints constraints.txt --require-hashes +$ uv build --build-constraint constraints.txt --require-hashes ``` ## Build isolation diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 3aeef064e7ae..c395bb96893b 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -6450,7 +6450,7 @@ uv build [OPTIONS] [SRC]
--require-hashes

Require a matching hash for each build requirement.

-

Hash-checking mode is all or nothing. If enabled, all build requirements must be provided with a corresponding hash or set of hashes via the --build-constraints argument. Additionally, if enabled, all requirements must either be pinned to exact versions (e.g., ==1.0.0), or be specified via direct URL.

+

Hash-checking mode is all or nothing. If enabled, all build requirements must be provided with a corresponding hash or set of hashes via the --build-constraint argument. Additionally, if enabled, all requirements must either be pinned to exact versions (e.g., ==1.0.0), or be specified via direct URL.

Hash-checking mode introduces a number of additional constraints: