Skip to content

docs(core): document protobuf allocation behavior - #45

Open
ddurst-nvidia wants to merge 3 commits into
NVIDIA:mainfrom
ddurst-nvidia:dev/ddurst-nvidia/document-protobuf-resource-usage
Open

docs(core): document protobuf allocation behavior#45
ddurst-nvidia wants to merge 3 commits into
NVIDIA:mainfrom
ddurst-nvidia:dev/ddurst-nvidia/document-protobuf-resource-usage

Conversation

@ddurst-nvidia

@ddurst-nvidia ddurst-nvidia commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Document protobuf resource usage at the canonical outer decoder.
  • Document caller-side limits for direct decoding through yaml_sigil_core::pb and link the configurable Buffa message-size bound.
  • Forward allocation and input-limit guidance through the public core, transcription, signing transcoding, and verification entry points.
  • Keep generated protobuf source unchanged; documentation remains at hand-written API boundaries.
  • Clarify payload copying on successful verification.

Validation

  • RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --all-features --package yaml-sigil-core --package yaml-sigil-transcription --package yaml-sigil-signing --package yaml-sigil-verification
  • cargo xtask ci
  • git diff --check

Impact

This is API documentation only. It has no compatibility, dependency, licensing, or release-version impact.

@ddurst-nvidia
ddurst-nvidia force-pushed the dev/ddurst-nvidia/document-protobuf-resource-usage branch 2 times, most recently from dd885e1 to 47841b6 Compare August 26, 2026 23:59
@ddurst-nvidia

Copy link
Copy Markdown
Collaborator Author

/ok to test 47841b6

@ddurst-nvidia
ddurst-nvidia force-pushed the dev/ddurst-nvidia/document-protobuf-resource-usage branch from 47841b6 to 9967baa Compare August 28, 2026 23:27
Signed-off-by: ddurst <267424412+ddurst-nvidia@users.noreply.github.com>
Signed-off-by: ddurst <267424412+ddurst-nvidia@users.noreply.github.com>
Signed-off-by: ddurst <267424412+ddurst-nvidia@users.noreply.github.com>
@ddurst-nvidia
ddurst-nvidia force-pushed the dev/ddurst-nvidia/document-protobuf-resource-usage branch from 9967baa to 0931aec Compare August 29, 2026 00:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant