Don't require consumers to provide device path in `OpteHdl::open`

Open Beginner friendly
#341 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
networking, operating-systems

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.

Description

good first issue

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.

Dominant language
Rust
Stars
77
Forks
11
Avg merge
9d 20h
Merged PRs (30d)
8

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from oxidecomputer/opte

All issues in oxidecomputer/opte

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.