Skip to content

Project convention updates [Rebase & FF]#1469

Merged
makubacki merged 4 commits intoOpenDevicePartnership:mainfrom
makubacki:ai_convention_updates
Apr 16, 2026
Merged

Project convention updates [Rebase & FF]#1469
makubacki merged 4 commits intoOpenDevicePartnership:mainfrom
makubacki:ai_convention_updates

Conversation

@makubacki
Copy link
Copy Markdown
Collaborator

Description

A few miscellaneous changes to update code not complying with the project instructions in #1460.


patina_stacktrace: Replace mod.rs with named module files

Move x64/mod.rs to x64.rs and aarch64/mod.rs to aarch64.rs to follow
the project convention of using named module files instead of mod.rs.


patina_mm: Replace mod.rs in integration test with a named module file

Rename mod.rs to tests_root.rs and update the test entry point to use
a #[path] attribute redirect, eliminating mod.rs while preserving the
existing module hierarchy and crate-level import paths.


Replace unwrap() with expect() in a few locations

We prefer expect() in production code to provide more context in the
event of an error.

Add descriptive messages to unwrap() calls in:

  • rbt.rs: RBT rebalancing where sibling/parent nodes are guaranteed
    to exist by the algorithm invariants
  • x64/runtime_function.rs: PE .pdata chunk reads validated by
    preceding size checks
  • aarch64/runtime_function.rs: same pattern for AArch64 .pdata parsing

components: Enforce missing_docs lint in all component crates

Add #![deny(missing_docs)] to component crate lib.rs files to enforce
documentation requirements on public items.


  • Impacts functionality?
  • Impacts security?
  • Breaking change?
  • Includes tests?
  • Includes documentation?

How This Was Tested

  • cargo make all

Integration Instructions

  • N/A

Move x64/mod.rs to x64.rs and aarch64/mod.rs to aarch64.rs to follow
the project convention of using named module files instead of mod.rs.

Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Rename mod.rs to tests_root.rs and update the test entry point to use
a #[path] attribute redirect, eliminating mod.rs while preserving the
existing module hierarchy and crate-level import paths.

Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
We prefer expect() in production code to provide more context in the
event of an error.

Add descriptive messages to unwrap() calls in:

- rbt.rs: RBT rebalancing where sibling/parent nodes are guaranteed
  to exist by the algorithm invariants
- x64/runtime_function.rs: PE .pdata chunk reads validated by
  preceding size checks
- aarch64/runtime_function.rs: same pattern for AArch64 .pdata parsing

Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Add #![deny(missing_docs)] to component crate lib.rs files to enforce
documentation requirements on public items.

Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
@makubacki makubacki self-assigned this Apr 16, 2026
@patina-automation
Copy link
Copy Markdown
Contributor

patina-automation Bot commented Apr 16, 2026

✅ QEMU Validation Passed

All QEMU validation jobs completed successfully.

Note: Q35 is only built on Windows hosts (QEMU boot is disabled due to a QEMU vfat issue).

Workflow run: https://github.com/OpenDevicePartnership/patina/actions/runs/24527974917

Boot Time to EFI Shell

Platform Elapsed
Q35 (Linux Host) 27.3s
SBSA (Linux Host) 54.7s

Dependencies

Repository Ref
patina bdc7bfb
patina-dxe-core-qemu eebcb79
patina-fw-patcher 3960603
patina-qemu firmware v3.0.0
patina-qemu build script 03e3935

This comment was automatically generated by the Patina QEMU PR Validation Post workflow.

@github-actions github-actions Bot added the impact:non-functional Does not have a functional impact label Apr 16, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@makubacki makubacki merged commit fe93929 into OpenDevicePartnership:main Apr 16, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

impact:non-functional Does not have a functional impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants