Re: [PATCH] introduction: Clarify RFC 2119 key words usage
Cornelia Huck <[email protected]>
| Newsgroups | dev.linux.lists.virtio-comment |
|---|---|
| Organization | "Red Hat GmbH, Sitz: Werner-von-Siemens-Ring 12, D-85630 Grasbrunn, Handelsregister: Amtsgericht München, HRB 153243, Geschäftsführer: Ryan Barnhart, Charles Cachera, Avril Crosse O'Flaherty" |
| Message-ID | <[email protected]> |
On Fri, Jun 27 2025, Parav Pandit <[email protected]> wrote: > RFC 2119 key words should be used in Requirements and Conformance > sections; these key words to be avoided in rest of the sections. > > The motivations for such clarity are: > > 1. To clarify the intent: > These key words carry precise semantic weight. When a spec says MUST, > it means compliance is not optional. Using such terms in general or > explanatory text risks misinterpreting guidance as a requirement. > > 2. Avoiding Ambiguity: > If normative language is used in non-normative (informative) sections, > it becomes unclear whether the reader is required to follow it or > if it's just background or suggestion. > > 3. Informative sections explain context, rationale, or examples. > Normative sections define rules. Mixing the two muddies the structure > and weakens the authority of the normative part. > > Fixes: https://github.com/oasis-tcs/virtio-spec/issues/230 > Signed-off-by: Parav Pandit <[email protected]> > --- > introduction.tex | 5 ++++- > 1 file changed, 4 insertions(+), 1 deletion(-) Reviewed-by: Cornelia Huck <[email protected]>