about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2023-07-16 15:51:46 +0200
committerRalf Jung <post@ralfj.de>2023-07-16 15:51:46 +0200
commit75da07bf28e64aadbc6f452da4d0cb44e4223b5a (patch)
tree9660eddac08d5359612cbf5c43d86a718cecf425
parentd537a7aaa26b48e723dcea0e1d065690a5632b45 (diff)
downloadrust-75da07bf28e64aadbc6f452da4d0cb44e4223b5a.tar.gz
rust-75da07bf28e64aadbc6f452da4d0cb44e4223b5a.zip
link to a definition of soundness
-rw-r--r--src/tools/miri/README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/tools/miri/README.md b/src/tools/miri/README.md
index d51384d0a14..a965f44a4e6 100644
--- a/src/tools/miri/README.md
+++ b/src/tools/miri/README.md
@@ -74,7 +74,7 @@ behavior** in your program, and cannot run all programs:
   unobservable by compiled programs running on real hardware when `SeqCst` fences are used, and it
   cannot produce all behaviors possibly observable on real hardware.
 
-Moreover, Miri fundamentally cannot tell you whether your code is *sound*. Soundness is the property
+Moreover, Miri fundamentally cannot tell you whether your code is *sound*. [Soundness] is the property
 of never causing undefined behavior when invoked from arbitrary safe code, even in combination with
 other sound code. In contrast, Miri can just tell you if *a particular way of interacting with your
 code* (e.g., a test suite) causes any undefined behavior. It is up to you to ensure sufficient
@@ -86,6 +86,7 @@ coverage.
 [`copy_nonoverlapping`]: https://doc.rust-lang.org/stable/std/ptr/fn.copy_nonoverlapping.html
 [Stacked Borrows]: https://github.com/rust-lang/unsafe-code-guidelines/blob/master/wip/stacked-borrows.md
 [Tree Borrows]: https://perso.crans.org/vanille/treebor/
+[Soundness]: https://rust-lang.github.io/unsafe-code-guidelines/glossary.html#soundness-of-code--of-a-library
 
 
 ## Using Miri