Repository navigation
refactor: reconcile module naming with RELAY spec v1.14 §13.7.2 - #47
Merged
Merged
Conversation
RELAY spec v1.14 expanded §13.7.2's standard module-name registry with canonical names for RCP protocol-core concerns (avtp, acf, lifecycle, regmap, discovery, request, fragment, e2e). Comparing this repo's TC18 replacement against go/rust/c-RCP found two real naming deltas (#45): - rcp/wire.hpp bundled AVTPDU header framing together with ACF_ABB/ACF_GBB message-format encoding under the "wire" name, the inverse of the other three implementations' naming. Split into rcp/avtp.hpp (AVTPDU/NTSCF/TSCF framing) and rcp/acf.hpp (ACF_ABB/ACF_GBB message format), matching the registry's separate avtp/acf entries. rcp/legacy_wire.hpp (the pre-replacement 16-byte codec, still used internally by rcp/udp.hpp until v2.13.0) is unchanged. - rcp/sequencer.hpp already covered exactly the registry's `request` entry ("conditional-request taxonomy... and sequencers") in one file, so it is renamed rcp/request.hpp rather than split; SequencerTable keeps its name as the internal sequencer-state sub-concept. rcp/lifecycle.hpp, rcp/regmap.hpp, and rcp/discovery.hpp already matched the registry and needed no change. rcp/fragment.hpp is not created: this repo's ROADMAP.md milestone 52 (v2.8.0) already decided fragmentation no-go for this cycle, so there is no fragmentation logic anywhere in the tree to extract into a module — the issue's delta here was based on a "folded into wire.hpp" possibility that current code rules out. canbr.hpp/linbr.hpp's DEPRECATE-vs-ADAPT question flagged in the issue is a real cross-repo architectural difference, not a naming issue, and is left unresolved here as the issue requested. Pure rename/split, no behavior change: full build + ctest (59/59) pass, and RELAY `relay conform --strict` against the built CLI passes. Addresses #45 Signed-off-by: Matt <47545907+SoundMatt@users.noreply.github.com>
No behavior change; version bump to mark the rcp/wire.hpp -> rcp/avtp.hpp + rcp/acf.hpp split and rcp/sequencer.hpp -> rcp/request.hpp rename per RELAY spec v1.14 §13.7.2, matching this repo's convention of bumping kVersion/PROJECT_VERSION per merged PR. Signed-off-by: Matt <47545907+SoundMatt@users.noreply.github.com>
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
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.
Summary
Addresses #45. RELAY spec v1.14 expanded §13.7.2's standard module-name
registry with canonical names for RCP protocol-core concerns (
avtp,acf,lifecycle,regmap,discovery,request,fragment,e2e).This is a pure naming/structure reconciliation — no protocol behavior
change.
Verified each delta from #45 against current code before acting:
rcp/wire.hpp→rcp/avtp.hpp+rcp/acf.hpp— confirmed stillreal:
wire.hppbundled AVTPDU header framing together withACF_ABB/ACF_GBB message-format encoding under the "wire" name (the
inverse of how the other three RCP replacements name things). Split
into
rcp/avtp.hpp(AVTPDU/NTSCF/TSCF framing) andrcp/acf.hpp(ACF_ABB/ACF_GBB message format), matching the registry's separate
entries.
rcp/legacy_wire.hpp(the pre-replacement 16-byte codec,still used internally by
rcp/udp.hppuntil v2.13.0) is untouched.rcp/sequencer.hpp→rcp/request.hpp— confirmed still real, butit's a rename, not a split: the file already covered exactly the
registry's
requestentry ("conditional-request taxonomy... andsequencers") in one place.
SequencerTablekeeps its name as theinternal sequencer-state sub-concept within the module.
lifecycle,regmap,discovery— confirmed already correct, noaction (issue was right that this repo is the reference case here).
e2e— confirmed already correct, no action.requestmodule for conditional-request taxonomy — confirmed realat time of filing; resolved by the sequencer→request rename above,
since that file already held both halves the registry's
requestentry names.
fragment.hpp— not created. This repo's ROADMAP.md milestone52 (v2.8.0) already decided fragmentation no-go for this cycle (see the
milestone's "Done" writeup and
regmap.hpp'skOptFragmentationcomment) — there is no fragmentation logic anywhere in the tree to
extract into a module. The issue's phrasing ("if AVTPDU/ACF
fragmentation logic exists elsewhere... consider extracting") already
anticipated this might not apply; current code confirms it doesn't.
Added a short note to ROADMAP.md's disposition section so this isn't
re-litigated by a future pass.
canbr.hpp/linbr.hppDEPRECATE vs. ADAPT — left unresolved, asthe issue explicitly asked. This repo currently calls DEPRECATE; noting
it's still an open cross-repo architectural question, not a naming fix.
Also updated the doc comments, README module table, and
.fusa-reqs.jsonrequirement text that referenced the old module names, and added a short
"Post-hoc naming reconciliation" note to ROADMAP.md rather than rewriting
its historical per-milestone narrative (which still accurately describes
rcp/wire.hppas it existed at each point in time).Test plan
cmake --build(AppleClang, Release) — full build succeedsctest— all 59 tests pass (rcp_avtp,rcp_acf,rcp_requestnew/renamed;rcp_wire/rcp_sequencerremoved)cpp-rcp version/CLI build succeeds with-DRELAY_BUILD_CLI=ONrelay conform --strictagainst the builtcpp-rcpCLI — PASS