docs: Revise notes for example std_global_allocator.rs
#36
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
Group all notes together, revision pass on phrasing.
polarathene
changed the title
std_global_allocator.rsstd_global_allocator.rs
polarathene
commented
Oct 7, 2024
| // note: | ||
| // - Miri thinks this violates stacked borrows upon program termination. | ||
| // - This only occurs with `#[global_allocator]`. | ||
| // - Use the allocator API if you can't have that. Perhaps check out `examples/stable_allocator_api.rs`? |
There was a problem hiding this comment.
Alternative, although it'd be good to know what "if you can't have that" is referring to.
Suggested change
| // - Use the allocator API if you can't have that. Perhaps check out `examples/stable_allocator_api.rs`? | |
| // - Consider using the allocator API if you can't have that (see: `examples/stable_allocator_api.rs`) |
polarathene
commented
Oct 7, 2024
| #[global_allocator] | ||
| static ALLOCATOR: Talck<spin::Mutex<()>, ClaimOnOom> = Talc::new(unsafe { | ||
| ClaimOnOom::new(Span::from_const_array(std::ptr::addr_of!(START_ARENA))) | ||
| }).lock(); | ||
| ClaimOnOom::new(Span::from_const_array(std::ptr::addr_of!(START_ARENA))) |
There was a problem hiding this comment.
Restore no_std compatibility, matches README equivalent:
Suggested change
| ClaimOnOom::new(Span::from_const_array(std::ptr::addr_of!(START_ARENA))) | |
| ClaimOnOom::new(Span::from_const_array(core::ptr::addr_of!(START_ARENA))) |
|
Hey Brennan, thanks for the contribution! Got a packed week but I'll try get around to this within a few days ^_^ |
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.
I noticed a recent commit hoisted the two type comments from their contextual proximity to relevant code, while the
START_ARENAline seems to have no relevance separating the two comment sections. Grouped them together as bullet point notes.The two type focused comments are more explicit about communicating that early now, followed by the description for the choice (it's not really communicated why
spin::Mutexis sensible to the user, but I suppose that's better context than none). Was vaguely touched on here, I could add a link to that for reference if considered helpful?It's not clear what the Miri comment refers to by "this", other than the relation to the global allocator attribute. Nor what "if you can't have that" is referring to (the violation being potentially valid, or a false-positive from Miri?). Additionally corrected a typo + corrected the file name that was changed since the comment was written.
The shorter README equivalent uses
ARENAinstead ofSTART_ARENA, wasSTART_meant to communicate any additional context?START_is an initial arena.