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

Improve the `uv lock` CLI documentation (#5932)

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
Show Stats 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), Sync(SyncArgs),
/// Update the project's lockfile (experimental). /// 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( #[command(
after_help = "Use `uv help lock` for more details.", after_help = "Use `uv help lock` for more details.",
after_long_help = "" after_long_help = ""
@ -2257,6 +2264,9 @@ pub struct SyncArgs {
#[allow(clippy::struct_excessive_bools)] #[allow(clippy::struct_excessive_bools)]
pub struct LockArgs { pub struct LockArgs {
/// Assert that the `uv.lock` will remain unchanged. /// 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")] #[arg(long, conflicts_with = "frozen")]
pub locked: bool, pub locked: bool,

10
docs/reference/cli.md
View File

@ -1262,7 +1262,11 @@ uv sync [OPTIONS]
## uv lock ## uv lock
Update the project's lockfile (experimental) 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.
<h3 class="cli-reference">Usage</h3> <h3 class="cli-reference">Usage</h3>
@ -1363,7 +1367,9 @@ uv lock [OPTIONS]
<li><code>symlink</code>: Symbolically link packages from the wheel into the <code>site-packages</code> directory</li> <li><code>symlink</code>: Symbolically link packages from the wheel into the <code>site-packages</code> directory</li>
</ul> </ul>
</dd><dt><code>--locked</code></dt><dd><p>Assert that the <code>uv.lock</code> will remain unchanged</p> </dd><dt><code>--locked</code></dt><dd><p>Assert that the <code>uv.lock</code> will remain unchanged.</p>
<p>Requires that the lockfile is up-to-date. If the lockfile is missing or needs to be updated, uv will exit with an error.</p>
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform&#8217;s native certificate store.</p> </dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform&#8217;s native certificate store.</p>