llvm / llvm/circt

[SV] Rename SV passes to reflect that they're SV passes and not HW

Open
#5,581 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

HW Verilog/SystemVerilog
Dominant language
C++
Stars
2.2k
Forks
524
Avg merge
3d 2h
Merged PRs (30d)
46

Description

Essentially everything prefixed with `HW` in https://github.com/llvm/circt/blob/main/include/circt/Dialect/SV/SVPasses.td.

In the spirit of
1. keeping our codebase ready for the potential addition of new backends in the future
2. avoid confusion about what dialect(s) a pass pertains to

various SV passes should be renamed to reflect that they aren't strictly HW passes. These passes live in the SV directories and they lower HW constructs to SV constructs, hence these are SV passes, and not HW passes.

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 with include/circt/Dialect/SV/SVPasses.td and inventory the entries prefixed with HW. Search the repository for references to those pass names, update the names consistently, and verify that the project still builds and its relevant tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
compilers
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.