Skip to content

Commit 75da07b

Browse files
committed
link to a definition of soundness
1 parent d537a7a commit 75da07b

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/tools/miri/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ behavior** in your program, and cannot run all programs:
7474
unobservable by compiled programs running on real hardware when `SeqCst` fences are used, and it
7575
cannot produce all behaviors possibly observable on real hardware.
7676

77-
Moreover, Miri fundamentally cannot tell you whether your code is *sound*. Soundness is the property
77+
Moreover, Miri fundamentally cannot tell you whether your code is *sound*. [Soundness] is the property
7878
of never causing undefined behavior when invoked from arbitrary safe code, even in combination with
7979
other sound code. In contrast, Miri can just tell you if *a particular way of interacting with your
8080
code* (e.g., a test suite) causes any undefined behavior. It is up to you to ensure sufficient
@@ -86,6 +86,7 @@ coverage.
8686
[`copy_nonoverlapping`]: https://doc.rust-lang.org/stable/std/ptr/fn.copy_nonoverlapping.html
8787
[Stacked Borrows]: https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md
8888
[Tree Borrows]: https://perso.crans.org/vanille/treebor/
89+
[Soundness]: https://rust-lang.github.io/unsafe-code-guidelines/glossary.html#soundness-of-code--of-a-library
8990

9091

9192
## Using Miri

0 commit comments

Comments
 (0)