[otbn] Duplicated error code list
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
The list of OTBN error codes is duplicated, appearing in these 3 places:
- `otbn_pkg.sv`
- The HTML documentation
- The ISS (`alert.py`)
We should probably list them in the hjson and generate the other files. Easy enough for the documentation and ISS. For the SV code, maybe we could get reggen to generate the list, and then move the list to `otbn_reg_pkg.sv`.
Contributor guide
Research direction
Compare the duplicated error-code lists in otbn_pkg.sv, the HTML documentation, and the ISS implementation in alert.py, then inspect the relevant HJSON and reggen paths. Define one source of truth and verify that the documentation, ISS, and SystemVerilog outputs remain consistent; the issue is done when the duplicated lists are generated or removed as appropriate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, python
- Domain
- documentation, embedded-iot, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100