public inbox for virtio-comment@lists.linux.dev
 help / color / mirror / Atom feed
From: Parav Pandit <parav@nvidia.com>
To: <virtio-comment@lists.linux.dev>, <mst@redhat.com>,
	<cohuck@redhat.com>, <mvaralar@redhat.com>
Cc: <shahafs@nvidia.com>, Parav Pandit <parav@nvidia.com>
Subject: [PATCH] introduction: Clarify RFC 2119 key words usage
Date: Fri, 27 Jun 2025 07:19:54 +0300	[thread overview]
Message-ID: <20250627041954.400922-1-parav@nvidia.com> (raw)

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 <parav@nvidia.com>
---
 introduction.tex | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/introduction.tex b/introduction.tex
index 80aa67a..4e7ab59 100644
--- a/introduction.tex
+++ b/introduction.tex
@@ -196,7 +196,10 @@ \section{Terminology}\label{Terminology}
 ``SHOULD'', ``SHOULD NOT'', ``RECOMMENDED'', ``NOT RECOMMENDED'', ``MAY'', and
 ``OPTIONAL'' in this document are to be interpreted as described in
 \hyperref[intro:rfc2119]{[RFC2119]} and \hyperref[intro:rfc8174]{[RFC8174]} when,
-and only when, they appear in all capitals, as shown here.
+and only when, they appear in all capitals, as shown here. The use of these
+key words is recommended in the Requirements and Conformance sections and should
+be avoided in other sections.
+
 \subsection{Legacy Interface: Terminology}\label{intro:Legacy
 Interface: Terminology}
 
-- 
2.34.1


             reply	other threads:[~2025-06-27  4:20 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-27  4:19 Parav Pandit [this message]
2025-06-27  7:47 ` [PATCH] introduction: Clarify RFC 2119 key words usage Matias Ezequiel Vara Larsen
2025-06-27  8:29 ` Cornelia Huck
2025-06-27 11:53 ` Michael S. Tsirkin
2025-06-27 12:16   ` Parav Pandit

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250627041954.400922-1-parav@nvidia.com \
    --to=parav@nvidia.com \
    --cc=cohuck@redhat.com \
    --cc=mst@redhat.com \
    --cc=mvaralar@redhat.com \
    --cc=shahafs@nvidia.com \
    --cc=virtio-comment@lists.linux.dev \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox