Skip to content

Commit

Permalink
docs: Clarify vendored sources as read-only and way to modify
Browse files Browse the repository at this point in the history
  • Loading branch information
LuuuXXX committed Mar 1, 2024
1 parent 3bb0697 commit 14190ed
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/doc/man/cargo-vendor.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated_txt/cargo-vendor.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ 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
Expand Down
6 changes: 6 additions & 0 deletions src/doc/src/commands/cargo-vendor.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions src/etc/man/cargo-vendor.1
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ 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.
.br
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
Expand Down

0 comments on commit 14190ed

Please sign in to comment.