Add user manuals for time module by ryan-steel · Pull Request #148 · eclipse-score/time

ryan-steel · 2026-08-04T14:33:22Z

Improvement

Adds user-facing documentation for S-CORE time module and its key components.

Description

Added module manuals for integration and troubleshooting
Added component manuals for time library, TimeSlave, and TimeDaemon
Added main index links so users can navigate module and component docs
Updates score_docs_as_code to 6.0.0 and updates score_time to use new docs bundles.

Related Ticket

closes #125 (improvement ticket)

It includes - An overall architecture introduction and a guide for choosing the right clock. - A detailed API description covering basic usage, lifecycle management, advanced subscriptions, and unit-testing patterns. - A dedicated integration guide for system integrators. - A troubleshooting guide for diagnosing common runtime issues.

…rib/score_inc_time into docs/ryan-steel-LudwigAtBosch-user-manual

github-actions · 2026-08-04T14:34:36Z

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: 6869ceec-ca81-4439-a1b8-10090026424b
Computing main repo mapping: 
WARNING: /home/runner/work/time/time/MODULE.bazel:13:7: The attribute 'compatibility_level' in module() is a no-op and will be removed in a future Bazel release. Please remove it from your MODULE.bazel file.
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 3 packages loaded
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

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

Analyzing: target //:license-check (144 packages loaded, 3098 targets configured)

Analyzing: target //:license-check (157 packages loaded, 6170 targets configured)

Analyzing: target //:license-check (162 packages loaded, 6219 targets configured)

Analyzing: target //:license-check (162 packages loaded, 6219 targets configured)

Analyzing: target //:license-check (165 packages loaded, 8106 targets configured)

Analyzing: target //:license-check (165 packages loaded, 8106 targets configured)

Analyzing: target //:license-check (165 packages loaded, 8106 targets configured)

Analyzing: target //:license-check (167 packages loaded, 8876 targets configured)

Analyzing: target //:license-check (169 packages loaded, 11296 targets configured)

Analyzing: target //:license-check (169 packages loaded, 11296 targets configured)

Analyzing: target //:license-check (169 packages loaded, 11296 targets configured)

Analyzing: target //:license-check (169 packages loaded, 11296 targets configured)

Analyzing: target //:license-check (169 packages loaded, 11296 targets configured)

INFO: Analyzed target //:license-check (170 packages loaded, 11422 targets configured).
[12 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox ... (2 actions running)
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[15 / 16] [Sched] Building license.check.license_check.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: 41.327s, Critical Path: 1.83s
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>]

github-actions · 2026-08-04T14:39:48Z

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

into docs/ryan-steel-LudwigAtBosch-user-manual

BjoernAtBosch · 2026-08-13T12:52:40Z

+<Module sphinx documentation template snippets for the module. The directives and their parameters
+should be updated according to the module and it's components.>


I think, this needs to be filled by something meaningful ...

BjoernAtBosch · 2026-08-13T12:56:55Z

Should we have those empty folders? Imho we should leave them away - especially those marked as optional.

BjoernAtBosch · 2026-08-13T12:57:39Z

Remove - see comment for config folder

BjoernAtBosch · 2026-08-13T13:15:59Z

+Polling the Current Time
+------------------------
+
+This method involves actively requesting the current time from the ``score::time`` framework. It is the simplest way to get a timepoint when needed.


Suggested change

Polling the Current Time

------------------------

This method involves actively requesting the current time from the ``score::time`` framework. It is the simplest way to get a timepoint when needed.

Polling the Current Vehicle Time

--------------------------------

This method involves actively requesting the current vehicle time from the ``score::time`` framework. It is the simplest way to get a timepoint when needed.

BjoernAtBosch · 2026-08-13T13:20:57Z

+Adapting for Your Application
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


Suggested change

Adapting for Your Application

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Adapting Your Application

~~~~~~~~~~~~~~~~~~~~~~~~~

BjoernAtBosch · 2026-08-13T13:35:51Z

