Skip to content

Commit

Permalink
Add doc warning about make_exec.
Browse files Browse the repository at this point in the history
Closes #62
  • Loading branch information
mkeeter authored Oct 11, 2022
1 parent 64cf17d commit 7705bdd
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1006,6 +1006,12 @@ impl MmapMut {
///
/// If the memory map is file-backed, the file must have been opened with execute permissions.
///
/// On systems with separate instructions and data caches (a category that includes many ARM
/// chips), a platform-specific call may be needed to ensure that the changes are visible to the
/// execution unit (e.g. when using this function to implement a JIT compiler). For more
/// details, see [this ARM write-up](https://community.arm.com/arm-community-blogs/b/architectures-and-processors-blog/posts/caches-and-self-modifying-code)
/// or the `man` page for [`sys_icache_invalidate`](https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/sys_icache_invalidate.3.html).
///
/// # Errors
///
/// This method returns an error when the underlying system call fails, which can happen for a
Expand Down

0 comments on commit 7705bdd

Please sign in to comment.