Skip to content
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

Manuals reference in the main ISA #1571

Open
AlfredoRodrigues4 opened this issue Jul 29, 2024 · 0 comments
Open

Manuals reference in the main ISA #1571

AlfredoRodrigues4 opened this issue Jul 29, 2024 · 0 comments

Comments

@AlfredoRodrigues4
Copy link

When trying to use the RISC-V architecture even for simpler tasks it normally is necessary to search in different manuals. Other issues already have been raised due to lack of information in the ISA that was supported by external manuals, (issue: pseudoinstructions list missing), (issue: No mention of jr pseudo-instruction). I recognize that there has already been some discussion about merging some manuals (and has in fact happened in some cases like the "CMO" Extension), but I think that while merging manuals is a time-consuming process, a quicker fix solution until the discussion about merging is concluded would be to refer some of these manuals in the ISA manuals.

 What I suggest is something as a "Table of manuals" after the ToC, with a list of some of the most commonly used external manuals. The RISC-V assembly, the pseudoinstructions and the general purpose registers are some topics that raise up a lot of questions (issue: don't find the manual) and I believe that may occur due to many people not being able to instantly find this information. 

I agree that the merging process would better serve some of these manuals but there are some, like the ABI, that could even stay referenced like this instead of adding all the information into the ISA.

A list of those manuals could include:

This isn't usual in other vendor manuals because normally they have these small documents merged in the main ISA manual.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant