Harmonizing 'normative langugage' and 'terms' subsections among all documents

4 years ago · 062858ba92
parent fb3b1c745b
commit 062858ba92
13 changed files with 42 additions and 33 deletions
--- a/ietf-lamps-header-protection/draft-ietf-lamps-header-protection-req.mkd
+++ b/ietf-lamps-header-protection/draft-ietf-lamps-header-protection-req.mkd
@ -20,7 +20,6 @@ normative:
 #  RFC1847:
 #  RFC1341:
  RFC2045: # MIME part 1 #
-  RFC2119:
  RFC5322: # SMTP #
  RFC8551: # S/MIME # 
  
@ -144,13 +143,11 @@ standards ({{progressive-header-disclosure}}, ff.).

 \[...\]

-# Conventions Used in This Document

 {::include ../shared/text-blocks/key-words-rfc2119.mkd}

-## Terminology

-The following terms are defined in this document:
+{::include ../shared/text-blocks/terms-intro.mkd}
   
 * Header Field:: cf. {{RFC5322}}

--- a/lamps-header-protection/Makefile
+++ b/lamps-header-protection/Makefile
@ -1,7 +1,7 @@
 #!/usr/bin/make -f

 NAME := draft-luck-lamps-pep-header-protection
-REV := 02
+REV := 03
 DRAFT := $(NAME)-$(REV)

 OUTPUTS = $(DRAFT).xml $(DRAFT).txt $(DRAFT).html
--- a/lamps-header-protection/draft-luck-lamps-pep-header-protection.mkd
+++ b/lamps-header-protection/draft-luck-lamps-pep-header-protection.mkd
@ -3,7 +3,7 @@ coding: utf-8

 title: "pretty Easy privacy (pEp): Header Protection"
 abbrev: pEp Header Protection 
-docname:  draft-luck-lamps-pep-header-protection-02
+docname:  draft-luck-lamps-pep-header-protection-03
 category: info

 stand_alone: yes
@ -17,7 +17,6 @@ normative:
 #  RFC822:
 #  RFC1847:
 #  RFC1341:
-  RFC2119:
  RFC2046:
  RFC3156:
 #  RFC3501:
@ -129,10 +128,11 @@ mail user agents otherwise not conforming to pEp standards
 ({{message-format-for-progressive-header-disclosure}}, ff.).


+{::include ../shared/text-blocks/key-words-rfc2119.mkd}

-# Terms

-{::include ../shared/text-blocks/key-words-rfc2119.mkd}
+{::include ../shared/text-blocks/terms-intro.mkd}
+
 <!-- {::include ../shared/text-blocks/handshake.mkd} -->
 <!-- {::include ../shared/text-blocks/trustwords.mkd} -->
 <!-- {::include ../shared/text-blocks/tofu.mkd} -->
--- a/medup-requirements/draft-symeonidis-medup-requirements.mkd
+++ b/medup-requirements/draft-symeonidis-medup-requirements.mkd
@ -14,7 +14,6 @@ author:
 {::include ../shared/author_tags/bernie_hoeneisen.mkd}

 normative:
-  RFC2119:
  RFC4949:
  RFC7435:

@ -60,9 +59,11 @@ In MEDUP these issues are addressed based on Opportunistic Security
 This document covers analysis of threats and requirements.


-# Terms
-
 {::include ../shared/text-blocks/key-words-rfc2119.mkd}
+
+
+{::include ../shared/text-blocks/terms-intro.mkd}
+
 {::include ../shared/text-blocks/handshake.mkd}
 {::include ../shared/text-blocks/trustwords.mkd}
 {::include ../shared/text-blocks/tofu.mkd}
--- a/pep-email/draft-marques-pep-email.mkd
+++ b/pep-email/draft-marques-pep-email.mkd
@ -15,7 +15,6 @@ author:
 #{::include ../shared/author_tags/bernie_hoeneisen.mkd}

 normative:
-  RFC2119:
  RFC3156:
  RFC4949:
  RFC5322:
@ -112,9 +111,11 @@ Additionally, it is helpful to also understand the other normatively referenced
 documents, in particular {{I-D.marques-pep-handshake}} {{I-D.marques-pep-rating}}.


-# Terms
-
 {::include ../shared/text-blocks/key-words-rfc2119.mkd}
+
+
+{::include ../shared/text-blocks/terms-intro.mkd}
+
 {::include ../shared/text-blocks/handshake.mkd}
 {::include ../shared/text-blocks/trustwords.mkd}
 {::include ../shared/text-blocks/tofu.mkd}
--- a/pep-handshake/draft-marques-pep-handshake.mkd
+++ b/pep-handshake/draft-marques-pep-handshake.mkd
@ -16,7 +16,6 @@ author:

 normative:
  I-D.birk-pep-trustwords:
-  RFC2119:
  RFC4949:
 #   RFC5322:
  RFC7435:
@ -105,9 +104,11 @@ messaging applications and introduces methods to easily allow
 authentication.


