eclipse-score / eclipse-score/time

Create time module architecture documentation

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

Description

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

### What

Write the architecture documentation for all four SW components of the `time` module.

Each SW component gets its own `comp_arc_sta` (and where non-trivial, `comp_arc_dyn`) directive. Every directive must link to requirements via `:fulfils: comp_req____` and have `:status: valid`. Existing PlantUML diagrams in `docs/features/time_daemon/_assets/` and `docs/features/time/_assets/` may be embedded or adapted.

| SW Component | Location | Elements to cover |
|---|---|---|
| `score/time` | `score/time/docs/architecture/index.rst` | `Clock` template, `ClockTraits`, `ClockSnapshot`, `VehicleClockBackend` interface, domain clock types, test utilities |
| `score/time_daemon` | `score/time_daemon/docs/architecture/index.rst` | PTPMachine, MessageBroker, VerificationMachine, ControlFlowDivider, IPC publish layer |
| `score/time_slave` | `score/time_slave/docs/architecture/index.rst` | gPTP adapter, PHC interface, platform abstraction (Linux/QNX), interaction with ts_client |
| `score/ts_client` | `score/ts_client/docs/architecture/index.rst` | GptpIpcPublisher, GptpIpcReceiver, shared memory channel |

### Acceptance Criteria

- [ ] Each SW component has a `comp_arc_sta` directive with `:status: valid`
- [ ] Every `comp_arc_sta` has `:fulfils:` linking to at least one `comp_req`
- [ ] The end-to-end data path `gPTP → ts_client → time_daemon → score/time API` is visible across the architecture docs
- [ ] `bazel run //:docs` builds without sphinx-needs errors for all architecture files

### References

- [S-CORE Architecture Design](https://eclipse-score.github.io/process_description/main/process_areas/architecture_design/guidance/architecture_guideline.html)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the four architecture/index.rst files named in the issue and inspect the existing PlantUML diagrams in docs/features/time_daemon/_assets/ and docs/features/time/_assets/. Check the component requirements and architecture directives first, then run bazel run //:docs. Done means all four components have valid, requirement-linked architecture documentation, the gPTP-to-score/time data path is visible, and the docs build without sphinx-needs errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.