cargo vendor is not consistent about paths and symbolic links on Windows vs. other platforms #14965
Labels
C-bug
Category: bug
Command-vendor
O-windows
OS: Windows
S-triage
Status: This issue is waiting on initial triage.
Comments
glandium
added
C-bug
github-merge-queue bot
pushed a commit
that referenced
this issue
Dec 31, 2024
### What does this PR try to resolve? This adds a special case for checking source files are symlinks and have been modified when under a VCS control This is required because those paths may link to a file outside the current package root, but still under the git workdir, affecting the final packaged `.crate` file. ### How should we test and review this PR? Pretty similar to #14966, as a part of #14967. This may have potential performance issue. If a package contains thousands of symlinks, Cargo will fire `git status` for each of them. Not sure if we want to do anything proactively now. The introduction of the `PathEntry` struct gives us more room for storing file metadata to satisfiy use cases in the future. For instances, * Knowing a source file is a symlink and resolving it when packaging on Windows * #5664 * #14965 * Knowing more about a file's metadata (e.g. permission bits from Git) * #4413 * #8006 * Provide richer information for `cargo package --list`, for example JSON output mode * #11666 * #13331 * #13953
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Problem
About paths:
when a crate contains paths for e.g. dependencies in a workspace,
cargo vendoruses / on Unices and \ on Windows, changing whatever the original path was.About symbolic links:
when a crate contains symbolic links to another file in a workspace,
cargo vendorexpands the content on Unices and replaces it with the path of the link target on Windows.Steps
cargo new foocd foocargo add libz-rs-syscargo vendorOn Linux or Mac, you end up with a proper
vendor/libz-rs-sys/LICENSEfile, andvendor/libz-rs-sys/Cargo.tomlhasdependencies.zlib-rs.path = "../zlib-rs".On Windows,
vendor/libz-rs-sys/LICENSEliterally contains../LICENSE, andvendor/libz-rs-sys/Cargo.tomlhasdependencies.zlib-rs.path = "..\zlib-rs".Possible Solution(s)
cargo vendor should be consistent, wherever it's run.
Notes
No response
Version
The text was updated successfully, but these errors were encountered: