Add safety comments for mmap etc.
#1188
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add proper safety comments for `mmap` and related functions. Many of the tricky things around `mmap` are about handing out Rust references to mapped memory, and that technically isn't rustix's responsibility to worry about, so these safety comments can be pretty simple. And, several other miscellaneous documentation and comment cleanups.
sunfishcode
force-pushed
the
sunfishcode/docs
branch
from
eaeae9a
to
d5c916d
Compare
sunfishcode
added a commit
that referenced
this pull request
Oct 27, 2024
* Add safety comments for `mmap` etc. Add proper safety comments for `mmap` and related functions. Many of the tricky things around `mmap` are about handing out Rust references to mapped memory, and that technically isn't rustix's responsibility to worry about, so these safety comments can be pretty simple. And, several other miscellaneous documentation and comment cleanups. * Document the new safety precondition for `split_init`.
sunfishcode
added a commit
that referenced
this pull request
Oct 27, 2024
* Add safety comments for `mmap` etc. Add proper safety comments for `mmap` and related functions. Many of the tricky things around `mmap` are about handing out Rust references to mapped memory, and that technically isn't rustix's responsibility to worry about, so these safety comments can be pretty simple. And, several other miscellaneous documentation and comment cleanups. * Document the new safety precondition for `split_init`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add proper safety comments for
mmapand related functions. Many of the tricky things aroundmmapare about handing out Rust references to mapped memory, and that technically isn't rustix's responsibility to worry about, so these safety comments can be pretty simple.And, several other miscellaneous documentation and comment cleanups.