Skip to content

Deprecate uefi-services and add uefi::helpers as replacement #1128

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.

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

Merged
merged 7 commits into from
Apr 14, 2024

Conversation

phip1611
Copy link
Member

@phip1611 phip1611 commented Apr 13, 2024

As discussed in #563, we deprecated uefi-services and move it to a new uefi::helpers module.

  • uefi-services is marked as deprecated
  • uefi_services::init forwards to uefi::helpers::init (drop-in replacement!)
  • uefi::helpers::init now takes care of everything
  • Remove exit boot services notify hook

Hints for Reviewers

  • please review commit-by-commit
  • To check that forwarding from uefi_services::init to uefi::helpers::init works, I'm suggesting to temporarily revert uefi-test-runner: use new uefi::helpers module - or you can just trust me. :)

Checklist

  • Sensible git history (for example, squash "typo" or "fix" commits). See the Rewriting History guide for help.
  • Update the changelog (if necessary)

@phip1611 phip1611 force-pushed the remove-uefi-services branch 3 times, most recently from 6ec25e5 to 1829dca Compare April 13, 2024 09:59
@phip1611 phip1611 marked this pull request as ready for review April 13, 2024 09:59
@phip1611 phip1611 linked an issue Apr 13, 2024 that may be closed by this pull request
@phip1611 phip1611 force-pushed the remove-uefi-services branch 2 times, most recently from b5625fb to c21e56b Compare April 13, 2024 10:12
@phip1611 phip1611 changed the title Deprecate uefi services Deprecate uefi-services and add uefi::helpers as replacement Apr 13, 2024
@phip1611 phip1611 force-pushed the remove-uefi-services branch 4 times, most recently from c77cf23 to 2e45e42 Compare April 13, 2024 10:27
@phip1611 phip1611 force-pushed the remove-uefi-services branch from 2e45e42 to 905baa6 Compare April 14, 2024 08:51
uefi_services::init temporarily stays API compatible to prevent
breaking changes. But we've added deprecation warnings.

The new uefi::helpers module consists mostly of an unchanged code import.
Only minor adjustments were applied. Cleanup will happen in a follow-up.
Note that even without these changes, everything works. This proves
that we stay API compatible for the next uefi-services release.
I didn't change anything about the implementations, just moved the existing code into the
corresponding modules.
@phip1611 phip1611 force-pushed the remove-uefi-services branch 2 times, most recently from 9ef222d to 19629e3 Compare April 14, 2024 09:22
@phip1611
Copy link
Member Author

I've taken care of all your comments. Please re-review.

No need for the complicated and error-prone approach using an event.
@phip1611 phip1611 force-pushed the remove-uefi-services branch from 19629e3 to 9a257a0 Compare April 14, 2024 09:26
Copy link
Member

@nicholasbishop nicholasbishop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@nicholasbishop nicholasbishop added this pull request to the merge queue Apr 14, 2024
Merged via the queue into rust-osdev:main with commit 6807825 Apr 14, 2024
12 checks passed
@phip1611 phip1611 deleted the remove-uefi-services branch April 14, 2024 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

global_allocator and logger could be moved to uefi-services
2 participants