docs: Clarify vendored sources as read-only and way to modify

This commit is contained in:
LuuuX 2024-03-01 16:39:56 +08:00
parent 3bb069775f
commit 13e72b9e8a
4 changed files with 24 additions and 0 deletions

View file

@ -21,6 +21,12 @@ stdout after `cargo vendor` completes the vendoring process.
You will need to add or redirect it to your Cargo configuration file,
which is usually `.cargo/config.toml` locally for the current package.
Cargo treats vendored sources as read-only as it does to registry and git sources.
If you intend to modify a crate from a remote source,
use `[patch]` or a `path` dependency pointing to a local copy of that crate.
Cargo will then correctly handle the crate on incremental rebuilds,
as it knowns that it is no longer a read-only dependency.
## OPTIONS
### Vendor Options

View file

@ -18,6 +18,12 @@ DESCRIPTION
need to add or redirect it to your Cargo configuration file, which is
usually .cargo/config.toml locally for the current package.
Cargo treats vendored sources as read-only as it does to registry and
git sources. If you intend to modify a crate from a remote source, use
[patch] or a path dependency pointing to a local copy of that crate.
Cargo will then correctly handle the crate on incremental rebuilds, as
it knowns that it is no longer a read-only dependency.
OPTIONS
Vendor Options
-s manifest, --sync manifest

View file

@ -21,6 +21,12 @@ stdout after `cargo vendor` completes the vendoring process.
You will need to add or redirect it to your Cargo configuration file,
which is usually `.cargo/config.toml` locally for the current package.
Cargo treats vendored sources as read-only as it does to registry and git sources.
If you intend to modify a crate from a remote source,
use `[patch]` or a `path` dependency pointing to a local copy of that crate.
Cargo will then correctly handle the crate on incremental rebuilds,
as it knowns that it is no longer a read-only dependency.
## OPTIONS
### Vendor Options

View file

@ -18,6 +18,12 @@ The configuration necessary to use the vendored sources would be printed to
stdout after \fBcargo vendor\fR completes the vendoring process.
You will need to add or redirect it to your Cargo configuration file,
which is usually \fB\&.cargo/config.toml\fR locally for the current package.
.sp
Cargo treats vendored sources as read\-only as it does to registry and git sources.
If you intend to modify a crate from a remote source,
use \fB[patch]\fR or a \fBpath\fR dependency pointing to a local copy of that crate.
Cargo will then correctly handle the crate on incremental rebuilds,
as it knowns that it is no longer a read\-only dependency.
.SH "OPTIONS"
.SS "Vendor Options"
.sp