From: Chuck Lever <chuck.lever@oracle.com>
Date: Fri, 3 Jun 2022 15:53:38 +0000 (-0400)
Subject: Update the Requirements Language section
X-Git-Tag: draft-hellwig-nfsv4-scsi-layout-nvme-03~25
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=eaf8f14fb0688ade020d5a5c9b6c9f09f8ad03aa;p=users%2Fhch%2Fscsi-layout-nvme.git

Update the Requirements Language section

Adopt the modern text that cites RFC 8174.

Signed-off-by: Christoph Hellwig <hch@lst.de>
---

diff --git a/scsi_nvme_back_references.xml b/scsi_nvme_back_references.xml
index 5382e81..bf47b35 100644
--- a/scsi_nvme_back_references.xml
+++ b/scsi_nvme_back_references.xml
@@ -29,6 +29,18 @@
     </front>
   </reference>
 
+  <reference  anchor='RFC8174' target='https://www.rfc-editor.org/info/rfc8174'>
+    <front>
+      <title>Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words</title>
+      <author initials='B.' surname='Leiba' fullname='B. Leiba'><organization /></author>
+      <date year='2017' month='May' />
+      <abstract><t>RFC 2119 specifies common key words that may be used in protocol  specifications.  This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the  defined special meanings.</t></abstract>
+    </front>
+    <seriesInfo name='BCP' value='14'/>
+    <seriesInfo name='RFC' value='8174'/>
+    <seriesInfo name='DOI' value='10.17487/RFC8174'/>
+  </reference>
+
   <reference anchor='SPC4'>
     <front>
       <title>SCSI Primary Commands-4</title>
diff --git a/scsi_nvme_middle.xml b/scsi_nvme_middle.xml
index 4d10cea..00ed304 100644
--- a/scsi_nvme_middle.xml
+++ b/scsi_nvme_middle.xml
@@ -19,11 +19,13 @@
     SCSI translation reference.
   </t>
 
-  <section anchor="ssc:intro:conv" title="Conventions Used in This Document">
+  <section anchor="ssc:intro:reqlang" title="Requirements Language">
     <t>
       The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
-      "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
-      document are to be interpreted as described in <xref target="RFC2119" />.
+      "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
+      "OPTIONAL" in this document are to be interpreted as described in
+      BCP 14 <xref target="RFC2119" /> <xref target="RFC8174" /> when, and
+      only when, they appear in all capitals, as shown here.
     </t>
   </section>