oxidecomputer / oxidecomputer/opte
Don't require consumers to provide device path in `OpteHdl::open`
Open
Beginner friendly
Nobody has claimed this yet.
good first issue
- Dominant language
- Rust
- Stars
- 77
- Forks
- 11
- Avg merge
- 9d 20h
- Merged PRs (30d)
- 8
Description
OpteHdl::open currently takes a path to the xde device to open but the value is essentially static (and all consumers just use the const OpteHdl::XDE_CTL). There currently isn't any use-case for a non-standard path so it'd be a lot ergonomic to no require one by default.
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 at the OpteHdl::open definition and inspect consumers that currently pass OpteHdl::XDE_CTL. Update the API so the standard device path is used by default, while preserving the existing behavior for the standard path; confirm that consumers no longer need to provide it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- networking, operating-systems
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 62/100