[FEATURE] Audit authority, code quality and documentation in lib-tty #1
Labels
No labels
alpha-1
bug
ci
docs
duplicate
enhancement
help wanted
invalid
performance
phase-6
question
refactor
security
wontfix
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
erix/lib-tty#1
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Problem and motivation
Audit
lib-ttythroughout Phase 6. Separate PTY state/control from byte streams using caller-owned event storage and authenticated endpoint roles.Review each changed boundary at the final published revision. Prioritize security, reliability, then performance.
Proposed behavior and scope
Current inventory: 1 Cargo target (1 lib); manifests:
Cargo.toml. Include explicit and automatically discovered targets, supported features and target-specific configurations.Trace authority-bearing inputs through callers and public APIs. Confirm that the library acquires no service, hardware or host authority implicitly. Review startup, teardown and Rootd parity at the caller boundary when this crate owns no process, and justify each applicability decision.
Authority, security and reliability
Record each finding's affected revision, invariant, reproduction, owner, regression coverage and resolution. Report suspected vulnerabilities through SECURITY.md and keep sensitive details private. Record a result and rationale for each audit criterion, including caller responsibilities when this component has no process or Rust target.
Acceptance criteria
Checklist
missing_docsenforcement without blanket allowances or hidden-API escapes, warning-denied private-item rustdoc and an undocumented-public-API negative gate.cargo fmt --all -- --check, strict Clippy, unit/doctests and warning-denied builds/rustdoc for every owned crate/target under default and all valid feature, freestanding/host, SMP and profile combinations; test mutually exclusive combinations separately. Add focused VM regressions for runtime behavior and observe the older catalog and unit tests at the exact published heads.Alternatives and tradeoffs
Refactor within the component unless shared semantics justify extracting common code. Preserve regression coverage before deleting superseded paths. Profile before optimizing, and document ABI limits, hardware limits and explicit quotas. Preserve security and reliability requirements.
Downstream manifest/catalog adoption and actual consumer VM acceptance remain required; this is not full guest-build evidence.
Original coherent realm source CI acceptance — 18 September 2026: Signed
1c22be326c49bd0738d287549d943c661067ac59passes CI 13 and CI 12. Coherent catalog publication, actual consumer VMs and full guest-build acceptance remain separate open requirements.Tracking and rollout
Counted-contract dependency checkpoint — 25 September 2026: signed lib-tty a476932a selects the validated original IPC revision for counted realm startup, client lifecycle, seal and final accounting. Lib-input also adopts the corresponding bootstrap revision. Local Rust implementation bytes, APIs and capability policy are unchanged. The current roadmap consolidates repeated historical dependency prose; README, ARCHITECTURE and technical manual contracts remain applicable.
All 31 checks pass, including 12 unit tests in each of default/all-feature dev/release configurations, strict host/native Clippy, warning-denied native library builds, private host/native rustdoc, doctests, formatting, Markdown and exact dependency-source validation. Original CI20 and CI21 pass with all complete logs independently reviewed and zero warnings. No unchanged workflow was rerun. This dependency alignment is part of coordinated graph adoption; actual four-client I/O, native repeated managed-row reuse, Integration profiler observation and both complete builds inside EriX remain open. See the phase completion checklist.
Each of the four default/all-feature development/release selections passes 12 tests/doctests. Formatting, strict host/native Clippy, warning-denied builds, private rustdoc, Markdown and exact original dependency checks pass with zero warnings.
Actual running mediator readiness/retirement, complete service-image acceptance, configuration/seal, client I/O and both required guest rebuilds remain open.
Tracking: owning issue, WIP PR and Phase 6 acceptance.
Coordinated library dependency update — 15 September 2026
Both isolated native scenarios pass on their first attempts; full coordinated service-image execution remains open under Kernel design 19. This dependency/wire checkpoint does not establish complete lifecycle acceptance or either full EriX build generation.
No local API or capability policy changes. Actual service consumer and coherent full VM adoption remain open in phase completion.
Related records and contracts
[FEATURE] [P02.R55] Audit authority, code quality and documentation in lib-ttyto [FEATURE] Audit authority, code quality and documentation in lib-ttyThe terminal client now pins LibIPC
61b43723in 084d9aa2. This is part of the Vfsd dependency repair; the existing interfaces are unchanged, and Integration consumer adoption is in progress.