Skip to content

Commit

Permalink
Auto merge of #4971 - ehuss:overflow-checks-doc, r=alexcrichton
Browse files Browse the repository at this point in the history
Add overflow-checks to reference documentation.

Fixes #4925.
  • Loading branch information
bors committed Jan 24, 2018
2 parents 231660a + c4d4012 commit 26c5996
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions src/doc/src/reference/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,8 @@ codegen-units = 1 # if > 1 enables parallel code generation which improves
# Passes `-C codegen-units`. Ignored when `lto = true`.
panic = 'unwind' # panic strategy (`-C panic=...`), can also be 'abort'
incremental = true # whether or not incremental compilation is enabled
overflow-checks = true # use overflow checks for integer arithmetic.
# Passes the `-C overflow-checks=...` flag to the compiler.

# The release profile, used for `cargo build --release`.
[profile.release]
Expand All @@ -313,6 +315,7 @@ debug-assertions = false
codegen-units = 1
panic = 'unwind'
incremental = false
overflow-checks = false

# The testing profile, used for `cargo test`.
[profile.test]
Expand All @@ -324,6 +327,7 @@ debug-assertions = true
codegen-units = 1
panic = 'unwind'
incremental = true
overflow-checks = true

# The benchmarking profile, used for `cargo bench` and `cargo test --release`.
[profile.bench]
Expand All @@ -335,6 +339,7 @@ debug-assertions = false
codegen-units = 1
panic = 'unwind'
incremental = false
overflow-checks = false

# The documentation profile, used for `cargo doc`.
[profile.doc]
Expand All @@ -346,6 +351,7 @@ debug-assertions = true
codegen-units = 1
panic = 'unwind'
incremental = true
overflow-checks = true
```

### The `[features]` section
Expand Down Expand Up @@ -613,8 +619,8 @@ compiled when you run your tests to protect them from bitrotting.
You can run individual executable examples with the command `cargo run --example
<example-name>`.

Specify `crate-type` to make an example be compiled as a library (additional
information about crate types is available in
Specify `crate-type` to make an example be compiled as a library (additional
information about crate types is available in
[the Cargo reference](https://doc.rust-lang.org/reference/linkage.html)):

```toml
Expand Down

0 comments on commit 26c5996

Please sign in to comment.