eclipse-score / eclipse-score/time

score/time_daemon: Create detailed design (comp_dd_sta)

Open
#87 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
2
Forks
12
Avg merge
3d 10h
Merged PRs (30d)
24

Description

> [!IMPORTANT]
> Link the implementing PR to this issue by including `Closes #87` in the PR description or commit message.

### What

Write the detailed design document for `score/time_daemon`.

Create `score/time_daemon/docs/detailed_design/index.rst` using the sphinx-needs `comp_dd_sta` directive. The detailed design bridges architecture and source code: decompose the component into units, document their responsibilities and interfaces, and connect every unit to requirements (`:implements:`) and architecture (`:satisfies:`). Reuse and embed existing PlantUML diagrams from `docs/features/time_daemon/_assets/`.

Units to cover: PTPMachine (state machine processing gPTP samples), VerificationMachine (TimeoutValidator, TimeJumpsValidator, SynchronizationValidator), MessageBroker (routes messages between sub-components), ControlFlowDivider (fan-out), IPC publisher/receiver (ts_client interaction layer), JobRunner, application entry point.

### Acceptance Criteria

- [ ] `comp_dd_sta` directive in place with `:status: valid`
- [ ] All internal units (PTPMachine, VerificationMachine, MessageBroker, ControlFlowDivider, IPC layer, JobRunner) visible in static view
- [ ] `:implements:` and `:satisfies:` links present for every unit
- [ ] `req-Id` traceability comments in source for every traced unit

### References

- [S-CORE Implementation & Detailed Design](https://eclipse-score.github.io/process_description/main/process_areas/implementation/)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.