Skip to content

Commit 74e5421

Browse files
committed
Auto merge of #4272 - behnam:doc, r=alexcrichton
[doc/crates-io] Add text about packaging tests/benches Fixes <#4262>
2 parents 1566c92 + da96699 commit 74e5421

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

src/doc/crates-io.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,15 @@ are there for the build to succeed. This behavior can be disabled with the
4949
`--no-verify` flag.
5050

5151
Now’s a good time to take a look at the `*.crate` file to make sure you didn’t
52-
accidentally package up that 2GB video asset. There is currently a 10MB upload
53-
size limit on `*.crate` files. Cargo will automatically ignore files ignored by
54-
your version control system when packaging, but if you want to specify an extra
55-
set of files to ignore you can use the `exclude` key in the manifest:
52+
accidentally package up that 2GB video asset, or large data files used for code
53+
generation, integration tests, or benchmarking. There is currently a 10MB
54+
upload size limit on `*.crate` files. So, if the size of `tests` and `benches`
55+
directories and their dependencies are up to a couple of MBs, you can keep them
56+
in your package; otherwsie, better to exclude them.
57+
58+
Cargo will automatically ignore files ignored by your version control system
59+
when packaging, but if you want to specify an extra set of files to ignore you
60+
can use the `exclude` key in the manifest:
5661

5762
```toml
5863
[package]
@@ -66,7 +71,7 @@ exclude = [
6671
The syntax of each element in this array is what
6772
[rust-lang/glob](https://github.com/rust-lang/glob) accepts. If you’d rather
6873
roll with a whitelist instead of a blacklist, Cargo also supports an `include`
69-
key:
74+
key, which if set, overrides the `exclude` key:
7075

7176
```toml
7277
[package]

0 commit comments

Comments
 (0)