Skip to content

Commit 0ad1114

Browse files
committed
mention new option in README and diagnostics
1 parent fd8beaf commit 0ad1114

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,8 @@ Several `-Z` flags are relevant for Miri:
176176
* `-Zmiri-disable-stacked-borrows` disables checking the experimental
177177
[Stacked Borrows] aliasing rules. This can make Miri run faster, but it also
178178
means no aliasing violations will be detected.
179+
* `-Zmiri-disable-alignment-check` disables checking pointer alignment on memory
180+
accesses.
179181
* `-Zmiri-disable-isolation` disables host isolation. As a consequence,
180182
the program has access to host resources such as environment variables, file
181183
systems, and randomness.

src/diagnostics.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ pub fn report_error<'tcx, 'mir>(
9797
vec![
9898
format!("this usually indicates that your program performed an invalid operation and caused Undefined Behavior"),
9999
format!("but alignment errors can also be false positives, see https://github.com/rust-lang/miri/issues/1074"),
100+
format!("you can disable the alignment check with `-Zmiri-disable-alignment-check`, but that could hide true bugs")
100101
],
101102
UndefinedBehavior(_) =>
102103
vec![

0 commit comments

Comments
 (0)