mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

tweak docs

Browse Source
This commit is contained in:
Ralf Jung 2022-10-26 09:58:21 +02:00 committed by GitHub
parent d86bbd5094
commit 71e6815885
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/tools/miri/README.md
View File

@ -538,7 +538,9 @@ extern "Rust" {
fn miri_start_panic(payload: *mut u8) -> !; fn miri_start_panic(payload: *mut u8) -> !;
/// Miri-provided extern function to get the internal unique identifier for the allocation that a pointer /// 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. /// 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 /// This function should be considered unstable. It exists only to support `miri_print_borrow_stacks` and so
/// inherits all of its instability. /// 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 /// 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 /// 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 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 /// 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. /// change, or it may be removed entirely.
fn miri_print_borrow_stacks(alloc_id: u64); fn miri_print_borrow_stacks(alloc_id: u64);