diff options
| author | Alexandros Frantzis <alexandros.frantzis@collabora.com> | 2022-05-02 14:54:40 +0300 |
|---|---|---|
| committer | Jonas Ådahl <jadahl@gmail.com> | 2022-06-01 16:49:06 +0000 |
| commit | eb115b31375034725e8ad492e276da685b675d8f (patch) | |
| tree | 0a148eb6ad8f0c1e5baf2a61c50599bccde55259 | |
| parent | b06650146e565ffe980a54ecd95aa6f7227e30d4 (diff) | |
readme: Mandate proper use of RFC 2119 keywords
This mandate makes explicit a practice that's already established in
the writing of the protocol descriptions, and officially clarifies the
meaning of the keywords for readers.
Signed-off-by: Alexandros Frantzis <alexandros.frantzis@collabora.com>
| -rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
@@ -141,6 +141,26 @@ corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension. ``` +## Use of RFC 2119 keywords + +Descriptions of all new protocols must use (in lowercase) and adhere to the +proper meaning of the keywords described in +[RFC 2119](https://www.rfc-editor.org/info/rfc2119). + +All protocol descriptions that follow the guidelines in RFC 2119 must +incorporate the following text in their toplevel protocol description section: + +``` +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 IETF RFC 2119. +``` + +Note that not all existing protocol descriptions conform to RFC 2119. Protocol +maintainers are encouraged to audit their descriptions, update them as needed +to follow RFC 2119 guidelines, and mark them as conformant in the way described +in the previous paragraph. + ## Backward compatible protocol changes A protocol may receive backward compatible additions and changes. This |