riscv/riscv-isa-manual

MMWP name violates friendly language policy

wmat opened this issue · 8 comments

wmat commented

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.

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

wmat commented

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.

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".

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

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.

Andrew's suggested acronym expansion is fine with me.

wmat commented

This is complete so closing.