Skip to content

Commit

Permalink
Try to make it a little clearer that cargo package/publish will rebui…
Browse files Browse the repository at this point in the history
…ld from scratch.

Closes #3062
  • Loading branch information
ehuss committed Dec 19, 2019
1 parent 18e02da commit caf88f5
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 2 deletions.
3 changes: 3 additions & 0 deletions src/doc/man/cargo-package.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ steps:
about the current VCS checkout hash if available (not included with
`--allow-dirty`).
. Extract the `.crate` file and build it to verify it can build.
- This will rebuild your package from scratch to ensure that it can be
built from a pristine state. The `--no-verify` flag can be used to skip
this step.
. Check that build scripts did not modify any source files.

The list of files included can be controlled with the `include` and `exclude`
Expand Down
9 changes: 9 additions & 0 deletions src/doc/man/generated/cargo-package.html
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,15 @@ <h2 id="cargo_package_description">DESCRIPTION</h2>
</li>
<li>
<p>Extract the <code>.crate</code> file and build it to verify it can build.</p>
<div class="ulist">
<ul>
<li>
<p>This will rebuild your package from scratch to ensure that it can be
built from a pristine state. The <code>--no-verify</code> flag can be used to skip
this step.</p>
</li>
</ul>
</div>
</li>
<li>
<p>Check that build scripts did not modify any source files.</p>
Expand Down
17 changes: 15 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 2.0.10
.\" Date: 2019-11-21
.\" Date: 2019-12-19
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "CARGO\-PACKAGE" "1" "2019-11-21" "\ \&" "\ \&"
.TH "CARGO\-PACKAGE" "1" "2019-12-19" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
Expand Down Expand Up @@ -132,6 +132,19 @@ about the current VCS checkout hash if available (not included with
. IP " 3." 4.2
.\}
Extract the \fB.crate\fP file and build it to verify it can build.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
. sp -1
. IP \(bu 2.3
.\}
This will rebuild your package from scratch to ensure that it can be
built from a pristine state. The \fB\-\-no\-verify\fP flag can be used to skip
this step.
.RE
.RE
.sp
.RS 4
Expand Down

0 comments on commit caf88f5

Please sign in to comment.