Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature Request: Better explain the role of exit_boot_services() or rename it #1604

Closed
ofluffydev opened this issue Apr 6, 2025 · 5 comments · Fixed by #1605
Closed

Feature Request: Better explain the role of exit_boot_services() or rename it #1604

ofluffydev opened this issue Apr 6, 2025 · 5 comments · Fixed by #1605
Assignees
@phip1611

Comments

@ofluffydev
Copy link

The exit_boot_services() function requires a MemoryType where it should not, and returns a memory map. I believe this function does more if not something entirely different from what you would expect exiting UEFI mode to be, therefore it needs to be renamed, or fixed to not require a MemoryType. I believe it used to be that way and was changed for some reason. If you're seriously going to keep it this way, at least help my writing better docs on both the enums and exit_boot_services() so people can understand what it means.

Yes "document it youself" blah blah I so WOULD PR better docs right now if I could understand this, it would be way better for the creators/maintainers to document them rather than wait months for me to figure it out just now learning UEFI and OS development with Rust.
@nicholasbishop
Copy link
Member

I can tell you're frustrated! I saw you just filed a similarly frustrated issue in the bootloader crate as well. Please take a little time to calm down before returning to this, otherwise we can't have a useful conversation. Thanks!

@ofluffydev
Copy link
Author

did you read what I said?.. You don't name something color_this_red and it color said thing purple. The name doesn't make since or at least needs an explanation. It can be better explained in the comments or renamed altogether to fix this...

@nicholasbishop
Copy link
Member

Please take some time to calm down. if you continue to behave rudely, we'll ban you.

@ofluffydev
Copy link
Author

Sincerely sorry if anything is coming off as rude, I am only asking to rename the function, explain it better in docs, or explain in this issue why it is in it's state for future reference.

@phip1611 phip1611 changed the title exit_boot_services() rename doc: improve doc and clarify the exit_boot_services() wrapper Apr 6, 2025
@phip1611 phip1611 self-assigned this Apr 6, 2025
@phip1611 phip1611 changed the title doc: improve doc and clarify the exit_boot_services() wrapper Feature Request: Better explain the role of exit_boot_services() or rename it Apr 6, 2025
@phip1611 phip1611 mentioned this issue Apr 6, 2025
Merged
2 tasks
@phip1611
Copy link
Member

phip1611 commented Apr 6, 2025 •
edited
Loading

Hey @ofluffydev,

I've set up #1605 to improve the situation.

In short: Exiting UEFI boot services requires a non-trivial sequence of steps,
including safe retrieval and finalization of the memory map. To clarify
why our exit_boot_services function is more than a thin wrapper, the
documentation has been updated accordingly.

I agree with you that the documentation wasn't properly reflecting that. Thanks for reaching out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@phip1611 phip1611

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

uefi/doc: improve documentation of exit_boot_services + change signature rust-osdev/uefi-rs
3 participants
@nicholasbishop @phip1611 @ofluffydev