Add RFC 5531 Record Marking Standard references to XDRStream#5136
Open
leighmcculloch wants to merge 3 commits intomasterfrom
Open
Add RFC 5531 Record Marking Standard references to XDRStream#5136leighmcculloch wants to merge 3 commits intomasterfrom
leighmcculloch wants to merge 3 commits intomasterfrom
Conversation
Document that getXDRSize and writeOne implement the Record Marking Standard defined in RFC 5531 Section 11, clarifying the fragment header format and the last-fragment flag bit.
There was a problem hiding this comment.
Pull request overview
Adds clearer, spec-linked documentation around the Record Marking Standard (RFC 5531 §11) used by XDRStream record framing, replacing informal “continuation bit” terminology with the RFC’s “last-fragment flag”.
Changes:
- Document
XDRInputFileStream::getXDRSizeas parsing the RFC 5531 record-marking fragment header layout. - Document
XDROutputFileStream::writeOneas writing a single-fragment record with the last-fragment flag set.
Move the Record Marking Standard documentation from individual function comments to the XDRInputFileStream and XDROutputFileStream class-level doc comments, and simplify the function-level comments to reference the class docs.
Agent: Claude Code Agent-Model: claude-opus-4-6 Agent-Session-Id: 5c1f5dda-9af4-4639-9bfc-573b1a09924a
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
1 participant
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.
Description
Add doc comments to
getXDRSizeandwriteOneinsrc/util/XDRStream.hreferencing RFC 5531 Section 11. Replace the informal "continuation bit" terminology with the RFC's "last-fragment flag" and document the full fragment header layout (bit 31 = last-fragment flag, bits 0-30 = data length).The existing comments describe the high bit as an XDR "continuation" bit, which is not a term the RFC uses and can mislead readers into thinking it is part of the XDR specification itself. Linking to RFC 5531 and using its terminology makes the code self-documenting and easier to cross-reference for anyone implementing compatible readers or writers.
Related
Checklist
clang-formatv8.0.0 (viamake formator the Visual Studio extension)