docs(runtime): add delivery-profile ADR and simplification ARD#96
Merged
docs(runtime): add delivery-profile ADR and simplification ARD#96
Conversation
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.
Description
Add explicit architecture docs for runtime delivery profiles and for simplification policy, while keeping the implementation work on this branch limited to low-risk skeleton cleanup.
This matters because the branch is documenting the intended runtime direction before wider behavior changes land. It also improves
sof-supportstructure so the support crate is easier to navigate without changing its public API shape.Changes
Detailed list of what changed:
docs/architecture/adr/0013-runtime-delivery-profiles.md: adds the proposed runtime delivery profile ADR with explicit semantics, invariants, non-guarantees, rollout, and verification requirementsdocs/architecture/ard/0010-simplification-without-capability-regression.md: adds an explicit simplification policy for SOF so future cleanup preserves performance, stability, and capability boundariesdocs/architecture/README.md: indexes the new ADR/ARD entriescrates/sof-support/src/*: splits the previous largelib.rsimplementation into explicit named modules;lib.rsis now a small export surfacecrates/sof-observer/src/runtime.rs: adds typedRuntimeDeliveryProfileshape andRuntimeSetupserialization helper onlycrates/sof-observer/src/app/config/base.rs: adds lightweight env parsing coverage forRuntimeDeliveryProfilewithout changing wider runtime behaviorFor slice-related changes, include:
Motivation
Business motivation:
Make the runtime direction explicit before expanding downstream policy knobs, and make future simplification work defensible instead of ad hoc.
Technical motivation:
Reduce support-crate maintenance cost, document runtime delivery semantics clearly, and establish explicit guardrails for simplifying SOF without losing capability, stability, or performance.
Alternative approaches considered:
Scope and impact
RuntimeDeliveryProfilescaffolding; no public runtime behavior change yetTesting
Commands/results:
Results:
sof-supporttests passedRuntimeDeliveryProfiletests passed insofsof-supportclippy passed with-D warningsRelated issues and documentation
docs/runtime-profile-specdocs/architecture/README.mddocs/architecture/adr/0013-runtime-delivery-profiles.md,docs/architecture/ard/0010-simplification-without-capability-regression.mdReviewer checklist
docs/architecture/ard/0003-slice-dependency-contracts.md)Additional notes
This PR intentionally stops at docs plus skeleton cleanup. It does not attempt to wire
RuntimeDeliveryProfileinto queue sizing, ordering, or drain behavior on this branch.