mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-09-30 22:11:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Add warning to --link-mode=symlink documentation (#5387)

Browse source
This commit is contained in:
Charlie Marsh 2024-07-23 18:35:56 -04:00 • committed by GitHub
parent 3822a43560
commit 41b699e7ac
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 21 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

13
crates/install-wheel-rs/src/linker.rs
View file

@ -221,13 +221,18 @@ fn parse_scripts(
#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
pub enum LinkMode {
/// Clone (i.e., copy-on-write) packages from the wheel into the site packages.
/// Clone (i.e., copy-on-write) packages from the wheel into the `site-packages` directory.
Clone,
/// Copy packages from the wheel into the site packages.
/// Copy packages from the wheel into the `site-packages` directory.
Copy,
/// Hard link packages from the wheel into the site packages.
/// Hard link packages from the wheel into the `site-packages` directory.
Hardlink,
/// Symbolically link packages from the wheel into the site packages
/// Symbolically link packages from the wheel into the `site-packages` directory.
///
/// WARNING: The use of symlinks is discouraged, as they create tight coupling between the
/// cache and the target environment. For example, clearing the cache (`uv cache clear`) will
/// break all installed packages by way of removing the underlying source files. Use symlinks
/// with caution.
Symlink,
}

16
docs/settings.md
View file

@ -285,10 +285,10 @@ Windows.
**Possible values**:
- `"clone"`: Clone (i.e., copy-on-write) packages from the wheel into the site packages
- `"copy"`: Copy packages from the wheel into the site packages
- `"hardlink"`: Hard link packages from the wheel into the site packages
- `"symlink"`: Symbolically link packages from the wheel into the site packages
- `"clone"`: Clone (i.e., copy-on-write) packages from the wheel into the `site-packages` directory
- `"copy"`: Copy packages from the wheel into the `site-packages` directory
- `"hardlink"`: Hard link packages from the wheel into the `site-packages` directory
- `"symlink"`: Symbolically link packages from the wheel into the `site-packages` directory
**Example usage**:
@ -1524,10 +1524,10 @@ Windows.
**Possible values**:
- `"clone"`: Clone (i.e., copy-on-write) packages from the wheel into the site packages
- `"copy"`: Copy packages from the wheel into the site packages
- `"hardlink"`: Hard link packages from the wheel into the site packages
- `"symlink"`: Symbolically link packages from the wheel into the site packages
- `"clone"`: Clone (i.e., copy-on-write) packages from the wheel into the `site-packages` directory
- `"copy"`: Copy packages from the wheel into the `site-packages` directory
- `"hardlink"`: Hard link packages from the wheel into the `site-packages` directory
- `"symlink"`: Symbolically link packages from the wheel into the `site-packages` directory
**Example usage**:

8
uv.schema.json generated
View file

@ -444,28 +444,28 @@
"LinkMode": {
"oneOf": [
{
"description": "Clone (i.e., copy-on-write) packages from the wheel into the site packages.",
"description": "Clone (i.e., copy-on-write) packages from the wheel into the `site-packages` directory.",
"type": "string",
"enum": [
"clone"
]
},
{
"description": "Copy packages from the wheel into the site packages.",
"description": "Copy packages from the wheel into the `site-packages` directory.",
"type": "string",
"enum": [
"copy"
]
},
{
"description": "Hard link packages from the wheel into the site packages.",
"description": "Hard link packages from the wheel into the `site-packages` directory.",
"type": "string",
"enum": [
"hardlink"
]
},
{
"description": "Symbolically link packages from the wheel into the site packages",
"description": "Symbolically link packages from the wheel into the `site-packages` directory.\n\nWARNING: The use of symlinks is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (`uv cache clear`) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.",
"type": "string",
"enum": [
"symlink"