Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify config to use vendored source is printed to stdout #12893

Merged
merged 1 commit into from
Oct 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/doc/man/cargo-vendor.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ the vendor directory specified by `<path>` will contain all remote sources from
dependencies specified. Additional manifests beyond the default one can be
specified with the `-s` option.

The `cargo vendor` command will also print out the configuration necessary
to use the vendored sources, which you will need to add to `.cargo/config.toml`.
The configuration necessary to use the vendored sources would be printed to
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.

## OPTIONS

Expand Down Expand Up @@ -88,6 +90,10 @@ only a subset of the packages have changed.

cargo vendor -s ../path/to/Cargo.toml

4. Vendor and redirect the necessary vendor configs to a config file.

cargo vendor > path/to/my/cargo/config.toml

## SEE ALSO
{{man "cargo" 1}}

11 changes: 8 additions & 3 deletions src/doc/man/generated_txt/cargo-vendor.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@ DESCRIPTION
remote sources from dependencies specified. Additional manifests beyond
the default one can be specified with the -s option.

The cargo vendor command will also print out the configuration necessary
to use the vendored sources, which you will need to add to
.cargo/config.toml.
The configuration necessary to use the vendored sources would be printed
to 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.

OPTIONS
Vendor Options
Expand Down Expand Up @@ -157,6 +158,10 @@ EXAMPLES

cargo vendor -s ../path/to/Cargo.toml

4. Vendor and redirect the necessary vendor configs to a config file.

cargo vendor > path/to/my/cargo/config.toml

SEE ALSO
cargo(1)

10 changes: 8 additions & 2 deletions src/doc/src/commands/cargo-vendor.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ the vendor directory specified by `<path>` will contain all remote sources from
dependencies specified. Additional manifests beyond the default one can be
specified with the `-s` option.

The `cargo vendor` command will also print out the configuration necessary
to use the vendored sources, which you will need to add to `.cargo/config.toml`.
The configuration necessary to use the vendored sources would be printed to
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.

## OPTIONS

Expand Down Expand Up @@ -189,6 +191,10 @@ details on environment variables that Cargo reads.

cargo vendor -s ../path/to/Cargo.toml

4. Vendor and redirect the necessary vendor configs to a config file.

cargo vendor > path/to/my/cargo/config.toml

## SEE ALSO
[cargo(1)](cargo.html)

16 changes: 14 additions & 2 deletions src/etc/man/cargo-vendor.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ the vendor directory specified by \fB<path>\fR will contain all remote sources f
dependencies specified. Additional manifests beyond the default one can be
specified with the \fB\-s\fR option.
.sp
The \fBcargo vendor\fR command will also print out the configuration necessary
to use the vendored sources, which you will need to add to \fB\&.cargo/config.toml\fR\&.
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.
.SH "OPTIONS"
.SS "Vendor Options"
.sp
Expand Down Expand Up @@ -205,5 +207,15 @@ cargo vendor \-s ../path/to/Cargo.toml
.fi
.RE
.RE
.sp
.RS 4
\h'-04' 4.\h'+01'Vendor and redirect the necessary vendor configs to a config file.
.sp
.RS 4
.nf
cargo vendor > path/to/my/cargo/config.toml
.fi
.RE
.RE
.SH "SEE ALSO"
\fBcargo\fR(1)