Skip to content

Add ts client component requirements - #149

Open
ryan-steel wants to merge 8 commits into
eclipse-score:mainfrom
etas-contrib:add-ts_client-component-requirements
Open

ryan-steel wants to merge 8 commits into
eclipse-score:mainfrom
etas-contrib:add-ts_client-component-requirements

Conversation

@ryan-steel

@ryan-steel ryan-steel commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Adds component requirements documentation for ts_client following S-CORE requirements engineering process and module_template.

Related ticket

Part of #75

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: 598bd7c4-15d2-4e51-9305-e16898540be3
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'platforms', the root module requires module version platforms@1.0.0, but got platforms@1.1.0 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
WARNING: For repository 'score_platform', the root module requires module version score_platform@0.7.1, but got score_platform@0.7.2 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
WARNING: For repository 'rules_oci', the root module requires module version rules_oci@2.2.7, but got rules_oci@2.3.0 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 3 packages loaded
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

Analyzing: target //:license-check (78 packages loaded, 10 targets configured)

Analyzing: target //:license-check (91 packages loaded, 10 targets configured)

Analyzing: target //:license-check (156 packages loaded, 3160 targets configured)

Analyzing: target //:license-check (161 packages loaded, 7129 targets configured)

Analyzing: target //:license-check (171 packages loaded, 9409 targets configured)

Analyzing: target //:license-check (172 packages loaded, 9417 targets configured)

Analyzing: target //:license-check (172 packages loaded, 9417 targets configured)

Analyzing: target //:license-check (175 packages loaded, 11305 targets configured)

Analyzing: target //:license-check (175 packages loaded, 11305 targets configured)

Analyzing: target //:license-check (176 packages loaded, 11429 targets configured)

Analyzing: target //:license-check (176 packages loaded, 11429 targets configured)

INFO: Analyzed target //:license-check (177 packages loaded, 11555 targets configured).
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[14 / 16] [Prepa] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 31.483s, Critical Path: 2.05s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

@ryan-steel
ryan-steel force-pushed the add-ts_client-component-requirements branch from 2956a19 to 1daac44 Compare August 4, 2026 14:49
@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@ryan-steel
ryan-steel marked this pull request as ready for review August 5, 2026 08:49
@ryan-steel
ryan-steel force-pushed the add-ts_client-component-requirements branch from 21fc11f to 2641242 Compare August 6, 2026 09:53
@ryan-steel
ryan-steel requested a lite review from Copilot August 6, 2026 10:01

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread score/ts_client/docs/requirements/requirements.rst Outdated
Comment thread score/ts_client/docs/requirements/chklst_req_inspection.rst
Comment thread score/ts_client/docs/requirements/chklst_req_inspection.rst Outdated
Comment thread score/ts_client/docs/architecture/chklst_arc_inspection.rst Outdated
Comment thread score/ts_client/docs/architecture/component_architecture.rst Outdated
@ryan-steel
ryan-steel force-pushed the add-ts_client-component-requirements branch from 8792013 to 29e3087 Compare August 19, 2026 13:28
@ryan-steel
ryan-steel marked this pull request as ready for review August 19, 2026 13:43
@ryan-steel
ryan-steel marked this pull request as draft August 19, 2026 16:02
@ryan-steel
ryan-steel marked this pull request as ready for review August 20, 2026 14:11
@ryan-steel
ryan-steel force-pushed the add-ts_client-component-requirements branch from a0a8c6f to 093756b Compare August 20, 2026 14:11

@BjoernAtBosch BjoernAtBosch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First chunk of comments

Comment thread score/ts_client/docs/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst Outdated
Comment thread score/ts_client/docs/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst
Comment thread score/ts_client/docs/requirements/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst
Comment thread score/ts_client/docs/requirements/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst Outdated
Comment thread score/ts_client/docs/requirements/index.rst Outdated

@BjoernAtBosch BjoernAtBosch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

: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]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

4 participants