Skip to content

Commit af7a94d

Browse files
committed
README: Use recommended RFC 2119 wording
Match the recommendation in the RFC's abstract [1]. Also bump "keywords" -> "key words" in the subsequent C99 sentence for consistency. [1]: https://tools.ietf.org/html/rfc2119 Signed-off-by: W. Trevor King <[email protected]>
1 parent cc983bb commit af7a94d

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Table of Contents
2323
- [Windows-specific Configuration](config-windows.md)
2424
- [Glossary](glossary.md)
2525

26-
In the specifications in the above table of contents, the keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).
26+
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119][rfc2119].
2727

28-
The keywords "unspecified", "undefined", and "implementation-defined" are to be interpreted as described in the [rationale for the C99 standard][c99-unspecified].
28+
The key words "unspecified", "undefined", and "implementation-defined" are to be interpreted as described in the [rationale for the C99 standard][c99-unspecified].
2929

3030
An implementation is not compliant for a given CPU architecture if it fails to satisfy one or more of the MUST, REQUIRED, or SHALL requirements for the protocols it implements.
3131
An implementation is compliant for a given CPU architecture if it satisfies all the MUST, REQUIRED, and SHALL requirements for the protocols it implements.
@@ -168,3 +168,4 @@ Read more on [How to Write a Git Commit Message](http://chris.beams.io/posts/git
168168
[c99-unspecified]: http://www.open-std.org/jtc1/sc22/wg14/www/C99RationaleV5.10.pdf#page=18
169169
[UberConference]: https://www.uberconference.com/opencontainers
170170
[irc-logs]: http://ircbot.wl.linuxfoundation.org/eavesdrop/%23opencontainers/
171+
[rfc2119]: http://tools.ietf.org/html/rfc2119

0 commit comments

Comments
 (0)