Relax the naming rule of extension name #1662
Conversation
Signed-off-by: Kersten Richter <[email protected]>
Signed-off-by: Kersten Richter <[email protected]>
src/naming.adoc
Outdated
| "Zifencei2p0" name version 2.0 of same. | ||
| Standard unprivileged extensions can also be named by using a single "Z" followed by an | ||
| alphanumeric name. The name must end with an alphabetical character or an | ||
| optional version number. The second letter from the bottom cannot be a numeric if the |
src/naming.adoc
Outdated
| Other standard extensions that extend the supervisor-level architecture are | ||
| named by using ``S'' as a prefix, followed by an alphanumeric name. The name | ||
| must end with an alphabetical character or an optional | ||
| version number. The second letter from the bottom cannot be a numeric character |
There was a problem hiding this comment.
"a numeric character" => "numeric"
src/naming.adoc
Outdated
| and "Xhwacha2p0" name version 2.0 of same. | ||
| Non-standard extensions are named by using a single "X" followed by the alphanumeric | ||
| name. The name must end with an alphabetic character or an optional version number. The | ||
| second letter from the bottom cannot be a numeric if the last letter is |
Signed-off-by: Kersten Richter <[email protected]>
Signed-off-by: Kersten Richter <[email protected]>
Signed-off-by: Kersten Richter <[email protected]>
src/naming.adoc
Outdated
| @@ -78,7 +78,7 @@ of the P extension. | |||
|
|
|||
| Standard unprivileged extensions can also be named by using a single "Z" followed by an | |||
| alphanumeric name. The name must end with an alphabetical character or an | |||
There was a problem hiding this comment.
I think this paragraph is combining two things together. The sentence "The name must end with an alphabetical character or an optional version number" is making version number part of the "name". But, as the "Version Numbers" section says, the version number is encoded after the name. The "name" of extensions must end in alphabetical character independent of whether there is a version number.
I think the "Version Numbering" and "Underscores" sections should be moved further down after the extension naming schemes are described. And all references to versions from the naming sections should be removed or integrated into the "Version Numbering" section.
I'm happy to work on the change.
There was a problem hiding this comment.
@kersten1 I'll be unavailable for a few days, but I'm happy to roll with whatever changes you and Craig agree upon. Don't wait for me to merge.
src/naming.adoc
Outdated
| Standard unprivileged extensions can also be named by using a single "Z" followed by an | ||
| alphanumeric name. The name must end with an alphabetical character or an | ||
| optional version number. The second letter from the end cannot be numeric if the | ||
| last letter is ``p''. For example, "Zifencei" names the instruction-fetch fence extension |
There was a problem hiding this comment.
I'm not well versed in asciidoc. Does p'' mean something? Documentation I found shows pwould be monospace, but I couldn't find anything for mixing and ''.
There was a problem hiding this comment.
I'm not sure what is up with that either! Glad you found and fixed it.
Andrew tells me that's a LaTeX-ism.
… the end of the multi-letter section names.
…ng sections Mention underscore as a separor of multi-letter extensions more consistently. Move the special case requiring an underscore for "P" extension to the Version Numbering section.
Signed-off-by: Kersten Richter <[email protected]>
Signed-off-by: Kersten Richter <[email protected]>
#1626 Signed-off-by: Kersten Richter <[email protected]>
|
@topperc Thanks! Waiting for the checks to complete and I'll merge. |
Update from this PR - #718
Not convinced that I did the supervisor section correctly. But I'm also not convinced that it is explained in Volume II. However, volume II has grown significantly and I just do not know it all.