Reconcile 'content' and 'payload' #1703
Merged
Conversation
This file contains 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
I did a complete pass through and it wasn't that bad. As we agreed, payload is the bytes that we protect, content is the more abstract notion of what needs to be communicated (for which we use frames). That was already mostly right, apart from a few places. Closes #1676.
martinthomson
added
editorial
MikeBishop
approved these changes
Aug 27, 2018
draft-ietf-quic-transport.md
Outdated
| @@ -1109,7 +1109,7 @@ Stateless Reset do not contain frames. | |||
| | Frame N (*) ... | |||
| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | |||
| ~~~ | |||
| {: #packet-frames title="Contents of Protected Payload"} | |||
| {: #packet-frames title="QUIC Payload"} | |||
|
|
|||
| Protected payloads MUST contain at least one frame, and MAY contain multiple | |||
There was a problem hiding this comment.
You removed the term "protected payload" from the title of the figure, but not from the following paragraph.
draft-ietf-quic-transport.md
Outdated
| @@ -566,8 +566,8 @@ wishes to perform a stateless retry (see {{stateless-retry}}). | |||
|
|
|||
| A Retry packet (shown in {{retry-format}}) only uses the invariant portion of | |||
| the long packet header {{QUIC-INVARIANTS}}; that is, the fields up to and | |||
| including the Destination and Source Connection ID fields. The contents of the | |||
| Retry packet are not protected. Like Version Negotiation, a Retry packet | |||
| including the Destination and Source Connection ID fields. The Payload of a | |||
There was a problem hiding this comment.
Could go either way, but I'd lean toward not capitalizing this usage, or saying "The Payload field"
There was a problem hiding this comment.
I realized that we say that it has a Payload here, then say that it doesn't in the next sentence, so I changed this more.
martinthomson
force-pushed
the
payload-content
branch
2 times, most recently
from
3e798ec
to
f78d9f8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I did a complete pass through and it wasn't that bad. As we agreed,
payload is the bytes that we protect, content is the more abstract
notion of what needs to be communicated (for which we use frames). That
was already mostly right, apart from a few places.
Oh, and I didn't mention this, but I think that it's worth saying it. This isn't in the definitions section. We don't need to load that down with these little editorial conventions. We do that and it becomes unusable.
Closes #1676.