From dc017c2dd3c2e7526353342da93581c7463300ca Mon Sep 17 00:00:00 2001 From: Kim Brose <2803622+HarHarLinks@users.noreply.github.com> Date: Thu, 15 Aug 2024 11:31:50 +0200 Subject: [PATCH] Document that the spec uses RFC 2119 (#1928) Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com> --- .../appendices/newsfragments/1928.clarification | 1 + .../newsfragments/1928.clarification | 1 + .../client_server/newsfragments/1928.clarification | 1 + .../newsfragments/1928.clarification | 1 + .../internal/newsfragments/1928.clarification | 1 + .../push_gateway/newsfragments/1928.clarification | 1 + .../room_versions/newsfragments/1928.clarification | 1 + .../server_server/newsfragments/1928.clarification | 1 + content/_index.md | 14 ++++++++++++++ 9 files changed, 22 insertions(+) create mode 100644 changelogs/appendices/newsfragments/1928.clarification create mode 100644 changelogs/application_service/newsfragments/1928.clarification create mode 100644 changelogs/client_server/newsfragments/1928.clarification create mode 100644 changelogs/identity_service/newsfragments/1928.clarification create mode 100644 changelogs/internal/newsfragments/1928.clarification create mode 100644 changelogs/push_gateway/newsfragments/1928.clarification create mode 100644 changelogs/room_versions/newsfragments/1928.clarification create mode 100644 changelogs/server_server/newsfragments/1928.clarification diff --git a/changelogs/appendices/newsfragments/1928.clarification b/changelogs/appendices/newsfragments/1928.clarification new file mode 100644 index 00000000..e959ef1f --- /dev/null +++ b/changelogs/appendices/newsfragments/1928.clarification @@ -0,0 +1 @@ +Document that the spec uses RFC 2119. Contributed by @HarHarLinks. diff --git a/changelogs/application_service/newsfragments/1928.clarification b/changelogs/application_service/newsfragments/1928.clarification new file mode 100644 index 00000000..e959ef1f --- /dev/null +++ b/changelogs/application_service/newsfragments/1928.clarification @@ -0,0 +1 @@ +Document that the spec uses RFC 2119. Contributed by @HarHarLinks. diff --git a/changelogs/client_server/newsfragments/1928.clarification b/changelogs/client_server/newsfragments/1928.clarification new file mode 100644 index 00000000..e959ef1f --- /dev/null +++ b/changelogs/client_server/newsfragments/1928.clarification @@ -0,0 +1 @@ +Document that the spec uses RFC 2119. Contributed by @HarHarLinks. diff --git a/changelogs/identity_service/newsfragments/1928.clarification b/changelogs/identity_service/newsfragments/1928.clarification new file mode 100644 index 00000000..e959ef1f --- /dev/null +++ b/changelogs/identity_service/newsfragments/1928.clarification @@ -0,0 +1 @@ +Document that the spec uses RFC 2119. Contributed by @HarHarLinks. diff --git a/changelogs/internal/newsfragments/1928.clarification b/changelogs/internal/newsfragments/1928.clarification new file mode 100644 index 00000000..e959ef1f --- /dev/null +++ b/changelogs/internal/newsfragments/1928.clarification @@ -0,0 +1 @@ +Document that the spec uses RFC 2119. Contributed by @HarHarLinks. diff --git a/changelogs/push_gateway/newsfragments/1928.clarification b/changelogs/push_gateway/newsfragments/1928.clarification new file mode 100644 index 00000000..e959ef1f --- /dev/null +++ b/changelogs/push_gateway/newsfragments/1928.clarification @@ -0,0 +1 @@ +Document that the spec uses RFC 2119. Contributed by @HarHarLinks. diff --git a/changelogs/room_versions/newsfragments/1928.clarification b/changelogs/room_versions/newsfragments/1928.clarification new file mode 100644 index 00000000..e959ef1f --- /dev/null +++ b/changelogs/room_versions/newsfragments/1928.clarification @@ -0,0 +1 @@ +Document that the spec uses RFC 2119. Contributed by @HarHarLinks. diff --git a/changelogs/server_server/newsfragments/1928.clarification b/changelogs/server_server/newsfragments/1928.clarification new file mode 100644 index 00000000..e959ef1f --- /dev/null +++ b/changelogs/server_server/newsfragments/1928.clarification @@ -0,0 +1 @@ +Document that the spec uses RFC 2119. Contributed by @HarHarLinks. diff --git a/content/_index.md b/content/_index.md index a8c53809..ba49dc3a 100644 --- a/content/_index.md +++ b/content/_index.md @@ -99,6 +99,20 @@ services - be that for instant messages, VoIP call setups, or any other objects that need to be reliably and persistently pushed from A to B in an interoperable and federated manner. +### Requirement levels + +The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", +"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" across all parts of the +specification are to be interpreted as described in +[RFC 2119](https://datatracker.ietf.org/doc/html/rfc2119). + +Some entire sections of the specification might be optional depending on the +circumstances. For example, the +[modules of the client-server API](/client-server-api/#modules) +apply depending on the use case. The requirement level expressed by the above +key words appearing in such a section is only relevant if the section itself is +applicable. + ### Spec Change Proposals To propose a change to the Matrix Spec, see the explanations at