What about subfolders module/release and verification_report (if we want to have empty folders)?

BjoernAtBosch · 2026-08-13T13:42:53Z

+
+Time Component
+==============
+


Maybe we should have a short sentence here and in the others, what these components are for, each

BjoernAtBosch · 2026-08-13T13:47:19Z

+The following argument is available to configure the ``TimeSlave`` at runtime:
+
+.. list-table::
+   :widths: 25 15 60
+   :header-rows: 1
+
+   * - Argument
+     - Overrides
+     - Description
+   * - ``-i, --interface <name>``
+     - ``iface_name``
+     - **Mandatory Runtime Parameter.** Specifies the Ethernet network interface. Although the internal default is "emac0", this **must** be set correctly at runtime to match the target hardware.


I think, we should remove this

It's not yet merged

I propose not to merge it, as gordon9901 will provide a json-based config, soon: feat: add TimeDaemon CIT with pip hub infrastructure #122

Suggested change

The following argument is available to configure the ``TimeSlave`` at runtime:

.. list-table::

:widths: 25 15 60

:header-rows: 1

* - Argument

- Overrides

- Description

* - ``-i, --interface <name>``

- ``iface_name``

- **Mandatory Runtime Parameter.** Specifies the Ethernet network interface. Although the internal default is "emac0", this **must** be set correctly at runtime to match the target hardware.

The following argument is available to configure the ``TimeSlave`` at runtime: <tbd>

BjoernAtBosch · 2026-08-13T13:50:08Z

+   ./time_slave --interface eth1
+
+.. attention::
+   The command-line parsing is currently incomplete. To change parameters other than the interface name, you must modify the default values in the ``GptpEngineOptions`` structure and recompile the application. A comprehensive configuration mechanism (e.g., via a JSON file) is planned for future versions.


Suggested change

./time_slave --interface eth1

.. attention::

The command-line parsing is currently incomplete. To change parameters other than the interface name, you must modify the default values in the ``GptpEngineOptions`` structure and recompile the application. A comprehensive configuration mechanism (e.g., via a JSON file) is planned for future versions.

./time_slave

.. attention::

The runtime configuration is currently incomplete. To change parameters, you must modify the default values in the ``GptpEngineOptions`` structure and recompile the application. A comprehensive configuration mechanism (e.g., via a JSON file) will come soon.

BjoernAtBosch · 2026-08-13T13:54:29Z

@@ -19,9 +19,3 @@ time_slave Component
   :maxdepth: 1

   component_classification


Why is that kept?

lavrovvalera · 2026-08-13T14:52:00Z

+
+.. _manual_time_api_usage:
+
+API Usage: Accessing Vehicle Time


I see here the Vehicle Time only.
but idea was,the module API provides the API to access the supported time bases, like chrono, hrlsc abd vehicle time

lavrovvalera · 2026-08-13T14:56:59Z

+
+.. _ components::
+
+Components


I don't see the components subfolder in the folder structure document
https://eclipse-score.github.io/score/main/contribute/general/folder.html

so, my question is why it is still here and do we really need it?

lavrovvalera · 2026-08-13T14:58:45Z

+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+Safety Manual


Do we really need it now?
it is empty anyway and not clarified if we will need it.

lavrovvalera · 2026-08-13T14:58:59Z

+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+Security Manual


Do we really need it now?
it is empty anyway and not clarified if we will need it.

lavrovvalera · 2026-08-13T15:02:45Z

you delete the file, but put the safety manual in manuals subfolder. I think it shall be here then.
the simuilar with security

ryan-steel and others added 9 commits July 15, 2026 12:44

docs: add examples user documentation

848c63d

docs: remove API specifics from the examples docs

853cba3

fix(docs): Correct RST structure and apply review feedback

c3fd62a

fix(docs): Integrate user manual into main documentation toctree

094c15e

Merge branch 'docs/document-examples' of https://github.com/etas-cont…

dac6b19

…rib/score_inc_time into docs/ryan-steel-LudwigAtBosch-user-manual

