doc: improved documentation for boot allocation functions #1665
Conversation
This file contains hidden or 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
This was referenced May 11, 2025
| /// | ||
| /// UEFI OS loaders should allocate memory of the type `LoaderData`. | ||
| /// The caller is responsible to free the memory using [`free_pages`]. |
There was a problem hiding this comment.
Suggested change
| /// The caller is responsible to free the memory using [`free_pages`]. | |
| /// The caller is responsible for freeing the memory using [`free_pages`]. |
| /// - `memory_type`: The [`MemoryType`] used to persist the allocation in the | ||
| /// UEFI memory map. Typically, UEFI OS loaders should allocate memory of | ||
| /// type [`MemoryType::LOADER_DATA`]. | ||
| ///- `size`: Amount of bytes to allocate. |
There was a problem hiding this comment.
Suggested change
| ///- `size`: Amount of bytes to allocate. | |
| ///- `count: Number of pages to allocate. |
| ///- `size`: Amount of bytes to allocate. | ||
| /// | ||
| /// # Safety | ||
| /// Using this function is safe but reading on initialized memory is not. |
There was a problem hiding this comment.
Suggested change
| /// Using this function is safe but reading on initialized memory is not. | |
| /// Using this function is safe, but it returns a raw pointer to uninitialized memory. The memory must be initialized before creating a reference to it. |
(Reference: https://doc.rust-lang.org/nomicon/unchecked-uninit.html "It is illegal to construct a reference to uninitialized data")
There was a problem hiding this comment.
Yikes, typos/weird wording from my side.
Thanks
| /// - `memory_type`: The [`MemoryType`] used to persist the allocation in the | ||
| /// UEFI memory map. Typically, UEFI OS loaders should allocate memory of | ||
| /// type [`MemoryType::LOADER_DATA`]. | ||
| ///- `size`: Amount of bytes to allocate. |
There was a problem hiding this comment.
Suggested change
| ///- `size`: Amount of bytes to allocate. | |
| ///- `size`: Number of bytes to allocate. |
(This is a nitpicky grammar thing, "number" should be used for countable things)
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.
Leftover from #1606
Checklist