oxidecomputer / oxidecomputer/humility

Every place where a type/function name is used in a Humility API should allow fully-qualified names.

Open
#512 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
584
Forks
63
Avg merge
3h
Merged PRs (30d)
2

Description

Rust programs often use the same name in different modules, because we have modules/namespaces. e.g. a typical program will contain many types named Error in different places.

Humility originally stripped crate/module path information off types, and used unqualified names. This has been causing problems for a while in things like processing Idol interfaces -- see https://github.com/oxidecomputer/hubris/issues/1896 for the most recent case.

I added partial support for fully qualified names back in 2021, but we need to complete the switch-over. It's okay to allow unqualified names in some cases (particularly in the TUI!) but that should be a convenience, which turns into an error if the name is ambiguous. At that point the user should always be able to provide a fully qualified name.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by tracing Humility's partial fully qualified-name support and the API call sites that accept type or function names; the issue does not name specific files or tests. Map where unqualified names remain and define how ambiguity should become an error, while preserving convenient TUI lookup. Done means every Humility API location can accept fully qualified names.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api, devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.