Skip to content

Disambiguate the use of the term "reserved" for HINT instructions - #990

Closed
Alex Bradbury (asb) wants to merge 1 commit into
riscv:masterfrom
asb:clarify-reserved
Closed

Disambiguate the use of the term "reserved" for HINT instructions#990
Alex Bradbury (asb) wants to merge 1 commit into
riscv:masterfrom
asb:clarify-reserved

Conversation

@asb

Copy link
Copy Markdown
Contributor

As was raised in #300, the overloaded use of the term "reserved" when listing HINT encodings is potentially confusing. As clarified in that thread, these encodings are "reserved" in the intuitive English language meaning of the word, but are not part of the "reserved instruction-set category" as defined in the section 1.3 introduction and further elaborated in section 2.2 "Base Instruction Formats" (which notes how platforms can choose to raise an illegal-instruction exception for reserved instruction encodings).

As was raised in riscv#300, the overloaded use of the term "reserved" when
listing HINT encodings is potentially confusing. As clarified in that
thread, these encodings are "reserved" in the intuitive English language
meaning of the word, but are _not_ part of the "reserved instruction-set
category" as defined in the section 1.3 introduction and further
elaborated in section 2.2 "Base Instruction Formats" (which notes how
platforms can choose to raise an illegal-instruction exception for
reserved instruction encodings).
@asb

Copy link
Copy Markdown
Contributor Author

Friendly ping on this as it's been a couple of weeks.

@aswaterman

Copy link
Copy Markdown
Member

Maybe we should just avoid use of the word "reserved" in this paragraph and in the tables, and instead use the word "designated". What do you think Alex Bradbury (@asb) Krste Asanovic (@kasanovic)?

Alex Bradbury (asb) added a commit to asb/riscv-isa-manual that referenced this pull request Mar 29, 2023
The term "reserved" could be ambiguous, as it might be understood to
refer to the "reserved instruction-set category" as defined in the
section 1.3 instruction and further elaborated in section 2.2 "Base
Instruction Formats". Avoid this potential confusion by using
"designated" instead, which also matches the terminology used for HINT
encodings intended for custom use.

This is an alternative to riscv#990.
@asb

Copy link
Copy Markdown
Contributor Author

That's a good idea, especially as we already say "Designated for custom use" already. I've submitted #1001 as an alternative PR using that approach.

Andrew Waterman (aswaterman) pushed a commit that referenced this pull request Mar 29, 2023
…#1001)

The term "reserved" could be ambiguous, as it might be understood to
refer to the "reserved instruction-set category" as defined in the
section 1.3 instruction and further elaborated in section 2.2 "Base
Instruction Formats". Avoid this potential confusion by using
"designated" instead, which also matches the terminology used for HINT
encodings intended for custom use.

This is an alternative to #990.
@aswaterman

Copy link
Copy Markdown
Member

Superseded by #1001

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

Successfully merging this pull request may close these issues.

2 participants