Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,31 @@ setup_starpls(
)

docs(
bundles = [
{
"bundle": "//score/time_slave:docs_bundle",
"mount_at": "time_slave",
"attach_to": "module/index",
},
{
"bundle": "//score/time_daemon:docs_bundle",
"mount_at": "time_daemon",
"attach_to": "module/index",
},
{
"bundle": "//score/ts_client:docs_bundle",
"mount_at": "ts_client",
"attach_to": "module/index",
},
{
"bundle": "//score/time:docs_bundle",
"mount_at": "time",
"attach_to": "module/index",
},
],
external_needs = [
"@score_process//:needs_json_file",
"@score_platform//:needs_json_file",
],
project = "S-CORE Time",
project_url = "https://eclipse-score.github.io/time",
Expand Down
1 change: 1 addition & 0 deletions MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ git_override(
remote = "https://github.com/eclipse-score/score_cpp_policies.git",
)

bazel_dep(name = "score_platform", version = "0.6.4", dev_dependency = True)
bazel_dep(name = "score_process", version = "2.0.3", dev_dependency = True)
bazel_dep(name = "score_tooling", version = "1.2.0", dev_dependency = True)

Expand Down
3 changes: 3 additions & 0 deletions MODULE.bazel.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ For a detailed concept and architectural design, please refer to the :doc:`time_
:caption: Contents:

features/index
module/index

Project Layout
--------------
Expand Down
45 changes: 45 additions & 0 deletions docs/module/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
..
# *******************************************************************************
# Copyright (c) 2026 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Module
======

The S-CORE ``time`` module provides a unified API for accessing system, steady, high-resolution steady, and PTP-synchronized vehicle time. The module contains four components: a client library for application-facing access, Time Slave for PTP clock synchronization, ``ts_client`` for shared-memory IPC between Time Slave and Time Daemon, and Time Daemon for synchronization quality validation before serving Vehicle Time.

.. code-block:: rst
Comment thread
mariuswbr marked this conversation as resolved.

.. mod:: Time
:id: mod__time
:includes: comp__component_name_template

Module View
-----------

.. code-block:: rst

.. mod_view_sta:: Time Module Static View
:id: mod_view_sta__time__time
:includes: comp__component_name_template

.. needarch::
:scale: 50
:align: center

{{ draw_module(need(), needs) }}

Module Documents
Comment thread
mariuswbr marked this conversation as resolved.
----------------

.. toctree::
:maxdepth: 1
7 changes: 7 additions & 0 deletions score/time/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@

load("@score_baselibs//:bazel/unit_tests.bzl", "cc_unit_test_suites_for_host_and_qnx")
load("@score_baselibs//third_party/itf:py_unittest_qnx_test.bzl", "py_unittest_qnx_test")
load("@score_docs_as_code//:docs.bzl", "docs_bundle")

docs_bundle(
name = "docs_bundle",
source_dir = "docs",
visibility = ["//visibility:public"],
)

py_unittest_qnx_test(
name = "qnx_unit_test_cases",
Expand Down
4 changes: 2 additions & 2 deletions score/time/docs/detailed_design/detailed_design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ A static view provides an overview of the units and their relationships using
UML 2.0 notations (e.g. class diagrams, component diagrams). Use ``.. uml::``
or ``.. image::`` directives to include the diagram.

.. uml:: dd_example_ex_sta.puml
.. .. uml:: dd_example_ex_sta.puml

Dynamic Diagrams for Unit Interactions (optional)
--------------------------------------------------
Expand All @@ -77,7 +77,7 @@ and interface documentation alone.
Use standard UML behavioural diagrams (sequence diagrams, state machine diagrams)
with ``.. uml::`` or ``.. image::`` directives.

.. uml:: dd_example_ex_dyn.puml
.. .. uml:: dd_example_ex_dyn.puml

Units within the Component
--------------------------
Expand Down
2 changes: 1 addition & 1 deletion score/time/docs/detailed_design/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ An example of documenting detailed design can be found in:

.. toctree::

detailed_design_example
detailed_design

Inspection Checklist
--------------------
Expand Down
2 changes: 1 addition & 1 deletion score/time/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Time
####

.. document:: Time
:id: doc__time
:id: doc__time_time
:status: draft
:version: 1
:safety: ASIL_B
Expand Down
24 changes: 13 additions & 11 deletions score/time/docs/requirements/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,21 @@ Component Time Requirements
Functional Requirements
-----------------------

.. comp_req:: Some Title
:id: comp_req__time__some_title
:reqtype: Functional
:security: NO
:safety: ASIL_B
:derived_from: feat_req__time__example_req
:status: invalid
:version: 1
:satisfied_by: comp__time
.. code-block:: rst

.. comp_req:: Some Title
:id: comp_req__time__some_title
:reqtype: Functional
:security: NO
:safety: ASIL_B
:derived_from: feat_req__time__example_req
:status: invalid
:version: 1
:satisfied_by: comp__time

The Component shall do xyz to another component to bring it to this condition at this time
The Component shall do xyz to another component to bring it to this condition at this time

Note: (optional, not to be verified)
Note: (optional, not to be verified)

.. attention::
The above directive must be updated according to your component requirements.
Expand Down
7 changes: 7 additions & 0 deletions score/time_daemon/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@
# *******************************************************************************

load("@score_baselibs//:bazel/unit_tests.bzl", "cc_unit_test_suites_for_host_and_qnx")
load("@score_docs_as_code//:docs.bzl", "docs_bundle")

docs_bundle(
name = "docs_bundle",
source_dir = "docs",
visibility = ["//visibility:public"],
)

cc_unit_test_suites_for_host_and_qnx(
name = "unit_test_suite",
Expand Down
24 changes: 13 additions & 11 deletions score/time_daemon/docs/requirements/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,21 @@ Component Time Daemon Requirements
Functional Requirements
-----------------------

.. comp_req:: Some Title
:id: comp_req__time_daemon__some_title
:reqtype: Process
:security: YES
:safety: ASIL_B
:derived_from: feat_req__example_feature__example_req
:status: invalid
:version: 1
:satisfied_by: comp__time_daemon
.. code-block:: rst

.. comp_req:: Some Title
:id: comp_req__time_daemon__some_title
:reqtype: Process
:security: YES
:safety: ASIL_B
:derived_from: feat_req__example_feature__example_req
:status: invalid
:version: 1
:satisfied_by: comp__time_daemon

The Component shall do xyz to another component to bring it to this condition at this time
The Component shall do xyz to another component to bring it to this condition at this time

Note: (optional, not to be verified)
Note: (optional, not to be verified)

.. attention::
The above directive must be updated according to your component requirements.
Expand Down
7 changes: 7 additions & 0 deletions score/time_slave/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@
# *******************************************************************************

load("@score_baselibs//:bazel/unit_tests.bzl", "cc_unit_test_suites_for_host_and_qnx")
load("@score_docs_as_code//:docs.bzl", "docs_bundle")

docs_bundle(
name = "docs_bundle",
source_dir = "docs",
visibility = ["//visibility:public"],
)

cc_unit_test_suites_for_host_and_qnx(
name = "unit_test_suite",
Expand Down
4 changes: 2 additions & 2 deletions score/time_slave/docs/detailed_design/detailed_design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ A static view provides an overview of the units and their relationships using
UML 2.0 notations (e.g. class diagrams, component diagrams). Use ``.. uml::``
or ``.. image::`` directives to include the diagram.

.. uml:: dd_example_ex_sta.puml
.. .. uml:: dd_example_ex_sta.puml

Dynamic Diagrams for Unit Interactions (optional)
--------------------------------------------------
Expand All @@ -77,7 +77,7 @@ and interface documentation alone.
Use standard UML behavioural diagrams (sequence diagrams, state machine diagrams)
with ``.. uml::`` or ``.. image::`` directives.

.. uml:: dd_example_ex_dyn.puml
.. .. uml:: dd_example_ex_dyn.puml

Units within the Component
--------------------------
Expand Down
2 changes: 1 addition & 1 deletion score/time_slave/docs/detailed_design/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ An example of documenting detailed design can be found in:

.. toctree::

detailed_design_example
detailed_design

Inspection Checklist
--------------------
Expand Down
20 changes: 20 additions & 0 deletions score/ts_client/BUILD
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# *******************************************************************************
# Copyright (c) 2026 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

load("@score_docs_as_code//:docs.bzl", "docs_bundle")

docs_bundle(
name = "docs_bundle",
source_dir = "docs",
visibility = ["//visibility:public"],
)
Loading