Skip to content

Commit d6ff4d4

Browse files
committed
Auto merge of #6663 - ehuss:patch-doc, r=dwijnand
Update docs for removed `patch` restriction. The html/man pages need to be rebuilt after changes in #6535. I also included a minor clarification about sections that are removed when a package is published.
2 parents 6022bbb + 543179e commit d6ff4d4

File tree

5 files changed

+22
-18
lines changed

5 files changed

+22
-18
lines changed

src/doc/man/cargo-package.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ steps:
2323
will ignore the path key for dependencies in published packages.
2424
. Create the compressed `.crate` file.
2525
- The original `Cargo.toml` file is rewritten and normalized.
26+
- `[patch]`, `[replace]`, and `[workspace]` sections are removed from the
27+
manifest.
2628
- A `.cargo_vcs_info.json` file is included that contains information
2729
about the current VCS checkout hash if available (not included with
2830
`--allow-dirty`).

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

+4
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ <h2 id="cargo_package_description">DESCRIPTION</h2>
4040
<p>The original <code>Cargo.toml</code> file is rewritten and normalized.</p>
4141
</li>
4242
<li>
43+
<p><code>[patch]</code>, <code>[replace]</code>, and <code>[workspace]</code> sections are removed from the
44+
manifest.</p>
45+
</li>
46+
<li>
4347
<p>A <code>.cargo_vcs_info.json</code> file is included that contains information
4448
about the current VCS checkout hash if available (not included with
4549
<code>--allow-dirty</code>).</p>

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

-3
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,6 @@ <h2 id="cargo_publish_description">DESCRIPTION</h2>
2626
<div class="ulist">
2727
<ul>
2828
<li>
29-
<p>No <code>[patch]</code> sections are allowed in the manifest.</p>
30-
</li>
31-
<li>
3229
<p>Checks the <code>package.publish</code> key in the manifest for restrictions on which
3330
registries you are allowed to publish to.</p>
3431
</li>

src/etc/man/cargo-package.1

+14-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: cargo-package
33
.\" Author: [see the "AUTHOR(S)" section]
44
.\" Generator: Asciidoctor 1.5.8
5-
.\" Date: 2019-01-14
5+
.\" Date: 2019-02-13
66
.\" Manual: \ \&
77
.\" Source: \ \&
88
.\" Language: English
99
.\"
10-
.TH "CARGO\-PACKAGE" "1" "2019-01-14" "\ \&" "\ \&"
10+
.TH "CARGO\-PACKAGE" "1" "2019-02-13" "\ \&" "\ \&"
1111
.ie \n(.g .ds Aq \(aq
1212
.el .ds Aq '
1313
.ss \n[.ss] 0
@@ -91,6 +91,18 @@ The original \fBCargo.toml\fP file is rewritten and normalized.
9191
. sp -1
9292
. IP \(bu 2.3
9393
.\}
94+
\fB[patch]\fP, \fB[replace]\fP, and \fB[workspace]\fP sections are removed from the
95+
manifest.
96+
.RE
97+
.sp
98+
.RS 4
99+
.ie n \{\
100+
\h'-04'\(bu\h'+03'\c
101+
.\}
102+
.el \{\
103+
. sp -1
104+
. IP \(bu 2.3
105+
.\}
94106
A \fB.cargo_vcs_info.json\fP file is included that contains information
95107
about the current VCS checkout hash if available (not included with
96108
\fB\-\-allow\-dirty\fP).

src/etc/man/cargo-publish.1

+2-13
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: cargo-publish
33
.\" Author: [see the "AUTHOR(S)" section]
44
.\" Generator: Asciidoctor 1.5.8
5-
.\" Date: 2019-02-05
5+
.\" Date: 2019-02-13
66
.\" Manual: \ \&
77
.\" Source: \ \&
88
.\" Language: English
99
.\"
10-
.TH "CARGO\-PUBLISH" "1" "2019-02-05" "\ \&" "\ \&"
10+
.TH "CARGO\-PUBLISH" "1" "2019-02-13" "\ \&" "\ \&"
1111
.ie \n(.g .ds Aq \(aq
1212
.el .ds Aq '
1313
.ss \n[.ss] 0
@@ -59,17 +59,6 @@ Performs a few checks, including:
5959
. sp -1
6060
. IP \(bu 2.3
6161
.\}
62-
No \fB[patch]\fP sections are allowed in the manifest.
63-
.RE
64-
.sp
65-
.RS 4
66-
.ie n \{\
67-
\h'-04'\(bu\h'+03'\c
68-
.\}
69-
.el \{\
70-
. sp -1
71-
. IP \(bu 2.3
72-
.\}
7362
Checks the \fBpackage.publish\fP key in the manifest for restrictions on which
7463
registries you are allowed to publish to.
7564
.RE

0 commit comments

Comments
 (0)