Skip to content

Commit 2214cf1

Browse files
committed
Document --version-dirs in cargo-vendor.adoc and re-generate all doc formats.
1 parent fd80795 commit 2214cf1

File tree

3 files changed

+28
-12
lines changed

3 files changed

+28
-12
lines changed

src/doc/man/cargo-vendor.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,13 @@ to use the vendored sources, which you will need to add to `.cargo/config`.
3838
Instead of ignoring `[source]` configuration by default in `.cargo/config`
3939
read it and use it when downloading crates from crates.io, for example
4040

41+
*--versioned-dirs*::
42+
Normally versions are only added to disambiguate multiple versions of the
43+
same package. This option causes all directories in the "vendor" directory
44+
to be versioned, which makes it easier to track the history of vendored
45+
packages over time, and can help with the performance of re-vendoring when
46+
only a subset of the packages have changed.
47+
4148
=== Manifest Options
4249

4350
include::options-manifest-path.adoc[]

src/doc/man/generated/cargo-vendor.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,14 @@ <h3 id="cargo_vendor_owner_options">Owner Options</h3>
4949
<p>Instead of ignoring <code>[source]</code> configuration by default in <code>.cargo/config</code>
5050
read it and use it when downloading crates from crates.io, for example</p>
5151
</dd>
52+
<dt class="hdlist1"><strong>--versioned-dirs</strong></dt>
53+
<dd>
54+
<p>Normally versions are only added to disambiguate multiple versions of the
55+
same package. This option causes all directories in the "vendor" directory
56+
to be versioned, which makes it easier to track the history of vendored
57+
packages over time, and can help with the performance of re-vendoring when
58+
only a subset of the packages have changed.</p>
59+
</dd>
5260
</dl>
5361
</div>
5462
</div>

src/etc/man/cargo-vendor.1

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: cargo-vendor
33
.\" Author: [see the "AUTHOR(S)" section]
44
.\" Generator: Asciidoctor 2.0.10
5-
.\" Date: 2019-09-08
5+
.\" Date: 2019-12-09
66
.\" Manual: \ \&
77
.\" Source: \ \&
88
.\" Language: English
99
.\"
10-
.TH "CARGO\-VENDOR" "1" "2019-09-08" "\ \&" "\ \&"
10+
.TH "CARGO\-VENDOR" "1" "2019-12-09" "\ \&" "\ \&"
1111
.ie \n(.g .ds Aq \(aq
1212
.el .ds Aq '
1313
.ss \n[.ss] 0
@@ -54,21 +54,22 @@ vendored and synced to the output.
5454
\fB\-\-no\-delete\fP
5555
.RS 4
5656
Don\(cqt delete the "vendor" directory when vendoring, but rather keep all
57-
existing contents of the vendor directory.
57+
existing contents of the vendor directory
5858
.RE
5959
.sp
60-
\fB\-\-versioned\-dirs\fP
60+
\fB\-\-respect\-source\-config\fP
6161
.RS 4
62-
Normally versions are only added to disambiguate multiple versions of the same package.
63-
This option causes all directories in the "vendor" directory to be versioned,
64-
which makes it easier to track the history of vendored packages over time, and can help
65-
with the performance of re-vendoring when only a subset of the packages have changed.
62+
Instead of ignoring \fB[source]\fP configuration by default in \fB.cargo/config\fP
63+
read it and use it when downloading crates from crates.io, for example
6664
.RE
6765
.sp
68-
\fB\-\-respect\-source\-config\fP
66+
\fB\-\-versioned\-dirs\fP
6967
.RS 4
70-
Instead of ignoring \fB[source]\fP configuration by default in \fB.cargo/config\fP
71-
read it and use it when downloading crates from crates.io, for example.
68+
Normally versions are only added to disambiguate multiple versions of the
69+
same package. This option causes all directories in the "vendor" directory
70+
to be versioned, which makes it easier to track the history of vendored
71+
packages over time, and can help with the performance of re\-vendoring when
72+
only a subset of the packages have changed.
7273
.RE
7374
.SS "Manifest Options"
7475
.sp
@@ -245,4 +246,4 @@ cargo vendor \-s ../path/to/Cargo.toml
245246
.RE
246247
.SH "SEE ALSO"
247248
.sp
248-
\fBcargo\fP(1)
249+
\fBcargo\fP(1)

0 commit comments

Comments
 (0)