[doc] Self-reference register in hjson description
Open
@HU90m is already working on this.
Since Apr 28, 2023.
Component:Doc
Earlgrey-PROD Triaged
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
### Description
In the `hjson` files in the `hw/ip/*/data/` directories, descriptions sometimes refer to other registers, but they may also reference themselves. Should we remove these or shall we support adding the link?
Example:
https://github.com/lowRISC/opentitan/blob/319d32e45b1d72bb98990bdff83653a90410e9a5/hw/ip/spi_host/data/spi_host.hjson#L419
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.