about summary refs log tree commit diff
path: root/src/tools
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2022-10-26 09:58:21 +0200
committerGitHub <noreply@github.com>2022-10-26 09:58:21 +0200
commit71e6815885f54631a2035e0c4d180a6de25ebccf (patch)
tree9b820af1baa9924d07c0ddbe24816a7acd7866f8 /src/tools
parentd86bbd5094badaf55ade2073fbb41835ffc641b6 (diff)
tweak docs
Diffstat (limited to 'src/tools')
-rw-r--r--src/tools/miri/README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/tools/miri/README.md b/src/tools/miri/README.md
index bd175b46b7a..5803a88c0e7 100644
--- a/src/tools/miri/README.md
+++ b/src/tools/miri/README.md
@@ -538,7 +538,9 @@ extern "Rust" {
     fn miri_start_panic(payload: *mut u8) -> !;
 
     /// Miri-provided extern function to get the internal unique identifier for the allocation that a pointer
-    /// points to. This is only useful as an input to `miri_print_borrow_stacks`, and it is a separate call because
+    /// points to. If this pointer is invalid (not pointing to an allocation), interpretation will abort.
+    ///
+    /// This is only useful as an input to `miri_print_borrow_stacks`, and it is a separate call because
     /// getting a pointer to an allocation at runtime can change the borrow stacks in the allocation.
     /// This function should be considered unstable. It exists only to support `miri_print_borrow_stacks` and so
     /// inherits all of its instability.
@@ -549,6 +551,7 @@ extern "Rust" {
     /// The format of what this emits is unstable and may change at any time. In particular, users should be
     /// aware that Miri will periodically attempt to garbage collect the contents of all stacks. Callers of
     /// this function may wish to pass `-Zmiri-tag-gc=0` to disable the GC.
+    ///
     /// This function is extremely unstable. At any time the format of its output may change, its signature may
     /// change, or it may be removed entirely.
     fn miri_print_borrow_stacks(alloc_id: u64);