Skip to content

Update docs for removed patch restriction. #6663

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

Merged
merged 1 commit into from
Feb 14, 2019
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
2 changes: 2 additions & 0 deletions src/doc/man/cargo-package.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ steps:
will ignore the path key for dependencies in published packages.
. Create the compressed `.crate` file.
- The original `Cargo.toml` file is rewritten and normalized.
- `[patch]`, `[replace]`, and `[workspace]` sections are removed from the
manifest.
- A `.cargo_vcs_info.json` file is included that contains information
about the current VCS checkout hash if available (not included with
`--allow-dirty`).
Expand Down
4 changes: 4 additions & 0 deletions src/doc/man/generated/cargo-package.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ <h2 id="cargo_package_description">DESCRIPTION</h2>
<p>The original <code>Cargo.toml</code> file is rewritten and normalized.</p>
</li>
<li>
<p><code>[patch]</code>, <code>[replace]</code>, and <code>[workspace]</code> sections are removed from the
manifest.</p>
</li>
<li>
<p>A <code>.cargo_vcs_info.json</code> file is included that contains information
about the current VCS checkout hash if available (not included with
<code>--allow-dirty</code>).</p>
Expand Down
3 changes: 0 additions & 3 deletions src/doc/man/generated/cargo-publish.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,6 @@ <h2 id="cargo_publish_description">DESCRIPTION</h2>
<div class="ulist">
<ul>
<li>
<p>No <code>[patch]</code> sections are allowed in the manifest.</p>
</li>
<li>
<p>Checks the <code>package.publish</code> key in the manifest for restrictions on which
registries you are allowed to publish to.</p>
</li>
Expand Down
16 changes: 14 additions & 2 deletions src/etc/man/cargo-package.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: cargo-package
.\" Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 1.5.8
.\" Date: 2019-01-14
.\" Date: 2019-02-13
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "CARGO\-PACKAGE" "1" "2019-01-14" "\ \&" "\ \&"
.TH "CARGO\-PACKAGE" "1" "2019-02-13" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
Expand Down Expand Up @@ -91,6 +91,18 @@ The original \fBCargo.toml\fP file is rewritten and normalized.
. sp -1
. IP \(bu 2.3
.\}
\fB[patch]\fP, \fB[replace]\fP, and \fB[workspace]\fP sections are removed from the
manifest.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
. sp -1
. IP \(bu 2.3
.\}
A \fB.cargo_vcs_info.json\fP file is included that contains information
about the current VCS checkout hash if available (not included with
\fB\-\-allow\-dirty\fP).
Expand Down
15 changes: 2 additions & 13 deletions src/etc/man/cargo-publish.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: cargo-publish
.\" Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 1.5.8
.\" Date: 2019-02-05
.\" Date: 2019-02-13
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "CARGO\-PUBLISH" "1" "2019-02-05" "\ \&" "\ \&"
.TH "CARGO\-PUBLISH" "1" "2019-02-13" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
Expand Down Expand Up @@ -59,17 +59,6 @@ Performs a few checks, including:
. sp -1
. IP \(bu 2.3
.\}
No \fB[patch]\fP sections are allowed in the manifest.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
. sp -1
. IP \(bu 2.3
.\}
Checks the \fBpackage.publish\fP key in the manifest for restrictions on which
registries you are allowed to publish to.
.RE
Expand Down