-# Terms
-
 {::include ../shared/text-blocks/key-words-rfc2119.mkd}
+
+
+{::include ../shared/text-blocks/terms-intro.mkd}
+
 <!-- {::include ../shared/text-blocks/handshake.mkd} -->
 {::include ../shared/text-blocks/trustwords.mkd}
 {::include ../shared/text-blocks/tofu.mkd}
--- a/pep-keyreset/draft-marques-pep-keyreset.mkd
+++ b/pep-keyreset/draft-marques-pep-keyreset.mkd
@ -13,7 +13,6 @@ author:
 {::include ../shared/author_tags/hernani_marques.mkd}

 normative:
-  RFC2119:
 #  RFC3156:
  RFC4949:
 #  RFC5322:
@ -50,9 +49,12 @@ TBD

 \[\[ TODO \]\]

-# Terms

 {::include ../shared/text-blocks/key-words-rfc2119.mkd}
+
+
+{::include ../shared/text-blocks/terms-intro.mkd}
+
 {::include ../shared/text-blocks/handshake.mkd}
 {::include ../shared/text-blocks/trustwords.mkd}
 {::include ../shared/text-blocks/tofu.mkd}
--- a/pep-keysync/draft-hoeneisen-pep-keysync.mkd
+++ b/pep-keysync/draft-hoeneisen-pep-keysync.mkd
@ -15,7 +15,6 @@ author:
 # {::include ../shared/author_tags/claudio_luck.mkd}

 normative:
-  RFC2119:
  RFC4949:
 #  RFC5322:
  RFC7435:
@ -97,9 +96,11 @@ Perform the synchronization in a secure manner, so that private keys are
 not leaked or exposed to theft.


-# Terms
-
 {::include ../shared/text-blocks/key-words-rfc2119.mkd}
+
+
+{::include ../shared/text-blocks/terms-intro.mkd}
+
 {::include ../shared/text-blocks/handshake.mkd}
 {::include ../shared/text-blocks/trustwords.mkd}
 {::include ../shared/text-blocks/tofu.mkd}
--- a/pep-rating/draft-marques-pep-rating.mkd
+++ b/pep-rating/draft-marques-pep-rating.mkd
@ -14,7 +14,6 @@ author:
 {::include ../shared/author_tags/bernie_hoeneisen.mkd}

 normative:
-  RFC2119:
  RFC4949:
 #   RFC5322:
  RFC7435:
@ -125,9 +124,11 @@ messaging applications and introduces methods to easily allow
 authentication.


-# Terms
-
 {::include ../shared/text-blocks/key-words-rfc2119.mkd}
+
+
+{::include ../shared/text-blocks/terms-intro.mkd}
+
 {::include ../shared/text-blocks/handshake.mkd}
 {::include ../shared/text-blocks/trustwords.mkd}
 {::include ../shared/text-blocks/tofu.mkd}
--- a/pep-trustwords/draft-birk-pep-trustwords.mkd
+++ b/pep-trustwords/draft-birk-pep-trustwords.mkd
@ -16,7 +16,6 @@ author:
 {::include ../shared/author_tags/bernie_hoeneisen.mkd}

 normative:
-  RFC2119:
  RFC4949:
 #   RFC7435:
  RFC8126:
@ -101,9 +100,12 @@ contact verification in Extensible Messaging and Presence Protocol
 (XMPP) {{RFC6120}}, for X.509 {{RFC3647}} certificate verification in
 browsers or in block chain applications for crypto currencies.

-# Terms

 {::include ../shared/text-blocks/key-words-rfc2119.mkd}
+
+
+{::include ../shared/text-blocks/terms-intro.mkd}
+
 {::include ../shared/text-blocks/handshake.mkd}
 <!-- {::include ../shared/text-blocks/trustwords.mkd} -->
 <!-- {::include ../shared/text-blocks/tofu.mkd} -->
--- a/pep/draft-birk-pep.mkd
+++ b/pep/draft-birk-pep.mkd
@ -156,13 +156,10 @@ Registration of Trustword Lists {{I-D.birk-pep-trustwords}}.
  which RFCs we rely. \]\]


-# Terms
-
-## Normative language
-
 {::include ../shared/text-blocks/key-words-rfc2119.mkd}

-## Other terms
+
+{::include ../shared/text-blocks/terms-intro.mkd}

 {::include ../shared/text-blocks/handshake.mkd}
 {::include ../shared/text-blocks/trustwords.mkd}
--- a/shared/text-blocks/key-words-rfc2119.mkd
+++ b/shared/text-blocks/key-words-rfc2119.mkd
@ -1,3 +1,5 @@
+##  Requirements Language
+
 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 {{!RFC2119}}.
--- a/shared/text-blocks/terms-intro.mkd
+++ b/shared/text-blocks/terms-intro.mkd
@ -0,0 +1,4 @@
+##  Terms
+
+The following terms are defined for the scope of this document:
+