Skip to content

Commit 915769f

Browse files
committed
docs: Clarify vendored sources as read-only and way to modify
1 parent 3bb0697 commit 915769f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/doc/man/cargo-vendor.md

+5
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ stdout after `cargo vendor` completes the vendoring process.
2121
You will need to add or redirect it to your Cargo configuration file,
2222
which is usually `.cargo/config.toml` locally for the current package.
2323

24+
By default, Cargo treats vendored crates as read-only as it does crates.io.
25+
To modify a vendored crate the correct way is to use `[patch]` or a `path` dependency,
26+
and Cargo will then correctly handle the crate on incremental rebuilds as it knowns
27+
that it is not a read-only dependency.
28+
2429
## OPTIONS
2530

2631
### Vendor Options

0 commit comments

Comments
 (0)