Specify guidelines on implementation-specific constants like IALIGN
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 142
- Forks
- 41
- Avg merge
- 14h 30m
- Merged PRs (30d)
- 10
Description
(Originally raised at https://github.com/riscv/riscv-isa-manual/issues/2827)
Currently, there are no style guideline for IALIGN, XLEN etc. Moreover, there seems no official name for this kind of things. In the ISA manual, sometimes they are called the terms but it is too broad.
Examples from the ISA manual:
- ILEN
- min(ILEN,XLEN)
- UXLEN=64
How should we style them?
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.
Research direction
Start by reviewing the linked ISA manual examples for ILEN, IALIGN, XLEN, min(ILEN,XLEN), and UXLEN=64, then compare them with any existing style guidance in the documentation developer guide. Done means the terminology and styling rules for implementation-specific constants are agreed and documented with representative examples.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100