oxidecomputer / oxidecomputer/quartz

RDL addr map name enforcement when doing buck builds

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

Nobody has claimed this yet.

build system rdl tooling
Dominant language
VHDL
Stars
22
Forks
2
Avg merge
9h 38m
Merged PRs (30d)
1

Description

We'd like to have even more consistency on how things are named, and enforce it pragmatically but we have to figure out how to do that without breaking our older designs.
Ideally we'd enforce that <some_name>.rdl will translate to
addrmap <some_name> but there are a bunch of strange cases around nesting plus making this change needs to be done inside our RDL tooling which is common for both buck2 and cobble based builds and so we probably need an escape hatch of some type.

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.

Research direction

Start by locating the common RDL tooling used by both Buck2 and Cobble builds. Map the nesting cases and older designs that need compatibility, then define the naming rule and escape hatch; done means the behavior is agreed for normal and exceptional cases before implementation begins.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.