riscv-isa-manual icon indicating copy to clipboard operation
riscv-isa-manual copied to clipboard

MMWP name violates friendly language policy

Open wmat opened this issue 11 months ago • 7 comments

MMWP "Machine Mode Whitelist Policy (mseccfg.MMWP)" violates the organizational friendly terminology policy.

As suggested by @sorear, renaming MMWP to MMDD (Machine Mode Default Deny) to make the meaning of 0 and 1 more immediately obvious, and also to comply with the RISC-V Friendly Terminology Policy.

wmat avatar Mar 21 '24 13:03 wmat

It was unfortunate it was ratified that way but changing the ratified specification in this manner may not be such a good idea.

ved-rivos avatar Mar 21 '24 13:03 ved-rivos

Agreed. I'll leave this here for further discussion. Similarly, an alternative name could be "Machine Mode Allowlist Policy (mseccfg.MMAP)" which seems closer to the original intent.

wmat avatar Mar 21 '24 13:03 wmat

We should keep acronym letters the same to avoid changing a ratified interface. I'd suggest changing the acronym expansion to "Machine-Mode When-no-PMP-match Policy".

kasanovic avatar Mar 21 '24 17:03 kasanovic

Agreed that changing the acronym is more problematic than changing the name, since the acronym shows up in more places, e.g. header files.

aswaterman avatar Mar 21 '24 19:03 aswaterman

Another option is for W to stand for alloWlist. It’s perhaps silly to use an acronym rather than an initialism, but it’s less of a mouthful than the proposed alternative. In any case, I’d like one of the spec authors to make the call.

aswaterman avatar Mar 23 '24 18:03 aswaterman

Andrew's suggested acronym expansion is fine with me.

kasanovic avatar Mar 25 '24 09:03 kasanovic

OK, I've updated to PR.

On Mon, Mar 25, 2024 at 5:34 AM Krste Asanovic @.***> wrote:

Andrew's suggested acronym expansion is fine with me.

— Reply to this email directly, view it on GitHub https://github.com/riscv/riscv-isa-manual/issues/1280#issuecomment-2017577419, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAN6ZAOYKYILTESFUUMZTTYZ7VQZAVCNFSM6AAAAABFBOZKTWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMJXGU3TONBRHE . You are receiving this because you authored the thread.Message ID: @.***>

wmat avatar Mar 25 '24 12:03 wmat