Skip to content

Create time module architecture documentation #84

Description

@lavrovvalera

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__<component>__<keyword> 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<Tag> 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Fields

    No fields configured for Task.

    Projects

    Status
    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions