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

uefi: mem: mem.rs -> mem/mod.rs #1251

Merged
merged 3 commits into from
Jul 22, 2024
Merged

uefi: mem: mem.rs -> mem/mod.rs #1251

merged 3 commits into from
Jul 22, 2024

Conversation

phip1611
Copy link
Member

@phip1611 phip1611 commented Jul 21, 2024 •
edited
Loading

Preliminary step for the refactoring request mentioned in #1240 (comment).

Is this the direction you were thinking about? I'd add a uefi/mem/memory_map/{mod, ...}.rs in a next step and add pub re-exports in the old location with a deprecation note.

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 requested a review from nicholasbishop July 21, 2024 07:37
@phip1611 phip1611 changed the title Mem module uefi: mem: mem.rs -> mem/mod.rs Jul 21, 2024
@phip1611
Copy link
Member Author

Not sure where all of a sudden that CI failure originates from, @nicholasbishop.

@nicholasbishop
Copy link
Member

Interesting, looks like changing the order of pub mod table/pub mod prelude affects the fully-qualified paths in the compiler's error output:

# old:
extern "efiapi" fn(uefi::Handle, uefi::table::SystemTable<uefi::table::Boot>) -> Status
# new:
extern "efiapi" fn(uefi::Handle, uefi::prelude::SystemTable<uefi::prelude::Boot>) -> Status

In lib.rs, moving pub mod prelude to come after pub mod table restores the old behavior. But, probably better to just update the test expectations with:

TRYBUILD=overwrite cargo xtask test

nicholasbishop
nicholasbishop approved these changes Jul 21, 2024
View reviewed changes
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 % updating the test expectations

phip1611 added 3 commits July 22, 2024 10:02
@phip1611
uefi: mem.rs -> mem/{mod, util}.rs
bb4b575 
This is a preliminary measurement to move the types for the uefi memory map (et al.)
from the boot services module to this module.
@phip1611
uefi: lib.rs cleanup
25c12dc 
Streamline the order of different statements.

1. extern crates
2. public modules
3. private modules
4. public uses
5. private use

From my year-long experience, it is usually a better structure to group all `use`
and all `mod` statements in a file. However, it is a matter of taste if `mod`
or `use` comes first.
@phip1611
uefi-macros: fix trybuild-based unit tests
ef3dcb6 
The unit tests for the compiler diagnostics are utilizing the trybuild crate.
With the recent reordering of the public exports of uefi/lib.rs, the fully qualified
paths have changed.

To update the expected error messages, I ran:

`$ TRYBUILD=overwrite cargo xtask test`

I'm not sure whether the previous changes also change something observable by the public
API. In the Rust reference, I couldn't find anything about the fully qualified path and how
it is influenced by the order of public exports.
@phip1611 phip1611 enabled auto-merge July 22, 2024 08:02
@phip1611 phip1611 added this pull request to the merge queue Jul 22, 2024
Merged via the queue into rust-osdev:main with commit 54f7fa2 Jul 22, 2024
12 checks passed
@phip1611 phip1611 deleted the mem-module branch July 22, 2024 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nicholasbishop nicholasbishop nicholasbishop approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@phip1611 @nicholasbishop