docs(proto-gtpv2c): make per-container PCO failure policy explicit - #618
docs(proto-gtpv2c): make per-container PCO failure policy explicit#618VerifiedOrganic wants to merge 3 commits into
Conversation
Document the per-container failure disposition as a stable contract in a policy table on decode_network_contents_correlated, with inline annotations at each match arm so consumers cannot mistake accidental error propagation for a protocol decision. Pin the configuration-atomicity policy (whole-value rejection for malformed address containers discards valid siblings) and the deliberate asymmetry against IPCP (unit-local discard) and IPv4 Link MTU (ignored) with dedicated tests. Refs #587 Signed-off-by: VerifiedOrganic <verifiedorganic@sent.com>
…ference Rustdoc intra-doc links to associated functions cannot carry custom anchor fragments. Replace with a plain text reference to the section name plus a working intra-doc link to the function itself. Refs #587 Signed-off-by: VerifiedOrganic <verifiedorganic@sent.com>
Signed-off-by: VerifiedOrganic <verifiedorganic@sent.com>
|
Current-main release-reconciliation evidence for the pushed candidate (not an independent-review certification): Coordinates
Scope/policy audit
Local verification
Transient diagnosis disclosed: the first complete workspace-test attempt had one Hosted workflows have materialized for exact head |
|
Final hosted-check reconciliation for exact candidate head
A final prune-fetch confirms Next action remains a fresh independent exact-head adversarial review of this bounded adopted-PCO malformed-container policy/documentation-runtime boundary. This is a request for independent review, not self-certification and not authorization to merge. |
Summary
Document the per-container failure disposition for adopted PCO container
handlers as an explicit, stable contract so consumers cannot mistake
accidental use of error propagation for a protocol decision.
Changes
decode_network_contents_correlatedrustdoc, citing the basis for eachclass: configuration-atomicity (address containers), TS 24.008 §10.5.6.3
(Link MTU ignore, unknown skip), and RFC 1661 §5.3 (IPCP unit-local
discard).
Failure policy:annotations at every match arm indecode_network_contents_correlatedso the policy is visible at thedecision point, not only in the doc comment above.
decode_network_contents.siblings are discarded when any address container is malformed.
IPCP malformed → siblings survive; address malformed → whole value
rejected; Link MTU malformed → ignored.
Verification
cargo fmt --all --check✓cargo clippy --workspace --all-targets --all-features -- -D warnings✓cargo test -p opc-proto-gtpv2c --all-features✓ (56 pco tests)RUSTDOCFLAGS="-D warnings" cargo doc -p opc-proto-gtpv2c --no-deps✓(rustdoc anchor) reproduced and fixed.
Refs #587