Skip to content

Commit 9013f0a

Browse files
committed
docs: clarify config to use vendored source is printed to stdout
1 parent 04621e2 commit 9013f0a

File tree

4 files changed

+38
-9
lines changed

4 files changed

+38
-9
lines changed

src/doc/man/cargo-vendor.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ the vendor directory specified by `<path>` will contain all remote sources from
1616
dependencies specified. Additional manifests beyond the default one can be
1717
specified with the `-s` option.
1818

19-
The `cargo vendor` command will also print out the configuration necessary
20-
to use the vendored sources, which you will need to add to `.cargo/config.toml`.
19+
The configuration necessary to use the vendored sources would be printed to
20+
stdout after `cargo vendor` completes the vendoring process.
21+
You will need to add or redirect it to your Cargo configuration file,
22+
which is usually `.cargo/config.toml` locally for the current package.
2123

2224
## OPTIONS
2325

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

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

93+
4. Vendor and redirect the necessary vendor configs to a config file.
94+
95+
cargo vendor > path/to/my/cargo/config.toml
96+
9197
## SEE ALSO
9298
{{man "cargo" 1}}
9399

src/doc/man/generated_txt/cargo-vendor.txt

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@ DESCRIPTION
1313
remote sources from dependencies specified. Additional manifests beyond
1414
the default one can be specified with the -s option.
1515

16-
The cargo vendor command will also print out the configuration necessary
17-
to use the vendored sources, which you will need to add to
18-
.cargo/config.toml.
16+
The configuration necessary to use the vendored sources would be printed
17+
to stdout after cargo vendor completes the vendoring process. You will
18+
need to add or redirect it to your Cargo configuration file, which is
19+
usually .cargo/config.toml locally for the current package.
1920

2021
OPTIONS
2122
Vendor Options
@@ -157,6 +158,10 @@ EXAMPLES
157158

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

161+
4. Vendor and redirect the necessary vendor configs to a config file.
162+
163+
cargo vendor > path/to/my/cargo/config.toml
164+
160165
SEE ALSO
161166
cargo(1)
162167

src/doc/src/commands/cargo-vendor.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ the vendor directory specified by `<path>` will contain all remote sources from
1616
dependencies specified. Additional manifests beyond the default one can be
1717
specified with the `-s` option.
1818

19-
The `cargo vendor` command will also print out the configuration necessary
20-
to use the vendored sources, which you will need to add to `.cargo/config.toml`.
19+
The configuration necessary to use the vendored sources would be printed to
20+
stdout after `cargo vendor` completes the vendoring process.
21+
You will need to add or redirect it to your Cargo configuration file,
22+
which is usually `.cargo/config.toml` locally for the current package.
2123

2224
## OPTIONS
2325

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

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

194+
4. Vendor and redirect the necessary vendor configs to a config file.
195+
196+
cargo vendor > path/to/my/cargo/config.toml
197+
192198
## SEE ALSO
193199
[cargo(1)](cargo.html)
194200

src/etc/man/cargo-vendor.1

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ the vendor directory specified by \fB<path>\fR will contain all remote sources f
1414
dependencies specified. Additional manifests beyond the default one can be
1515
specified with the \fB\-s\fR option.
1616
.sp
17-
The \fBcargo vendor\fR command will also print out the configuration necessary
18-
to use the vendored sources, which you will need to add to \fB\&.cargo/config.toml\fR\&.
17+
The configuration necessary to use the vendored sources would be printed to
18+
stdout after \fBcargo vendor\fR completes the vendoring process.
19+
You will need to add or redirect it to your Cargo configuration file,
20+
which is usually \fB\&.cargo/config.toml\fR locally for the current package.
1921
.SH "OPTIONS"
2022
.SS "Vendor Options"
2123
.sp
@@ -205,5 +207,15 @@ cargo vendor \-s ../path/to/Cargo.toml
205207
.fi
206208
.RE
207209
.RE
210+
.sp
211+
.RS 4
212+
\h'-04' 4.\h'+01'Vendor and redirect the necessary vendor configs to a config file.
213+
.sp
214+
.RS 4
215+
.nf
216+
cargo vendor > path/to/my/cargo/config.toml
217+
.fi
218+
.RE
219+
.RE
208220
.SH "SEE ALSO"
209221
\fBcargo\fR(1)

0 commit comments

Comments
 (0)