Use uppercase for RFC 2119 terms - #41
Open
jzern wants to merge 1 commit into
Open
Conversation
This removes the default conformance section which says: * [...] as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.* And adds a Terminology section at the beginning of the text to make the conventions more prominent. Fixes: #26
Contributor
📄 Specification PreviewThe AV2 ISOBMFF specification has been built and published for this PR. 🔗 Live preview
Built from commit 0bb2652 · Updated: Mon, 27 Jul 2026 19:00:31 GMT |
jzern
commented
Jul 27, 2026
|
|
||
| The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [[!RFC2119]] [[!RFC8174]] when, and only when, they appear in all capitals, as shown here. | ||
|
|
||
| All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. |
Author
There was a problem hiding this comment.
This text comes from the default conformance section: https://aomediacodec.github.io/av1-isobmff/#conformance
|
|
||
| <div class="example" id="example-example"><a class="self-link" href="#example-example"></a>This is an example of an informative example.</div> | ||
|
|
||
| Informative notes begin with the word "Note" and are set apart from the normative text with <code>class="note"</code>, like this: |
Author
There was a problem hiding this comment.
The note at line 317 has a 'may', which I made lowercase.
| - the trailing bits of an OBU carried in a sample SHALL be limited to those required for byte alignment as specified in [[!AV2]]; trailing bits SHALL NOT be used to pad an OBU beyond byte alignment; | ||
| - a sample SHALL NOT contain a [=Sequence Header OBU=]; sequence headers are carried in the <code>configOBUs</code> of the [=AV2CodecConfigurationBox=] of the active [=AV2SampleEntry=]; | ||
| - a sample SHALL NOT contain a [=Layer Configuration Record OBU=]; layer configuration records are carried in the <code>configOBUs</code> of the active [=AV2SampleEntry=]; | ||
| - a sample SHOULD NOT contain any other OBU whose contents do not change for the duration of the active [=AV2SampleEntry=], in order to avoid redundant data; for example, a [=Metadata OBU=] whose contents are constant should be carried in <code>configOBUs</code> rather than repeated in every sample, or discarded from the samples and conveyed at the ISOBMFF level. |
Author
There was a problem hiding this comment.
Note the 'should' after 'for example,' remains lowercase.
| Terminology {#terminology} | ||
| ========================== | ||
|
|
||
| The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [[!RFC2119]] [[!RFC8174]] when, and only when, they appear in all capitals, as shown here. |
Author
There was a problem hiding this comment.
"required" was not used in a way that would make it normative.
| } | ||
| </pre> | ||
|
|
||
| Terminology {#terminology} |
Author
There was a problem hiding this comment.
I've also seen something like 'Notation & Conventions' to describe this section.
jzern
marked this pull request as ready for review
July 27, 2026 19:04
jzern
requested review from
leo-barnes,
podborski and
y-guyon
and removed request for
podborski and
y-guyon
July 27, 2026 19:04
y-guyon
approved these changes
Jul 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This removes the default conformance section which says:
do not appear in all uppercase letters in this specification.*
And adds a Terminology section at the beginning of the text to make the
conventions more prominent.
Fixes: #26