rust-osdev / rust-osdev/uefi-rs
Device Path Construction: Further improve tooling and guidance
Open
Nobody has claimed this yet.
maybe-next-release
- Dominant language
- Rust
- Stars
- 1.7k
- Forks
- 200
- Avg merge
- 16h 55m
- Merged PRs (30d)
- 35
Description
#1799 was already a step into the right direction. But as we have
DevicePathBuilderusing an external bufferDevicePathBuilder::pushonly accepting single build nodesDevicePath::append_node()suddenly returning an allocated device path- (soon)
DevicePathBuilderOwner(#1806)
we should streamline the interop, the documentation and also figure out what the recommended way is. For example:
DevicePathBuildershould probably also have some kind of::push_nodes(dv: &DevicePath)- We should clarify when we use
Box<DevicePath>and whenPoolDevicePath
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading #1799 and #1806, then inspect DevicePathBuilder, DevicePathBuilder::push, DevicePath::append_node(), and the planned DevicePathBuilderOwner. Determine the recommended interoperability and ownership model, including whether push_nodes should be added and when to use Box versus PoolDevicePath. Done means the API and guidance are streamlined and the recommended usage is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- operating-systems
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100