Skip to content

Commit

Permalink
mention new option in README and diagnostics
Browse files Browse the repository at this point in the history
  • Loading branch information
RalfJung committed Apr 13, 2020
1 parent fd8beaf commit 0ad1114
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,8 @@ Several `-Z` flags are relevant for Miri:
* `-Zmiri-disable-stacked-borrows` disables checking the experimental
[Stacked Borrows] aliasing rules. This can make Miri run faster, but it also
means no aliasing violations will be detected.
* `-Zmiri-disable-alignment-check` disables checking pointer alignment on memory
accesses.
* `-Zmiri-disable-isolation` disables host isolation. As a consequence,
the program has access to host resources such as environment variables, file
systems, and randomness.
Expand Down
1 change: 1 addition & 0 deletions src/diagnostics.rs
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ pub fn report_error<'tcx, 'mir>(
vec![
format!("this usually indicates that your program performed an invalid operation and caused Undefined Behavior"),
format!("but alignment errors can also be false positives, see https://github.com/rust-lang/miri/issues/1074"),
format!("you can disable the alignment check with `-Zmiri-disable-alignment-check`, but that could hide true bugs")
],
UndefinedBehavior(_) =>
vec![
Expand Down

0 comments on commit 0ad1114

Please sign in to comment.