Applying style guidelines and spelling to M #1835
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR contains changes for the style guidelines that were discussed in the doc-sig. Style guidelines say that extension names an registers should be in back tics. This also fixes the old spelling of "implementors". Signed-off-by: Kersten Richter <kersten@riscv.org>
Signed-off-by: Kersten Richter <kersten@riscv.org>
aswaterman
approved these changes
Jan 29, 2025
aswaterman
requested changes
Jan 29, 2025
There was a problem hiding this comment.
`MULH[[S]U] rdh, rs1, rs2; MUL rdl, rs1, rs2`
Because this is meant to represent a statement in assembly language, the entire thing should be in a single set of backticks. The rationale is that the commas and the semicolon are part of the assembly-language syntax; they aren't being used to delimit a list in English.
Putting the individual register specifiers in their own backticks is the right thing to do when they are being referenced individually, as in the phrase "the register specifiers rs1, rs2, and rs3".
LGTM otherwise.
kersten1
commented
Jan 30, 2025
Signed-off-by: Kersten Richter <kersten@riscv.org>
kersten1
commented
Jan 30, 2025
Signed-off-by: Kersten Richter <kersten@riscv.org>
kersten1
commented
Jan 30, 2025
Signed-off-by: Kersten Richter <kersten@riscv.org>
kersten1
commented
Jan 30, 2025
Signed-off-by: Kersten Richter <kersten@riscv.org>
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains changes for the style guidelines that were discussed in the doc-sig. Style guidelines say that extension names and registers, among others should be in back ticks.
This also fixes the old spelling of "implementors".
One thing to discuss is the code sequences. Because they are code sequences, I put the pieces into back ticks to indicate code, as you can see if the following section:
MULH[[S]U]rdh,rs1,rs2;MUL rdl,rs1,rs2(source register specifiers must be in same order andrdhcannot be the same asrs1orrs2).but I can be convinced otherwise.