Skip to content

Documentation PR for cfg_panic #1157

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.

Sign up for GitHub

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
ehuss merged 10 commits into from
Mar 15, 2022
Merged

Documentation PR for cfg_panic #1157

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4b536a6
added documentation for cfg_panic
chiw-goog Feb 4, 2022
976ce29
Update testing.md
cchiw Feb 4, 2022
031945b
Update testing.md
cchiw Feb 4, 2022
0cc85c7
Update testing.md
cchiw Feb 4, 2022
7ab0aa0
Update testing.md
cchiw Feb 4, 2022
3e2faa1
Update testing.md
cchiw Feb 7, 2022
09eadce
Update src/attributes/testing.md
cchiw Feb 7, 2022
14bb695
Added cfg panic to conditional-compilation section
cchiw Mar 14, 2022
464866f
Add files via upload
cchiw Mar 14, 2022
267f815
Add files via upload
cchiw Mar 14, 2022
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
4 changes: 4 additions & 0 deletions src/attributes/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ fn mytest() {

The `cfg_panic` feature makes it possible to exercise different lines of code depending on the panic strategy.
The possible value is either `unwind` or `abort`.
Copy link
Member

@bjorn3 bjorn3 Feb 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this say make clear that code compiled with #[cfg(panic = "unwind")] being true may still aborting on panic if any crate is compiled with -Cpanic=abort?

Copy link
Contributor Author

@cchiw cchiw Feb 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good thing to point out. Note, I'm not as familiar with crates so i don't know too much about this but I'll take your word for it.

I updated the file, let me know what you think :)


The following is a playful example on choosing the right beverage.

```rust
Expand Down Expand Up @@ -124,6 +125,9 @@ fn main() {
}
```

Note that when the code is compiled with a certain panic strategy it still might do something different if a crate was compiled with a different strategy.
For instance, if `#[cfg(panic = "unwind")]` is set to `true` and a crate is compiled with`-C panic=abort`.

[_MetaListNameValueStr_]: ../attributes.md#meta-item-attribute-syntax
[_MetaNameValueStr_]: ../attributes.md#meta-item-attribute-syntax
[`Termination`]: ../../std/process/trait.Termination.html
Expand Down