mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-08-03 18:38:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Improve the uv lock CLI documentation (#5932)

Browse source
This commit is contained in:
Zanie Blue 2024-08-09 08:51:03 -05:00 • committed by GitHub
parent cac1e7bcfc
commit 4330f9718b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 18 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
crates/uv-cli/src/lib.rs
View file

@ -573,6 +573,13 @@ pub enum ProjectCommand {
)]
Sync(SyncArgs),
/// Update the project's lockfile (experimental).
///
/// If the project lockfile (`uv.lock`) does not exist, it will be created.
/// If a lockfile is present, its contents will be used as preferences for
/// the resolution.
///
/// If there are no changes to the project's dependencies, locking will have
/// no effect unless the `--upgrade` flag is provided.
#[command(
after_help = "Use `uv help lock` for more details.",
after_long_help = ""
@ -2257,6 +2264,9 @@ pub struct SyncArgs {
#[allow(clippy::struct_excessive_bools)]
pub struct LockArgs {
/// Assert that the `uv.lock` will remain unchanged.
///
/// Requires that the lockfile is up-to-date. If the lockfile is missing or
/// needs to be updated, uv will exit with an error.
#[arg(long, conflicts_with = "frozen")]
pub locked: bool,