Skip to content

Commit 329383a

Browse files
committed
Auto merge of #1176 - RalfJung:readme, r=oli-obk
update Readme
2 parents daaf9f7 + e449dcc commit 329383a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ for example:
1414
* Not sufficiently aligned memory accesses and references
1515
* Violation of *some* basic type invariants (a `bool` that is not 0 or 1, for example,
1616
or an invalid enum discriminant)
17-
* WIP: Violations of the rules governing aliasing for reference types
17+
* **Experimental**: Violations of the rules governing aliasing for reference types
1818

1919
Miri has already discovered some [real-world bugs](#bugs-found-by-miri). If you
2020
found a bug with Miri, we'd appreciate if you tell us and we'll add it to the
2121
list!
2222

23-
Be aware that Miri will not catch all cases of undefined behavior in your
23+
Be aware that Miri will **not catch all cases of undefined behavior** in your
2424
program, and cannot run all programs:
2525

2626
* There are still plenty of open questions around the basic invariants for some
@@ -147,8 +147,8 @@ Several `-Z` flags are relevant for Miri:
147147

148148
* `-Zmiri-seed=<hex>` is a custom `-Z` flag added by Miri. It configures the
149149
seed of the RNG that Miri uses to resolve non-determinism. This RNG is used
150-
to pick base addresses for allocations, and when the interpreted program
151-
requests system entropy. The default seed is 0.
150+
to pick base addresses for allocations. When isolation is enabled (the default),
151+
this is also used to emulate system entropy. The default seed is 0.
152152
**NOTE**: This entropy is not good enough for cryptographic use! Do not
153153
generate secret keys in Miri or perform other kinds of cryptographic
154154
operations that rely on proper random numbers.
@@ -157,8 +157,8 @@ Several `-Z` flags are relevant for Miri:
157157
useful for debugging. It means Miri will miss bugs in your program. However,
158158
this can also help to make Miri run faster.
159159
* `-Zmiri-disable-isolation` disables host host isolation. As a consequence,
160-
the program has access to host resources such as environment variables and
161-
randomness (and, eventually, file systems and more).
160+
the program has access to host resources such as environment variables, file
161+
systems, and randomness.
162162
* `-Zmiri-ignore-leaks` disables the memory leak checker.
163163
* `-Zmiri-env-exclude=<var>` keeps the `var` environment variable isolated from
164164
the host. Can be used multiple times to exclude several variables. The `TERM`

0 commit comments

Comments
 (0)