-
Notifications
You must be signed in to change notification settings - Fork 40
Move more useful information higher on instruction display page #659
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
Here's a table to help visualize this change:
I don't have a strong opinion on the ordering but more that we should condense some of the output to make all of it close to fitting on a single page. Right now as you have shown https://riscv-software-src.github.io/riscv-unified-db/manual/html/isa/isa_20240411/insts/bge the worst is "containing profiles" which can be upwards of 15 LOC which takes up 1/2 page. Rather then listing one profile per line, I would just have a single line of comma separate profiles and an abbreviation for "Mandatory" ex: "in profiles: RVA20S64 (M), RVA20U64 (M), RVA22S64 (M) (M = Mandatory)" |
|
Moving "decode variables" up above "execution":
I thought about suggesting a table, but was worried its width would be unbounded over time. I'm OK with a list, or lists:
Lists will wrap as needed to fit the display. |
fixes #659 move more important/useful info higher up# <type>(<scope>): <short summary>
fixes #659 move more important/useful info higher up# <type>(<scope>): <short summary>
fixes #659 move more important/useful info higher up# <type>(<scope>): <short summary>
fixes #659 move more important/useful info higher up# <type>(<scope>): <short summary>
fixes #659 move more important/useful info higher up# <type>(<scope>): <short summary> still WIP, I haven't turned the containing profiles into a list, just moved it to the bottom.
Is your feature request related to a problem? Please describe.
If the primary audience for the RISC-V ISA Manual instruction pages is programmers/engineers, then the order of the information displayed could be better. Currently, the information is displayed in this order:
Describe the solution you'd like
Additional context

The text was updated successfully, but these errors were encountered: