Add ts client component requirements - #149
ryan-steel wants to merge 8 commits into
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run //:license-checkStatus: Click to expand output |
2956a19 to
1daac44
Compare
|
The created documentation from the pull request is available at: docu-html |
21fc11f to
2641242
Compare
There was a problem hiding this comment.
Pull request overview
This PR adds S-CORE process documentation for the score/ts_client component, primarily introducing component requirements plus the associated inspection/checklist scaffolding and initial architecture documentation structure.
Changes:
- Added component requirements and AoU requirements for the Time Sync Client (
ts_client) in Sphinx-needs format. - Added requirements and architecture toctrees and inspection checklist documents for
ts_client. - Updated component doc navigation (including a change to
time_slave’s docs index).
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| score/ts_client/docs/requirements/requirements.rst | New component requirements and AoU requirement definitions for ts_client. |
| score/ts_client/docs/requirements/index.rst | Requirements section toctree for the ts_client docs. |
| score/ts_client/docs/requirements/chklst_req_inspection.rst | Requirements inspection checklist content and needtables (currently includes template placeholders). |
| score/ts_client/docs/index.rst | Top-level ts_client component doc entry and links to requirements/architecture sections. |
| score/ts_client/docs/architecture/index.rst | Architecture section toctree for the ts_client docs. |
| score/ts_client/docs/architecture/component_architecture.rst | Initial component architecture document and comp / static+dynamic view needs. |
| score/ts_client/docs/architecture/chklst_arc_inspection.rst | Architecture inspection checklist document. |
| score/ts_client/docs/.gitkeep | Placeholder for docs directory. |
| score/time_slave/docs/index.rst | Removes multiple toctree entries from the time_slave docs index. |
Suppressed comments (3)
score/ts_client/docs/requirements/chklst_req_inspection.rst:48
- Typo in the inspection roles list: duplicated "is" in "who is is".
- moderator: <committer explicitly named here, who is is the safety manager, security manager or quality manager initiating the inspection>
score/time_slave/docs/index.rst:22
- This PR removes the time_slave docs toctree entries for architecture/requirements/manuals/etc., but that change isn’t mentioned in the PR description. If the intent is to temporarily omit these sections (e.g., because the pages don’t exist yet), add an explanatory note here (or move this change to a separate PR).
.. toctree::
:maxdepth: 1
component_classification
score/ts_client/docs/requirements/chklst_req_inspection.rst:187
- The AoU inspection needtable still uses the template placeholder "component_name" in both the filter and tag selector, so it will never match this component’s needs.
.. needtable::
:filter: "component_name" in docname and "requirements" in docname and docname is not None and status == "valid"
:style: table
:types: aou_req
:tags: component_name
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
8792013 to
29e3087
Compare
a0a8c6f to
093756b
Compare
BjoernAtBosch
left a comment
There was a problem hiding this comment.
First chunk of comments
| :reqtype: Functional | ||
| :security: NO | ||
| :safety: ASIL_B | ||
| :derived_from: feat_req__time__vehicle_time_sync[version==1], feat_req__time__vehicle_time_ctrl_flow[version==1] |
There was a problem hiding this comment.
The referenced feature requirements (feat_req__time__vehicle_time_sync, vehicle_time_ctrl_flow, vehicle_time_acc_qual_api, vehicle_time_time_pt_qual) don't exist in this repo — no feat_req__time__vehicle_time_* is defined anywhere (only the feat_req__time__example_req placeholder in score/time/). The traceability links will be dead. Could you confirm where these are defined.
There was a problem hiding this comment.
Feature (and stakeholder) requirements are defined in the score "main" repo. See here: https://github.com/eclipse-score/score/blob/main/docs/features/time/requirements/index.rst.
The mentioned feat_req__time__example_req is an example requirement, part of the requirements template and should be removed with this PR.
| :version: 1 | ||
| :satisfied_by: comp__ts_client | ||
|
|
||
| The ts_client component shall exchange gPTP Peer Delay (PDelay) message metadata containing request origin timestamp, request receipt timestamp, response origin timestamp, response receipt timestamp, path delay measurement, request port number, response port number, and request clock identity. |
There was a problem hiding this comment.
The implementation (GptpIpcPDelayData in score/ts_client/src/gptp_ipc_data.h) also carries reference_global_timestamp, reference_local_timestamp, sequence_id, and resp_clock_identity — worth listing resp_clock_identity (and possibly the reference timestamps) for completeness?
Adds component requirements documentation for ts_client following S-CORE requirements engineering process and module_template.
Related ticket
Part of #75