llvm / llvm/circt

[FIRRTL] Update rationale mentioning use of IntegerAttr for port directions

Open Beginner friendly
#7,242 0 comments 0 reactions 0 assignees View on GitHub
documentation FIRRTL
Dominant language
C++
Stars
2.2k
Forks
524
Avg merge
3d 2h
Merged PRs (30d)
46

Description

As of #6875, port directions as now encoded with a DenseArray.

In the rationale we mention we still encode with IntegerAttr, this should be updated to reflect what's been learned and changed.

https://circt.llvm.org/docs/Dialects/FIRRTL/RationaleFIRRTL/#input-and-output-module-ports .

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the FIRRTL Rationale page and go to the “Input and Output Module Ports” section linked in the issue. Check the statement about IntegerAttr against the current DenseArray encoding described in the issue, then update the rationale so it is accurate; the work is done when that section no longer describes the old representation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.