add user manuals

e9b552b

chore: address comments

fed85cb

chore: update docs_as_code version and use score_sphinx_bundle

a2771df

github-project-automation Bot added this to TIM - Time FT Aug 4, 2026

github-project-automation Bot moved this to In Progress in TIM - Time FT Aug 4, 2026

ryan-steel had a problem deploying to workflow-approval August 4, 2026 14:33 — with GitHub Actions Error

ryan-steel mentioned this pull request Aug 4, 2026

Add user manuals for time module #133

Closed

ryan-steel mentioned this pull request Aug 4, 2026

Add ts client component requirements #149

Draft

use docs_as_code 6.0 bundles

4ef0e0e

ryan-steel had a problem deploying to workflow-approval August 5, 2026 10:30 — with GitHub Actions Error

chore: format

96d8f66

ryan-steel requested a deployment to workflow-approval August 5, 2026 10:37 — with GitHub Actions Waiting

ryan-steel had a problem deploying to workflow-approval August 5, 2026 10:37 — with GitHub Actions Error

remove include_patterns

61e7a7e

ryan-steel had a problem deploying to workflow-approval August 5, 2026 12:54 — with GitHub Actions Error

This was referenced Aug 5, 2026

Add time slave component requirements #151

Draft

AZB #101279 Quality pack targets #150

Open

Update dependency score_docs_as_code to v6 - autoclosed #145

Closed

add time_daemon component requirements #153

Draft

ryan-steel force-pushed the docs/ryan-steel-LudwigAtBosch-user-manual branch from bf05f16 to d6cb760 Compare August 6, 2026 15:10

ryan-steel had a problem deploying to workflow-approval August 6, 2026 15:10 — with GitHub Actions Error

ryan-steel requested a review from lavrovvalera August 7, 2026 13:41

lavrovvalera reviewed Aug 10, 2026

View reviewed changes

chore: Merge branch 'main' of https://github.com/etas-contrib/score_time

6f90324

into docs/ryan-steel-LudwigAtBosch-user-manual

ryan-steel had a problem deploying to workflow-approval August 12, 2026 11:17 — with GitHub Actions Error

chore: address comments

4b65bb2

ryan-steel had a problem deploying to workflow-approval August 12, 2026 12:40 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 12, 2026 12:55 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 12, 2026 13:58 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 12, 2026 14:12 — with GitHub Actions Error

ryan-steel added 4 commits August 12, 2026 15:19

docs: use latest module_template layout, update to docs_as_code v7

d738c21

docs: update template IDs for module time

6017036

chore: update to docs-as-code 7.0.1

6cca2e7

chore: format

70c6f70

ryan-steel force-pushed the docs/ryan-steel-LudwigAtBosch-user-manual branch from fc5eec7 to 1345156 Compare August 12, 2026 14:19

ryan-steel had a problem deploying to workflow-approval August 12, 2026 14:20 — with GitHub Actions Error

ryan-steel requested a review from lavrovvalera August 12, 2026 14:30

ryan-steel force-pushed the docs/ryan-steel-LudwigAtBosch-user-manual branch from 1345156 to 70c6f70 Compare August 13, 2026 10:25

ryan-steel requested a deployment to workflow-approval August 13, 2026 10:25 — with GitHub Actions Waiting

BjoernAtBosch suggested changes Aug 13, 2026

View reviewed changes

lavrovvalera reviewed Aug 13, 2026

View reviewed changes

		<Module sphinx documentation template snippets for the module. The directives and their parameters
		should be updated according to the module and it's components.>

		@@ -19,9 +19,3 @@ time_slave Component
		:maxdepth: 1

		component_classification


		.. _ components::

		Components

Uh oh!

Conversation

ryan-steel commented Aug 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Improvement

Description

Related Ticket

Uh oh!

github-actions Bot commented Aug 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions Bot commented Aug 4, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ryan-steel commented Aug 4, 2026 •

edited

Loading

github-actions Bot commented Aug 4, 2026 •

edited

Loading