From bb9299b97856f4f73ab8eab461c8629d9fa4e041 Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" Date: Tue, 4 Aug 2026 10:38:36 +0100 Subject: [PATCH 1/8] docs: ts_client component requirements template --- score/ts_client/docs/.gitkeep | 0 score/ts_client/docs/index.rst | 90 ++++++++ .../requirements/chklst_req_inspection.rst | 195 ++++++++++++++++++ score/ts_client/docs/requirements/index.rst | 21 ++ .../docs/requirements/requirements.rst | 105 ++++++++++ 5 files changed, 411 insertions(+) delete mode 100644 score/ts_client/docs/.gitkeep create mode 100644 score/ts_client/docs/index.rst create mode 100644 score/ts_client/docs/requirements/chklst_req_inspection.rst create mode 100644 score/ts_client/docs/requirements/index.rst create mode 100644 score/ts_client/docs/requirements/requirements.rst diff --git a/score/ts_client/docs/.gitkeep b/score/ts_client/docs/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/score/ts_client/docs/index.rst b/score/ts_client/docs/index.rst new file mode 100644 index 00000000..65761414 --- /dev/null +++ b/score/ts_client/docs/index.rst @@ -0,0 +1,90 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +.. _component_template: + +[Your Component Name] +##################### + +.. note:: Document header + +.. document:: [Your Component Name] + :id: doc__mod_temp_component_name + :status: draft + :version: 1 + :safety: ASIL_B + :security: NO + :realizes: wp__cmpt_request + :tags: template + +.. code-block:: rst + + .. comp:: Component Name + :id: comp__mod_temp_component_name_template + :security: YES + :safety: ASIL_B + :status: invalid + :implements: logic_arc_int__feature_name__interface_name1 + :consists_of: comp__component_name_internal_1, comp__component_name_internal_2, comp__component_name_internal_3 + :belongs_to: feat__feature_name + +.. attention:: + The above directives must be updated according to your Component. + + - Modify ``document`` to be your Component Name + - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` + - Adjust ``status`` to be ``valid`` + - Adjust ``safety`` and ``tags`` according to your needs + +Abstract +======== + +[A short (~200 word) description of the component.] + + +Specification +============= + +[Describe the requirements, architecture of any component.] or + + +How to Teach This +================= + +[How to teach users, new and experienced, how to apply the CR to their work.] + +.. note:: + For a CR that adds new functionality or changes behaviour, it is helpful to include a section on how to teach users, new and experienced, how to apply the CR to their work. + +Footnotes +========= + +[A collection of footnotes cited in the CR, and a place to list non-inline hyperlink targets.] + + +Further Documentation of the component can be found in the following sections: + +Component Detail Information +============================ + +.. toctree:: + :maxdepth: 1 + + architecture/index + detailed_design/index + requirements/index + safety_analysis/dfa + safety_analysis/fmea + safety_analysis/aou_requirements + component_classification diff --git a/score/ts_client/docs/requirements/chklst_req_inspection.rst b/score/ts_client/docs/requirements/chklst_req_inspection.rst new file mode 100644 index 00000000..07ab8a88 --- /dev/null +++ b/score/ts_client/docs/requirements/chklst_req_inspection.rst @@ -0,0 +1,195 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + + +.. document:: [Your Component Name] Requirements Inspection Checklist + :id: doc__mod_temp_component_name_req_inspection + :status: draft + :version: 2 + :safety: ASIL_B + :security: YES + :realizes: wp__requirements_inspect + :tags: template + +.. attention:: + The above directive must be updated according to your Component. + + - Modify ``Your Component Name`` to be your Component Name + - Modify ``id`` to be your Component Name in lower snake case preceded by ``doc__`` and followed by ``_req_inspection`` + - Adjust ``status`` to be ``valid`` + - Adjust ``safety``, ``security`` and ``tags`` according to your needs + +Requirement Inspection Checklist +================================ + +Purpose +------- + +The purpose of this requirement inspection checklist is to collect the topics to be checked during requirements inspection. + +Conduct +------- + +As described in the concept :need:`doc_concept__wp_inspections` the following "inspection roles" are expected to be filled: + +- content responsible (author): +- reviewer: +- moderator: +- test expert: + +Checklist +--------- + +It is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item and additionally to add in the remarks why it is passed or not passed. +In case of "no" an issue link to the issue tracking system has to be added in the last column (if not solved in the same issue). +See also :need:`doc_concept__wp_inspections` for further information about reviews in general and inspection in particular. + +.. list-table:: Component Requirement Inspection Checklist + :header-rows: 1 + :widths: 10,30,50,6,6,8 + + * - Review ID + - Acceptance Criteria + - Guidance + - Passed + - Remarks + - Issue link + * - REQ_01_01 + - Is the requirement formulation template used? + - see :need:`gd_temp__req_formulation`, this includes the use of "shall". + - + - + - + * - REQ_02_01 + - Is the requirement description *comprehensible* ? + - If you think the requirement is hard to understand, comment here. + - + - + - + * - REQ_02_02 + - Is the requirement description *unambiguous* ? + - Especially search for "weak words" like "about", "etc.", "relevant" and others (see the internet documentation on this). This check shall be supported by tooling. + - + - + - + * - REQ_02_03 + - Is the requirement description *atomic* ? + - A good way to think about this is to consider if the requirement may be tested by one (positive) test case or needs more of these. The requirement formulation template should also avoid being non-atomic already. Note that there are cases where also non-atomic requirements are the better ones, for example if those are better understandable. + - + - + - + * - REQ_02_04 + - Is the requirement description *feasible* ? + - If at the time of the inspection the requirement has already some implementation, the answer is yes. This can be checked via traces, but also :need:`gd_req__req_attr_impl` shows this. In case the requirement has no implementation at the time of inspection (i.e. not implemented at least as "proof-of-concept"), a development expert should be invited to the Pull-Request review to explicitly check this item. + - + - + - + * - REQ_02_05 + - Is the requirement description *independent from implementation* ? + - This checkpoint should improve requirements definition in the sense that the "what" is described and not the "how" - the latter should be described in architecture/design derived from the requirement. But there can also be a good reason for this, for example we would require using a file format like JSON and even specify the formatting standard already on stakeholder requirement level because we want to be compatible. A finding in this checkpoint does not mean there is a safety problem in the requirement. + - + - + - + * - REQ_03_01 + - Is the *linkage to the parent requirement* correct? + - Linkage to correct levels and ASIL attributes is checked automatically, but it needs checking if the child requirement implements (at least) a part of the parent requirement. + - + - + - + * - REQ_04_01 + - Is the requirement *internally and externally consistent*? + - Does the requirement contradict other requirements within the same or higher levels? One may restrict the search to the feature for component requirements, for features to other features using same components. Is the description of the requirement consistent with all its attributes (if not already part of another check, e.g. does the title fit?). + - + - + - + * - REQ_05_01 + - Do the software requirements consider *timing constraints*? + - This checkpoint encourages to think about timing constraints even if those are not explicitly mentioned in the parent requirement. If the reviewer of a requirement already knows or suspects that the code execution will be consuming a lot of time, one should think of the expectation of a "user". + - + - + - + * - REQ_06_01 + - Does the requirement consider *external interfaces*? + - The SW platform's external interfaces (to the user) are defined in the Feature Architecture, so the Feature and Component Requirements should determine the input data use and setting of output data for these interfaces. Are all output values defined? + - + - + - + * - REQ_07_01 + - Is the *safety* attribute set correctly? + - Derived requirements are checked automatically, see :need:`gd_req__req_linkage_safety`. But for the top level requirements (and also all AoU) this needs to be checked manually for correctness. + - + - + - + * - REQ_07_02 + - Is the attribute *security* set correctly? + - For component requirements this checklist item is supported by automated check: "Every requirement which satisfies a feature requirement with security attribute set to YES inherits this". But the component requirements/architecture may additionally also be subject to a :need:`wp__sw_component_security_analysis`. + - + - + - + * - REQ_08_01 + - Is the requirement *verifiable*? + - If at the time of the inspection already tests are created for the requirement, the answer is yes. This can be checked via traces, but also :need:`gd_req__req_attr_test_covered` shows this. In case the requirement is not sufficiently traced to test cases already, a test expert is invited to the inspection to give their opinion whether the requirement is formulated in a way that supports test development and the available test infrastructure is sufficient to perform the test. + - + - + - + * - REQ_08_02 + - Is the requirement verifiable by design or code review in case it is not feasibly testable? + - In very rare cases a requirement may not be verifiable by test cases, for example a specific non-functional requirement. In this case a requirement analysis verifies the requirement by design/code review. If such a requirement is in scope of this inspection, please check this here and link to the respective review record. A test expert is invited to the inspection to confirm their opinion that the requirement is not testable. + - + - + - + * - REQ_09_01 + - Do the requirements that define a safety mechanism specify the error reaction leading to a safe state? + - Alternatively to the safe state there could also be "repair" mechanisms. Also do not forget to consider REQ_05_01 for these. + - + - + - + * - REQ_10_01 + - Is the requirement description *complete* ? + - For every requirement in the inspection, follow to its parent (feature) requirement(s) and then check if this/these are fulfilled completely by its/their linked children (component requirements, including those which are not in scope of the inspection). + - + - + - + +.. attention:: + The above checklist entries must be filled according to your component requirements in scope. + +Note: If a Review ID is not applicable for your requirement, then state ""n/a" in status and comment accordingly in remarks. + +The following requirements in "valid" state and with "inspected" tag set are in the scope of this inspection: + +.. needtable:: + :filter: "component_name" in docname and "requirements" in docname and docname is not None and status == "valid" + :style: table + :types: comp_req + :tags: component_name + :columns: id;status;tags + :colwidths: 25,25,25 + :sort: title + +And also the following AoUs in "valid" state and with "inspected" tag set (for these please answer the questions above as if the AoUs are requirements, except question REQ_03_01): + +.. 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 + :columns: id;status;tags + :colwidths: 25,25,25 + :sort: title + +.. attention:: + The above tables filtering must be updated according to your Component. + + - Modify ``component_name`` to be your Component Name in lower snake case diff --git a/score/ts_client/docs/requirements/index.rst b/score/ts_client/docs/requirements/index.rst new file mode 100644 index 00000000..9eea1fc7 --- /dev/null +++ b/score/ts_client/docs/requirements/index.rst @@ -0,0 +1,21 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Requirements +############ + +.. toctree:: + + requirements + chklst_req_inspection diff --git a/score/ts_client/docs/requirements/requirements.rst b/score/ts_client/docs/requirements/requirements.rst new file mode 100644 index 00000000..4967cfe9 --- /dev/null +++ b/score/ts_client/docs/requirements/requirements.rst @@ -0,0 +1,105 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Component Requirements +############################# + +.. document:: [Your Component Name] Requirements + :id: doc__mod_temp_component_name_requirements + :status: draft + :version: 1 + :safety: ASIL_B + :security: YES + :realizes: wp__requirements_comp[version==1] + :tags: template + +.. attention:: + The above directive must be updated according to your Component. + + - Modify ``Your Component Name`` to be your Component Name + - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and followed by ``_requirements`` + - Adjust ``status`` to be ``valid`` + - Adjust ``safety``, ``security`` and ``tags`` according to your needs + + +=================================================================== + +Functional Requirements +----------------------- + +.. comp_req:: Some Title + :id: comp_req__mod_temp_component_name__some_title + :reqtype: Process + :security: YES + :safety: ASIL_B + :derived_from: feat_req__example_feature__example_req + :status: valid + :version: 1 + :satisfied_by: comp__mod_temp_component_name_template + + The Component shall do xyz to another component to bring it to this condition at this time + + Note: (optional, not to be verified) + +.. attention:: + The above directive must be updated according to your component requirements. + + - Replace the example content by the real content for your first requirement + - Set ``derived_from`` with links to Feature requirements + - Set ``satisfied_by`` with a link to the right Component id + - Set ``safety`` and ``security`` to the right value + - Set the status to valid and start the review/merge process + - Add other needed requirements for your component + +Assumption of Use Requirements +------------------------------ + +.. aou_req:: Next Title + :id: aou_req__mod_temp_component_name__next_title + :reqtype: Process + :security: YES + :safety: ASIL_B + :status: valid + :version: 1 + + The Component User shall do xyz to use the component safely/securely + +Environmental Requirements +-------------------------- + +.. aou_req:: Another Title + :id: aou_req__mod_temp_component_name__another + :reqtype: Process + :security: YES + :safety: ASIL_B + :status: invalid + :version: 1 + :tags: environment + + The Component shall only be used in a xyz environment to ensure its proper functioning. + +Hints +----- + +.. attention:: + The above directives must be updated according to your feature requirements. + + - Replace the example content by the real content for your first requirement (according to :need:`gd_guidl__req_engineering`) + - Set ``safety`` and ``security`` to the right value (ASIL B/QM; YES/NO) + - Set ``reqtype`` with a link to the right value () + - Add other needed requirements for your feature + - Set ``status`` to ``valid`` and start the review/merge process + +.. needextend:: is_external == False and "component_name" in id + :+tags: component_name From 9f530def845ccf7302a18e2e57a24b76d711a100 Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" Date: Tue, 4 Aug 2026 14:08:22 +0100 Subject: [PATCH 2/8] chore: update to latest docs_as_code implementation --- .gitignore | 16 +++++++++++++++- BUILD | 3 ++- MODULE.bazel | 5 +++-- MODULE.bazel.lock | 19 +++++++++++++++---- 4 files changed, 35 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 085f857a..6f14d581 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,16 @@ +# ******************************************************************************* +# 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 +# ******************************************************************************* + # Prerequisites *.d @@ -40,7 +53,8 @@ user.bazelrc .ruff_cache # docs:incremental and docs:ide_support build artifacts -/_build +_build +ubproject.toml # Vale - editorial style guide .vale.ini diff --git a/BUILD b/BUILD index cfb90305..de02da3e 100644 --- a/BUILD +++ b/BUILD @@ -23,8 +23,9 @@ setup_starpls( docs( data = [ "@score_process//:needs_json", + "@score_platform//:needs_json", ], - source_dir = "docs", + source_dir = ".", ) copyright_checker( diff --git a/MODULE.bazel b/MODULE.bazel index 19aa03e7..e21e4d7e 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -69,7 +69,7 @@ bazel_dep(name = "score_logging", version = "0.2.1") ### Modules that are used internally within the repository but not exposed as part of the public API -bazel_dep(name = "score_docs_as_code", version = "4.5.0") +bazel_dep(name = "score_docs_as_code", version = "6.0.0") bazel_dep(name = "score_cpp_policies", version = "0.0.1", dev_dependency = True) @@ -81,8 +81,9 @@ git_override( remote = "https://github.com/eclipse-score/score_cpp_policies.git", ) -bazel_dep(name = "score_process", version = "1.6.0", dev_dependency = True) +bazel_dep(name = "score_process", version = "2.0.2", dev_dependency = True) bazel_dep(name = "score_tooling", version = "1.2.0", dev_dependency = True) +bazel_dep(name = "score_platform", version = "0.6.3", dev_dependency = True) # cpp support in use_format_targets(languages=[...]) was added after 1.2.0. # Pin to the exact commit that introduced it; remove once published to the registry. diff --git a/MODULE.bazel.lock b/MODULE.bazel.lock index d00620c0..1f9aaf39 100644 --- a/MODULE.bazel.lock +++ b/MODULE.bazel.lock @@ -538,6 +538,8 @@ "https://bcr.bazel.build/modules/rules_swift/1.18.0/MODULE.bazel": "a6aba73625d0dc64c7b4a1e831549b6e375fbddb9d2dde9d80c9de6ec45b24c9", "https://bcr.bazel.build/modules/rules_swift/2.1.1/MODULE.bazel": "494900a80f944fc7aa61500c2073d9729dff0b764f0e89b824eb746959bc1046", "https://bcr.bazel.build/modules/rules_swift/2.1.1/source.json": "40fc69dfaac64deddbb75bd99cdac55f4427d9ca0afbe408576a65428427a186", + "https://bcr.bazel.build/modules/sphinxdocs/2.2.0/MODULE.bazel": "e046c573919d72605d62c352a08d9223a10aafef3a7cb70d0fe253ebdd97019e", + "https://bcr.bazel.build/modules/sphinxdocs/2.2.0/source.json": "b1da19a3d14a1dd8aa6a9ccaedc42bbe0313c8160a77ba5cca336cca1315298d", "https://bcr.bazel.build/modules/stardoc/0.5.0/MODULE.bazel": "f9f1f46ba8d9c3362648eea571c6f9100680efc44913618811b58cc9c02cd678", "https://bcr.bazel.build/modules/stardoc/0.5.1/MODULE.bazel": "1a05d92974d0c122f5ccf09291442580317cdd859f07a8655f1db9a60374f9f8", "https://bcr.bazel.build/modules/stardoc/0.5.3/MODULE.bazel": "c7f6948dae6999bf0db32c1858ae345f112cacf98f174c7a8bb707e41b974f1c", @@ -1017,7 +1019,9 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_crates/0.0.9/MODULE.bazel": "8f581e0a658a6dab149f381d783443cb00b559f4e9623956f8ff3de06108c550", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_dash_license_checker/0.1.1/MODULE.bazel": "76681dbd2d45b5c540869a2337174086c56c54953aab1d02cd878b59d31d13a5", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.7.0/MODULE.bazel": "f9a5971fbd05f0ed14e7a373dbf58af72a5c58d081537a75c314daaf61c92ae9", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.7.0/source.json": "a3f55522fd9f63fae7a92f3cb5f91c25ae7474a39e9f9c633f0cf797fc0ca8e5", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.8.0/MODULE.bazel": "89f855b94d041d2e61ff9667562fb4539c146249f6fb4c5dddf3d13bb9064aa7", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.9.0/MODULE.bazel": "2a04a354eb7a77d478bb43ba20b1dac0758af858172a760e4290621bef1a2f28", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.9.0/source.json": "6f72c780f1fb167be7cbc01801b86534a9e7102003168dcdf2c8886cfb1bb209", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/0.2.4/MODULE.bazel": "ea4801e96c87e2b8650a0fa9e5fed9b8bdbef05c1bc3e30003ba527d5af60a43", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/0.2.6/MODULE.bazel": "1af2963e91c6472555e222f0aba3dc2f5492d04598298209a361978ee3e321e3", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/0.3.3/MODULE.bazel": "95d2b7d44d461c1cf9bd016605f740716fd4ea1303f5f2ed93de3566b90feb1b", @@ -1035,7 +1039,10 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.0.1/MODULE.bazel": "5955f4cf37228a9cdda7f6009b81db0446f005c618f4bc43665bfa45f2673ebc", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.0.3/MODULE.bazel": "ad24df8df93882297e36ecaa39a94a69eed68aeb5bb1614e85296d001d5e3c03", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.5.0/MODULE.bazel": "4cfe52fe8b8dbeaf7e87500036391da278f72f1c2b41b689ffdd4337196dd8fe", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.5.0/source.json": "e01b29a3e9640a0d41d880d7da525e451115649d90f097ed66d09808c9135486", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.6.0/MODULE.bazel": "d5fbfed7b9bd65f10830e2290045dea639a8cfcaf9f9f0f7a1b12888c14e7d2b", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.6.1/MODULE.bazel": "0dae734ea8a99970a7417829b3115af02717b29f0fc40a8ebd3c1afcc71e1e21", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/6.0.0/MODULE.bazel": "ab2af2d8fab73e4512d2e2bd399a64d10c5c5463388322f7025637b13ec7585c", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/6.0.0/source.json": "c3992257800c4e3408be5e4656c0903fc19d3933011cc58e85d9a29c7214f374", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_format_checker/0.1.1/MODULE.bazel": "1acc254faa90e9f97b79ac69af25b6c21c561f8d6079914f6352b9b20d26bd37", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_lifecycle_health/0.2.0/MODULE.bazel": "a8cd3afc35e04172175acdc9aa82e3844f8ab8ed370712d9e3b4d0210ae1ccf9", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_lifecycle_health/0.2.0/source.json": "194330f4b3767ed21628e5c9c122551f28b776df18650005221866fa6860a1a8", @@ -1044,7 +1051,8 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.1.0/MODULE.bazel": "cc9eae86e76f2a930510ed6e50ec991bb5661687e24881685b39c322087adf6f", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.1.1/MODULE.bazel": "eb086ba99f9319371fbbd0a9252dfd27b0817039b88bd4d691602974b1ada005", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.5.5/MODULE.bazel": "070fa5fb10456e50675bcad2958fec0ed834f0aadbd0b71f25917f9e7edae2e2", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.5.5/source.json": "1ce2e94f0e366eaae131091aaee2c16199c974e82959eec9d863c9b0c93f2fdc", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.6.3/MODULE.bazel": "2fdb3cca15348f127fc356b27f84bd58d841530a94c58aedeefe09c47d8bfe8a", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.6.3/source.json": "9594a1e59507baeccb71e6b2faace9677d4d5db2cc76b142f8577ccd1ff3f282", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.0.4/MODULE.bazel": "f74302cb90a7c4878db302276afae82966878099861dcfca3ef43256131dab52", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.0.5/MODULE.bazel": "ed17c232ebd65e9d50fd5c1832f90f95ffe95b2a1113d63a176295a2af64d111", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.1.0/MODULE.bazel": "97dd927309f87ecb73629725683028a5dbb37a49b1159c771292e6993569055b", @@ -1059,7 +1067,9 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.5.3/MODULE.bazel": "65024b7f23ce5f72bd6ffd455a67c042ecf56d267f0bf63a90330a3241781b7a", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.5.4/MODULE.bazel": "efd56704f1a93e670032e7c0e4fad97669aa3b348fb1a4cd40f67e4dd4c7037c", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.6.0/MODULE.bazel": "2496bc24311f69f49449ee85d8bb38e3b970cbfcf10d0a7f19b2d5262ce80e8d", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.6.0/source.json": "093424aa8bfed8705a3d142b21fe1d053258f2dd5eb1944941f6439b2c7157e9", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/2.0.1/MODULE.bazel": "88bff0ed46da79d87f8c441a6bf6b760ee7c194b282e7e54a8b7db6ea2354db9", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/2.0.2/MODULE.bazel": "6d2b227bb6880e9f6871cc8cf94c83399e35c188424f7e9b826262de8149ed43", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/2.0.2/source.json": "5ae55f0dabcddeb5bfae16ce480e2c065f907d2b0ed6a8e4ed7409b259b004ee", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_python_basics/0.3.0/MODULE.bazel": "785ddd5295213e36c31ab86bdc34f29c0f7d1b72e9abd931bb08f42c0e48e2e9", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_python_basics/0.3.1/MODULE.bazel": "99c491109937542e61df090222666a8613ef946fa7bb2b2d5ba648b2baba03ad", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_python_basics/0.3.2/MODULE.bazel": "f25490f64035a0e3a0d53ad9cb6164e8325ce6cf2a7ee68c6ae153840cb2497e", @@ -1069,6 +1079,7 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_rust_policies/0.0.5/MODULE.bazel": "7de02547bdf121d3dedf5141b97f0fd9a545bd255ff5c7b699056b35816ffad9", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_rust_policies/0.0.5/source.json": "22c8bf0a5cbf7c7b06f774f3f66498e0bc14346a8b2208f7427a8fbb78a42547", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_starpls_lsp/0.1.0/MODULE.bazel": "b2f8c4c8d8e851706255ff9002b448bff6e040b8f0c6adedbde2a09375aa16cc", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/sphinxdocs/2.2.0/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/stardoc/0.5.0/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/stardoc/0.5.1/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/stardoc/0.5.3/MODULE.bazel": "not found", From 1daac44516b68d52f6e8510520b32740eb913de4 Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" Date: Tue, 4 Aug 2026 15:25:25 +0100 Subject: [PATCH 3/8] docs: add ts_client component requirements --- docs/conf.py => conf.py | 20 +-- docs/index.rst => index.rst | 11 +- score/time_slave/docs/index.rst | 6 - score/ts_client/docs/index.rst | 63 +++------ .../requirements/chklst_req_inspection.rst | 10 +- .../docs/requirements/requirements.rst | 127 +++++++++--------- 6 files changed, 109 insertions(+), 128 deletions(-) rename docs/conf.py => conf.py (87%) rename docs/index.rst => index.rst (94%) diff --git a/docs/conf.py b/conf.py similarity index 87% rename from docs/conf.py rename to conf.py index a834ad1f..c3ee685b 100644 --- a/docs/conf.py +++ b/conf.py @@ -31,15 +31,17 @@ extensions = [ - "sphinx_design", - "sphinx_needs", "sphinxcontrib.plantuml", - "score_plantuml", - "score_metamodel", - "score_draw_uml_funcs", - "score_source_code_linker", - "score_layout", - "score_metrics", + "score_sphinx_bundle" +] + +include_patterns = [ + "index.rst", + "docs/**", + "score/time/docs/**", + "score/time_slave/docs/**", + "score/time_daemon/docs/**", + "score/ts_client/docs/**", ] exclude_patterns = [ @@ -51,7 +53,7 @@ ".venv_docs", ] -templates_path = ["templates"] +templates_path = ["docs/templates"] # Enable numref numfig = True diff --git a/docs/index.rst b/index.rst similarity index 94% rename from docs/index.rst rename to index.rst index e35c841d..65a8b5e9 100644 --- a/docs/index.rst +++ b/index.rst @@ -36,13 +36,20 @@ The main responsibilities of time_daemon include: - **Providing diagnostic information** for system monitoring - **Supporting additional verification mechanisms** such as QualifiedVehicleTime (QVT) for safety-critical applications -For a detailed concept and architectural design, please refer to the :doc:`time_daemon Concept Documentation `. +For a detailed concept and architectural design, please refer to the :doc:`time_daemon Concept Documentation `. .. toctree:: :maxdepth: 2 :caption: Contents: - features/index + docs/features/index + +.. toctree:: + :maxdepth: 1 + :caption: Component Documentation: + + score/time_slave/docs/index + score/ts_client/docs/index Project Layout -------------- diff --git a/score/time_slave/docs/index.rst b/score/time_slave/docs/index.rst index 6e07edcd..27df135f 100644 --- a/score/time_slave/docs/index.rst +++ b/score/time_slave/docs/index.rst @@ -19,9 +19,3 @@ time_slave Component :maxdepth: 1 component_classification - architecture/index - detailed_design/index - requirements/index - manuals/index - safety_analysis/index - security_analysis/index diff --git a/score/ts_client/docs/index.rst b/score/ts_client/docs/index.rst index 65761414..b917ebe7 100644 --- a/score/ts_client/docs/index.rst +++ b/score/ts_client/docs/index.rst @@ -12,67 +12,52 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -.. _component_template: +.. _ts_client: -[Your Component Name] -##################### +Time Sync Client +################ -.. note:: Document header +.. note:: IPC library for gPTP time synchronization data exchange -.. document:: [Your Component Name] - :id: doc__mod_temp_component_name - :status: draft +.. document:: Time Sync Client + :id: doc__time_ts_client + :status: valid :version: 1 - :safety: ASIL_B + :safety: QM :security: NO :realizes: wp__cmpt_request - :tags: template + :tags: time_ts_client .. code-block:: rst - .. comp:: Component Name - :id: comp__mod_temp_component_name_template + .. comp:: Time Sync Client + :id: comp__time_ts_client :security: YES - :safety: ASIL_B + :safety: QM :status: invalid - :implements: logic_arc_int__feature_name__interface_name1 - :consists_of: comp__component_name_internal_1, comp__component_name_internal_2, comp__component_name_internal_3 - :belongs_to: feat__feature_name + :implements: + :belongs_to: feat__time[version==1] -.. attention:: - The above directives must be updated according to your Component. - - - Modify ``document`` to be your Component Name - - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` - - Adjust ``status`` to be ``valid`` - - Adjust ``safety`` and ``tags`` according to your needs Abstract ======== -[A short (~200 word) description of the component.] - +This component provides IPC mechanisms for time synchronization data exchange between time daemons and client applications within an ECU. Specification ============= -[Describe the requirements, architecture of any component.] or - - -How to Teach This -================= +The component provides shared memory-based IPC for distributing time synchronization data with thread-safe, low-latency access: -[How to teach users, new and experienced, how to apply the CR to their work.] - -.. note:: - For a CR that adds new functionality or changes behaviour, it is helpful to include a section on how to teach users, new and experienced, how to apply the CR to their work. +* :need:`comp_req__time_ts_client__shared_memory_mgmt` +* :need:`comp_req__time_ts_client__data_publishing` +* :need:`comp_req__time_ts_client__data_reception` +* :need:`comp_req__time_ts_client__lockfree_sync` +* :need:`comp_req__time_ts_client__low_latency` Footnotes ========= -[A collection of footnotes cited in the CR, and a place to list non-inline hyperlink targets.] - - Further Documentation of the component can be found in the following sections: Component Detail Information @@ -81,10 +66,4 @@ Component Detail Information .. toctree:: :maxdepth: 1 - architecture/index - detailed_design/index requirements/index - safety_analysis/dfa - safety_analysis/fmea - safety_analysis/aou_requirements - component_classification diff --git a/score/ts_client/docs/requirements/chklst_req_inspection.rst b/score/ts_client/docs/requirements/chklst_req_inspection.rst index 07ab8a88..abc0e3c6 100644 --- a/score/ts_client/docs/requirements/chklst_req_inspection.rst +++ b/score/ts_client/docs/requirements/chklst_req_inspection.rst @@ -13,14 +13,14 @@ # ******************************************************************************* -.. document:: [Your Component Name] Requirements Inspection Checklist - :id: doc__mod_temp_component_name_req_inspection +.. document:: Time Sync Client Requirements Inspection Checklist + :id: doc__time_ts_client_req_inspection :status: draft :version: 2 - :safety: ASIL_B - :security: YES + :safety: QM + :security: NO :realizes: wp__requirements_inspect - :tags: template + :tags: time_ts_client .. attention:: The above directive must be updated according to your Component. diff --git a/score/ts_client/docs/requirements/requirements.rst b/score/ts_client/docs/requirements/requirements.rst index 4967cfe9..dc5c8cd3 100644 --- a/score/ts_client/docs/requirements/requirements.rst +++ b/score/ts_client/docs/requirements/requirements.rst @@ -12,94 +12,93 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Component Requirements -############################# +Component Time Sync Client Requirements +######################################## -.. document:: [Your Component Name] Requirements - :id: doc__mod_temp_component_name_requirements +.. document:: Time Sync Client Requirements + :id: doc__time_ts_client_requirements :status: draft :version: 1 - :safety: ASIL_B - :security: YES + :safety: QM + :security: NO :realizes: wp__requirements_comp[version==1] - :tags: template + :tags: requirements, ts_client_library -.. attention:: - The above directive must be updated according to your Component. - - - Modify ``Your Component Name`` to be your Component Name - - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and followed by ``_requirements`` - - Adjust ``status`` to be ``valid`` - - Adjust ``safety``, ``security`` and ``tags`` according to your needs - - -=================================================================== Functional Requirements ----------------------- -.. comp_req:: Some Title - :id: comp_req__mod_temp_component_name__some_title - :reqtype: Process - :security: YES - :safety: ASIL_B - :derived_from: feat_req__example_feature__example_req - :status: valid +.. comp_req:: Shared Memory Channel Management + :id: comp_req__time_ts_client__shared_memory_mgmt + :reqtype: Functional + :security: NO + :safety: QM + :derived_from: feat_req__time__vehicle_time_sync[version==1] + :status: invalid :version: 1 - :satisfied_by: comp__mod_temp_component_name_template - The Component shall do xyz to another component to bring it to this condition at this time + The ts_client component shall provide operations to create, open, and close shared memory segments for gPTP time synchronization data exchange. - Note: (optional, not to be verified) +.. comp_req:: Time Synchronization Data Publishing + :id: comp_req__time_ts_client__data_publishing + :reqtype: Functional + :security: NO + :safety: QM + :derived_from: feat_req__time__vehicle_time_sync[version==1] + :status: invalid + :version: 1 -.. attention:: - The above directive must be updated according to your component requirements. + The ts_client component shall provide a publisher interface that enables time daemon processes to write time synchronization metadata (synchronized time points, synchronization status, rate correction) to shared memory using single-writer semantics. - - Replace the example content by the real content for your first requirement - - Set ``derived_from`` with links to Feature requirements - - Set ``satisfied_by`` with a link to the right Component id - - Set ``safety`` and ``security`` to the right value - - Set the status to valid and start the review/merge process - - Add other needed requirements for your component +.. comp_req:: Time Synchronization Data Reception + :id: comp_req__time_ts_client__data_reception + :reqtype: Functional + :security: NO + :safety: QM + :derived_from: feat_req__time__vehicle_time_sync[version==1] + :status: invalid + :version: 1 -Assumption of Use Requirements ------------------------------- + The ts_client component shall provide a receiver interface that enables multiple reader processes to access time synchronization metadata from shared memory without blocking writers or other readers. -.. aou_req:: Next Title - :id: aou_req__mod_temp_component_name__next_title - :reqtype: Process - :security: YES - :safety: ASIL_B - :status: valid +.. comp_req:: Lock-Free Data Synchronization + :id: comp_req__time_ts_client__lockfree_sync + :reqtype: Functional + :security: NO + :safety: QM + :derived_from: feat_req__time__vehicle_time_sync[version==1] + :status: invalid :version: 1 - The Component User shall do xyz to use the component safely/securely + The ts_client component shall allow thread-safe, lock-free access to shared time synchronization data between publisher and receiver processes. -Environmental Requirements --------------------------- -.. aou_req:: Another Title - :id: aou_req__mod_temp_component_name__another - :reqtype: Process - :security: YES - :safety: ASIL_B +Non-Functional Requirements +--------------------------- + +.. comp_req:: Low-Latency Time Data Access + :id: comp_req__time_ts_client__low_latency + :reqtype: Non-Functional + :security: NO + :safety: QM + :derived_from: feat_req__time__vehicle_time_ctrl_flow[version==1] :status: invalid :version: 1 - :tags: environment - The Component shall only be used in a xyz environment to ensure its proper functioning. + The ts_client component shall provide time synchronization data access operations with minimal latency to support real-time time-sensitive applications. -Hints ------ +Assumption of Use Requirements +------------------------------ -.. attention:: - The above directives must be updated according to your feature requirements. +.. aou_req:: Single Publisher Process + :id: aou_req__time_ts_client__single_publisher + :reqtype: Process + :security: NO + :safety: QM + :status: invalid + :version: 1 - - Replace the example content by the real content for your first requirement (according to :need:`gd_guidl__req_engineering`) - - Set ``safety`` and ``security`` to the right value (ASIL B/QM; YES/NO) - - Set ``reqtype`` with a link to the right value () - - Add other needed requirements for your feature - - Set ``status`` to ``valid`` and start the review/merge process + The component user shall ensure that only one publisher process opens and writes to a shared memory segment to maintain data consistency. -.. needextend:: is_external == False and "component_name" in id - :+tags: component_name +.. needextend:: is_external == False and "time_ts_client" in id + :+tags: time_ts_client From ea9f58a59edca38e80269cf73c787f8c204850ec Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" Date: Tue, 4 Aug 2026 15:56:16 +0100 Subject: [PATCH 4/8] undo docs infra changes --- .gitignore | 16 +--------------- BUILD | 3 +-- MODULE.bazel | 5 ++--- MODULE.bazel.lock | 19 ++++--------------- conf.py => docs/conf.py | 20 +++++++++----------- index.rst => docs/index.rst | 11 ++--------- 6 files changed, 19 insertions(+), 55 deletions(-) rename conf.py => docs/conf.py (87%) rename index.rst => docs/index.rst (94%) diff --git a/.gitignore b/.gitignore index 6f14d581..085f857a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,16 +1,3 @@ -# ******************************************************************************* -# 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 -# ******************************************************************************* - # Prerequisites *.d @@ -53,8 +40,7 @@ user.bazelrc .ruff_cache # docs:incremental and docs:ide_support build artifacts -_build -ubproject.toml +/_build # Vale - editorial style guide .vale.ini diff --git a/BUILD b/BUILD index de02da3e..cfb90305 100644 --- a/BUILD +++ b/BUILD @@ -23,9 +23,8 @@ setup_starpls( docs( data = [ "@score_process//:needs_json", - "@score_platform//:needs_json", ], - source_dir = ".", + source_dir = "docs", ) copyright_checker( diff --git a/MODULE.bazel b/MODULE.bazel index e21e4d7e..19aa03e7 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -69,7 +69,7 @@ bazel_dep(name = "score_logging", version = "0.2.1") ### Modules that are used internally within the repository but not exposed as part of the public API -bazel_dep(name = "score_docs_as_code", version = "6.0.0") +bazel_dep(name = "score_docs_as_code", version = "4.5.0") bazel_dep(name = "score_cpp_policies", version = "0.0.1", dev_dependency = True) @@ -81,9 +81,8 @@ git_override( remote = "https://github.com/eclipse-score/score_cpp_policies.git", ) -bazel_dep(name = "score_process", version = "2.0.2", dev_dependency = True) +bazel_dep(name = "score_process", version = "1.6.0", dev_dependency = True) bazel_dep(name = "score_tooling", version = "1.2.0", dev_dependency = True) -bazel_dep(name = "score_platform", version = "0.6.3", dev_dependency = True) # cpp support in use_format_targets(languages=[...]) was added after 1.2.0. # Pin to the exact commit that introduced it; remove once published to the registry. diff --git a/MODULE.bazel.lock b/MODULE.bazel.lock index 1f9aaf39..d00620c0 100644 --- a/MODULE.bazel.lock +++ b/MODULE.bazel.lock @@ -538,8 +538,6 @@ "https://bcr.bazel.build/modules/rules_swift/1.18.0/MODULE.bazel": "a6aba73625d0dc64c7b4a1e831549b6e375fbddb9d2dde9d80c9de6ec45b24c9", "https://bcr.bazel.build/modules/rules_swift/2.1.1/MODULE.bazel": "494900a80f944fc7aa61500c2073d9729dff0b764f0e89b824eb746959bc1046", "https://bcr.bazel.build/modules/rules_swift/2.1.1/source.json": "40fc69dfaac64deddbb75bd99cdac55f4427d9ca0afbe408576a65428427a186", - "https://bcr.bazel.build/modules/sphinxdocs/2.2.0/MODULE.bazel": "e046c573919d72605d62c352a08d9223a10aafef3a7cb70d0fe253ebdd97019e", - "https://bcr.bazel.build/modules/sphinxdocs/2.2.0/source.json": "b1da19a3d14a1dd8aa6a9ccaedc42bbe0313c8160a77ba5cca336cca1315298d", "https://bcr.bazel.build/modules/stardoc/0.5.0/MODULE.bazel": "f9f1f46ba8d9c3362648eea571c6f9100680efc44913618811b58cc9c02cd678", "https://bcr.bazel.build/modules/stardoc/0.5.1/MODULE.bazel": "1a05d92974d0c122f5ccf09291442580317cdd859f07a8655f1db9a60374f9f8", "https://bcr.bazel.build/modules/stardoc/0.5.3/MODULE.bazel": "c7f6948dae6999bf0db32c1858ae345f112cacf98f174c7a8bb707e41b974f1c", @@ -1019,9 +1017,7 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_crates/0.0.9/MODULE.bazel": "8f581e0a658a6dab149f381d783443cb00b559f4e9623956f8ff3de06108c550", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_dash_license_checker/0.1.1/MODULE.bazel": "76681dbd2d45b5c540869a2337174086c56c54953aab1d02cd878b59d31d13a5", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.7.0/MODULE.bazel": "f9a5971fbd05f0ed14e7a373dbf58af72a5c58d081537a75c314daaf61c92ae9", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.8.0/MODULE.bazel": "89f855b94d041d2e61ff9667562fb4539c146249f6fb4c5dddf3d13bb9064aa7", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.9.0/MODULE.bazel": "2a04a354eb7a77d478bb43ba20b1dac0758af858172a760e4290621bef1a2f28", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.9.0/source.json": "6f72c780f1fb167be7cbc01801b86534a9e7102003168dcdf2c8886cfb1bb209", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.7.0/source.json": "a3f55522fd9f63fae7a92f3cb5f91c25ae7474a39e9f9c633f0cf797fc0ca8e5", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/0.2.4/MODULE.bazel": "ea4801e96c87e2b8650a0fa9e5fed9b8bdbef05c1bc3e30003ba527d5af60a43", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/0.2.6/MODULE.bazel": "1af2963e91c6472555e222f0aba3dc2f5492d04598298209a361978ee3e321e3", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/0.3.3/MODULE.bazel": "95d2b7d44d461c1cf9bd016605f740716fd4ea1303f5f2ed93de3566b90feb1b", @@ -1039,10 +1035,7 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.0.1/MODULE.bazel": "5955f4cf37228a9cdda7f6009b81db0446f005c618f4bc43665bfa45f2673ebc", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.0.3/MODULE.bazel": "ad24df8df93882297e36ecaa39a94a69eed68aeb5bb1614e85296d001d5e3c03", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.5.0/MODULE.bazel": "4cfe52fe8b8dbeaf7e87500036391da278f72f1c2b41b689ffdd4337196dd8fe", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.6.0/MODULE.bazel": "d5fbfed7b9bd65f10830e2290045dea639a8cfcaf9f9f0f7a1b12888c14e7d2b", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.6.1/MODULE.bazel": "0dae734ea8a99970a7417829b3115af02717b29f0fc40a8ebd3c1afcc71e1e21", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/6.0.0/MODULE.bazel": "ab2af2d8fab73e4512d2e2bd399a64d10c5c5463388322f7025637b13ec7585c", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/6.0.0/source.json": "c3992257800c4e3408be5e4656c0903fc19d3933011cc58e85d9a29c7214f374", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.5.0/source.json": "e01b29a3e9640a0d41d880d7da525e451115649d90f097ed66d09808c9135486", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_format_checker/0.1.1/MODULE.bazel": "1acc254faa90e9f97b79ac69af25b6c21c561f8d6079914f6352b9b20d26bd37", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_lifecycle_health/0.2.0/MODULE.bazel": "a8cd3afc35e04172175acdc9aa82e3844f8ab8ed370712d9e3b4d0210ae1ccf9", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_lifecycle_health/0.2.0/source.json": "194330f4b3767ed21628e5c9c122551f28b776df18650005221866fa6860a1a8", @@ -1051,8 +1044,7 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.1.0/MODULE.bazel": "cc9eae86e76f2a930510ed6e50ec991bb5661687e24881685b39c322087adf6f", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.1.1/MODULE.bazel": "eb086ba99f9319371fbbd0a9252dfd27b0817039b88bd4d691602974b1ada005", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.5.5/MODULE.bazel": "070fa5fb10456e50675bcad2958fec0ed834f0aadbd0b71f25917f9e7edae2e2", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.6.3/MODULE.bazel": "2fdb3cca15348f127fc356b27f84bd58d841530a94c58aedeefe09c47d8bfe8a", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.6.3/source.json": "9594a1e59507baeccb71e6b2faace9677d4d5db2cc76b142f8577ccd1ff3f282", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.5.5/source.json": "1ce2e94f0e366eaae131091aaee2c16199c974e82959eec9d863c9b0c93f2fdc", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.0.4/MODULE.bazel": "f74302cb90a7c4878db302276afae82966878099861dcfca3ef43256131dab52", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.0.5/MODULE.bazel": "ed17c232ebd65e9d50fd5c1832f90f95ffe95b2a1113d63a176295a2af64d111", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.1.0/MODULE.bazel": "97dd927309f87ecb73629725683028a5dbb37a49b1159c771292e6993569055b", @@ -1067,9 +1059,7 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.5.3/MODULE.bazel": "65024b7f23ce5f72bd6ffd455a67c042ecf56d267f0bf63a90330a3241781b7a", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.5.4/MODULE.bazel": "efd56704f1a93e670032e7c0e4fad97669aa3b348fb1a4cd40f67e4dd4c7037c", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.6.0/MODULE.bazel": "2496bc24311f69f49449ee85d8bb38e3b970cbfcf10d0a7f19b2d5262ce80e8d", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/2.0.1/MODULE.bazel": "88bff0ed46da79d87f8c441a6bf6b760ee7c194b282e7e54a8b7db6ea2354db9", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/2.0.2/MODULE.bazel": "6d2b227bb6880e9f6871cc8cf94c83399e35c188424f7e9b826262de8149ed43", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/2.0.2/source.json": "5ae55f0dabcddeb5bfae16ce480e2c065f907d2b0ed6a8e4ed7409b259b004ee", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.6.0/source.json": "093424aa8bfed8705a3d142b21fe1d053258f2dd5eb1944941f6439b2c7157e9", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_python_basics/0.3.0/MODULE.bazel": "785ddd5295213e36c31ab86bdc34f29c0f7d1b72e9abd931bb08f42c0e48e2e9", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_python_basics/0.3.1/MODULE.bazel": "99c491109937542e61df090222666a8613ef946fa7bb2b2d5ba648b2baba03ad", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_python_basics/0.3.2/MODULE.bazel": "f25490f64035a0e3a0d53ad9cb6164e8325ce6cf2a7ee68c6ae153840cb2497e", @@ -1079,7 +1069,6 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_rust_policies/0.0.5/MODULE.bazel": "7de02547bdf121d3dedf5141b97f0fd9a545bd255ff5c7b699056b35816ffad9", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_rust_policies/0.0.5/source.json": "22c8bf0a5cbf7c7b06f774f3f66498e0bc14346a8b2208f7427a8fbb78a42547", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_starpls_lsp/0.1.0/MODULE.bazel": "b2f8c4c8d8e851706255ff9002b448bff6e040b8f0c6adedbde2a09375aa16cc", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/sphinxdocs/2.2.0/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/stardoc/0.5.0/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/stardoc/0.5.1/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/stardoc/0.5.3/MODULE.bazel": "not found", diff --git a/conf.py b/docs/conf.py similarity index 87% rename from conf.py rename to docs/conf.py index c3ee685b..a834ad1f 100644 --- a/conf.py +++ b/docs/conf.py @@ -31,17 +31,15 @@ extensions = [ + "sphinx_design", + "sphinx_needs", "sphinxcontrib.plantuml", - "score_sphinx_bundle" -] - -include_patterns = [ - "index.rst", - "docs/**", - "score/time/docs/**", - "score/time_slave/docs/**", - "score/time_daemon/docs/**", - "score/ts_client/docs/**", + "score_plantuml", + "score_metamodel", + "score_draw_uml_funcs", + "score_source_code_linker", + "score_layout", + "score_metrics", ] exclude_patterns = [ @@ -53,7 +51,7 @@ ".venv_docs", ] -templates_path = ["docs/templates"] +templates_path = ["templates"] # Enable numref numfig = True diff --git a/index.rst b/docs/index.rst similarity index 94% rename from index.rst rename to docs/index.rst index 65a8b5e9..e35c841d 100644 --- a/index.rst +++ b/docs/index.rst @@ -36,20 +36,13 @@ The main responsibilities of time_daemon include: - **Providing diagnostic information** for system monitoring - **Supporting additional verification mechanisms** such as QualifiedVehicleTime (QVT) for safety-critical applications -For a detailed concept and architectural design, please refer to the :doc:`time_daemon Concept Documentation `. +For a detailed concept and architectural design, please refer to the :doc:`time_daemon Concept Documentation `. .. toctree:: :maxdepth: 2 :caption: Contents: - docs/features/index - -.. toctree:: - :maxdepth: 1 - :caption: Component Documentation: - - score/time_slave/docs/index - score/ts_client/docs/index + features/index Project Layout -------------- From 2f4b1cca639578a4c69415c9ac7197830bda0992 Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" Date: Tue, 4 Aug 2026 16:02:17 +0100 Subject: [PATCH 5/8] add satisfied_by --- score/ts_client/docs/requirements/requirements.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/score/ts_client/docs/requirements/requirements.rst b/score/ts_client/docs/requirements/requirements.rst index dc5c8cd3..f5456d8b 100644 --- a/score/ts_client/docs/requirements/requirements.rst +++ b/score/ts_client/docs/requirements/requirements.rst @@ -36,6 +36,7 @@ Functional Requirements :derived_from: feat_req__time__vehicle_time_sync[version==1] :status: invalid :version: 1 + :satisfied_by: comp__time_ts_client The ts_client component shall provide operations to create, open, and close shared memory segments for gPTP time synchronization data exchange. @@ -47,6 +48,7 @@ Functional Requirements :derived_from: feat_req__time__vehicle_time_sync[version==1] :status: invalid :version: 1 + :satisfied_by: comp__time_ts_client The ts_client component shall provide a publisher interface that enables time daemon processes to write time synchronization metadata (synchronized time points, synchronization status, rate correction) to shared memory using single-writer semantics. @@ -58,6 +60,7 @@ Functional Requirements :derived_from: feat_req__time__vehicle_time_sync[version==1] :status: invalid :version: 1 + :satisfied_by: comp__time_ts_client The ts_client component shall provide a receiver interface that enables multiple reader processes to access time synchronization metadata from shared memory without blocking writers or other readers. @@ -69,6 +72,7 @@ Functional Requirements :derived_from: feat_req__time__vehicle_time_sync[version==1] :status: invalid :version: 1 + :satisfied_by: comp__time_ts_client The ts_client component shall allow thread-safe, lock-free access to shared time synchronization data between publisher and receiver processes. @@ -84,6 +88,7 @@ Non-Functional Requirements :derived_from: feat_req__time__vehicle_time_ctrl_flow[version==1] :status: invalid :version: 1 + :satisfied_by: comp__time_ts_client The ts_client component shall provide time synchronization data access operations with minimal latency to support real-time time-sensitive applications. @@ -98,7 +103,7 @@ Assumption of Use Requirements :status: invalid :version: 1 - The component user shall ensure that only one publisher process opens and writes to a shared memory segment to maintain data consistency. + The ts_client user shall ensure that only one publisher process opens and writes to a shared memory segment to maintain data consistency. .. needextend:: is_external == False and "time_ts_client" in id :+tags: time_ts_client From 2641242705c3cb78d541a7e9f6f690bf4e91071e Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" Date: Wed, 5 Aug 2026 14:16:46 +0100 Subject: [PATCH 6/8] add stub architecture docs for valid needs linkage --- .../architecture/chklst_arc_inspection.rst | 200 ++++++++++++++++++ .../architecture/component_architecture.rst | 115 ++++++++++ score/ts_client/docs/architecture/index.rst | 23 ++ score/ts_client/docs/index.rst | 12 +- 4 files changed, 339 insertions(+), 11 deletions(-) create mode 100644 score/ts_client/docs/architecture/chklst_arc_inspection.rst create mode 100644 score/ts_client/docs/architecture/component_architecture.rst create mode 100644 score/ts_client/docs/architecture/index.rst diff --git a/score/ts_client/docs/architecture/chklst_arc_inspection.rst b/score/ts_client/docs/architecture/chklst_arc_inspection.rst new file mode 100644 index 00000000..63f3bf1e --- /dev/null +++ b/score/ts_client/docs/architecture/chklst_arc_inspection.rst @@ -0,0 +1,200 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + + +.. document:: Time Sync Client Architecture Inspection Checklist + :id: doc__time_ts_client_arc_inspection + :status: draft + :version: 1 + :safety: QM + :security: NO + :realizes: wp__sw_arch_verification + :tags: time_ts_client + +Architecture Inspection Checklist +================================= + +Purpose +------- + +The purpose of the software architecture checklist is to ensure that the design meets the criteria and quality as +defined per project processes and guidelines for feature and component architectural design elements. +It helps to check the compliance with requirements, identify errors or inconsistencies, and ensure adherence to best +practices. +The checklist guides evaluation of the architecture design, identifies potential problems, and aids in +communication and documentation of architectural decisions to stakeholders. + +Conduct +------- + +As described in the concept :need:`doc_concept__wp_inspections` the following "inspection roles" are expected to be filled: + +- content responsible (author): +- reviewer: +- moderator: + +Checklist +--------- + +It is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item and additionally to add in the remarks why it is passed or not passed. +In case of "no" an issue link to the issue tracking system has to be added in the last column (if not solved in the same issue). +See also :need:`doc_concept__wp_inspections` for further information about reviews in general and inspection in particular. + +.. list-table:: Architecture Design Review Checklist + :header-rows: 1 + + * - Review Id + - Acceptance criteria + - Guidance + - passed + - Remarks + - Issue link + * - ARC_01_01 + - Is the traceability from software architectural elements to requirements, and other level architectural elements (e.g. component to interface) established according to the "Relations between the architectural elements" as described in :need:`doc_concept__arch_process`? + - Trace should be checked automatically by tool support in the future. Will be removed from the checklist once the requirement (:need:`Correlations of the architectural building blocks `) is implemented. Refer to `Tool Requirements `_ for the current status. + - + - + - + * - ARC_01_02 + - Does the software architecture design consider all the requirements allocated or belonging to the architectural element, including functional, non-functional, safety, and security requirements and all related design decisions? + - Check if all requirements allocated or belonging to the architectural element are considered in the design. This includes functional requirements (e.g. functional safety requirements), non-functional requirements (e.g. performance, reliability), and security requirements (e.g. confidentiality, integrity). Additionally, ensure that all related design decisions are taken into account and documented in the architectural design. + - + - + - + * - ARC_01_03 + - If the architectural element is related to any supplier manuals (incl. safety and security) + are the relevant parts covered? + - If the architecture makes use of supplied elements, their manuals (like safety) have to be considered (i.e. its provided functionality matches the expectation and assumptions are fulfilled). Note that in case of safety component this means that assumed Technical Safety Requirements and AoUs of the safety manual are covered. + - + - + - + * - ARC_01_04 + - Is the architectural element traceable to the lower level artifacts as defined by the workproduct traceability? + - Will be removed from checklist once the requirement (:need:`Correlations of the architectural building blocks `) is implemented by automated tool check. See `Tool Requirements `_. + Details of possible linking can be depicted from the traceability concept. + - + - + - + * - ARC_02_01 + - Is the software architecture design compliant with the (overall) feature architecture? + - On component level check against the feature architecture, on feature level check other features with common components used. + - + - + - + * - ARC_02_02 + - Is appropriate and comprehensible operation/interface naming present in the architectural design? + - Check :need:`gd_guidl__arch_design` + - + - + - + * - ARC_02_03 + - Are correctness of data flow and control flow within the architectural elements considered? + - E.g. examine definitions, transformations, integrity, and interaction of data; check error handling, data + exchange between elements, correct response to inputs and documented decision making. + Note: consistency is ensured by the process/tooling, by defining each interface only once. + - + - + - + * - ARC_02_04 + - Are the interfaces between the software architectural element and other architectural elements well-defined? + - Check if the interface reacts on non-defined behaviour or errors; can established protocols be used; are the + interfaces for inputs, outputs, error codes documented; is loose coupling considered and only limited exposure; + can unit or integration test be written against the interface; data amount transferred; no sensitive data + exposure; + - + - + - + * - ARC_02_05 + - Does the software architectural element consider the timing constraints (from the parent requirement)? + - If there are hard requirements on the timing a programming time estimation should be performed and also + deadline supervision considered. + - + - + - + * - ARC_02_06 + - Is the documentation of the software architectural element, including textual and graphical descriptions + (e.g., UML diagrams), comprehensible and complete? + - Use of semi-formal notation is expected for architectural elements with an allocated ASIL level. + Is the architecture template correctly filled? + - + - + - + * - ARC_03_01 + - Is the architectural element modular and encapsulated? + - Check e.g. that only minimal interfaces are used. Design should be object oriented. Interfaces and interactions are clearly defined. Usage of access types (private, protected) properly set. Limited global variables. + - + - + - + * - ARC_03_02 + - Is the suitability of the software architecture for future modifications and maintainability considered? + - Check for e.g. loose coupling, separation of concerns, high cohesion, versioning strategy for interfaces, + decision records, use of established design patterns. + - + - + - + * - ARC_03_03 + - Are simplicity and avoidance of unnecessary complexity present in the software architecture and the component? + - Indicators for complexity are: number of use cases (corresponding to dynamic diagrams) + allocated to single design element, number of interfaces and operations in an interface, + function parameters, global variables, complex types, limited comprehensibility. + The belonging code metrics should be checked. + + Notes: + + If the "number of use cases" or "number of interfaces" above exceeds "3" or "number of function parameters" exceeds "5" or the "number of operations" exceeds "20" or global variables are used, a design rationale is mandatory. + + See also if component classification :need:`gd_temp__component_classification` as measure is present. + + - + - + - + * - ARC_03_04 + - Is the software architecture design following best practices and design principles? + - Refer to architectural guidelines and recommendations within the project documentation. + - + - + - + * - ARC_04_03 + - If your software architectural design of the component includes processes and tasks, are their scheduling policies and priorities (at least the needed relation one to another) defined to ensure that timing requirements are met? Please note, that the particular priorities or priority ranges will be probably defined by the project handbook or the software development plan. + + Note: see :need:`std_req__iso26262__software_743` + - Give a reason for these scheduling policies and priorities or explain why not needed. + - + - + - + + +Note: If a Review ID is not applicable for your architecture, then state ""n/a" in status and comment accordingly in remarks. + +The following static views in "valid" state and with "inspected" tag set are in the scope of this inspection: + +.. needtable:: + :filter: "ts_client" in docname and "architecture" in docname and docname is not None and status == "valid" + :style: table + :types: comp_arc_sta + :tags: time_ts_client + :columns: id;status;tags + :colwidths: 25,25,25 + :sort: title + +and the following dynamic views: + +.. needtable:: + :filter: "ts_client" in docname and "architecture" in docname and docname is not None and status == "valid" + :style: table + :types: comp_arc_dyn + :tags: time_ts_client + :columns: id;status;tags + :colwidths: 25,25,25 + :sort: title diff --git a/score/ts_client/docs/architecture/component_architecture.rst b/score/ts_client/docs/architecture/component_architecture.rst new file mode 100644 index 00000000..cbb69e8f --- /dev/null +++ b/score/ts_client/docs/architecture/component_architecture.rst @@ -0,0 +1,115 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +.. _ts_client_component_architecture: + +Time Sync Client Architecture Documentation +=========================================== + +.. document:: Time Sync Client Architecture + :id: doc__time_ts_client_architecture + :status: draft + :version: 1 + :safety: QM + :security: NO + :realizes: wp__component_arch + :tags: time_ts_client + + +Overview +-------- + + + +Requirements Linked to Component Architecture +--------------------------------------------- + +.. needtable:: Overview of Component Requirements + :style: table + :columns: title;id + :filter: search("comp_arc_sta__archdes$", "fulfils_back") + :colwidths: 70,30 + +Description +----------- + + + + + + + +Rationale Behind Architecture Decomposition +******************************************* + +Mandatory: A motivation for the decomposition or reason for not further splitting it into internal components. + +.. note:: Common decisions across components / cross cutting concepts is at the higher level. + +Static Architecture +------------------- + +The components are designed to cover the expectations from the feature architecture +(i.e. if already exists a definition it should be taken over and enriched). + +A component can optional also consist of lower level components to further structure the architecture. The component and its static views can also optionally use interfaces provided by other components. + +.. comp:: Time Sync Client + :id: comp__time_ts_client + :security: NO + :safety: QM + :status: valid + :version: 1 + :belongs_to: feat__time + +.. comp_arc_sta:: Time Sync Client (Static View) + :id: comp_arc_sta__time_ts_client__sv + :security: NO + :safety: QM + :status: valid + :version: 1 + :belongs_to: comp__time_ts_client + :fulfils: + + .. needarch:: + :scale: 50 + :align: center + + {{ draw_component(need(), needs) }} + +Dynamic Architecture +-------------------- + +.. comp_arc_dyn:: Time Sync Client Dynamic View + :id: comp_arc_dyn__time_ts_client__dv + :security: NO + :safety: QM + :status: valid + :version: 1 + :belongs_to: comp__time_ts_client + :fulfils: + + Put here a sequence diagram + +Interfaces +---------- + +.. code-block:: rst + + .. real_arc_int:: + :id: real_arc_int__<component>__<Title> + :security: <YES|NO> + :safety: <QM|ASIL_B> + :fulfils: <link to component requirement id> + :language: cpp diff --git a/score/ts_client/docs/architecture/index.rst b/score/ts_client/docs/architecture/index.rst new file mode 100644 index 00000000..02fbfe12 --- /dev/null +++ b/score/ts_client/docs/architecture/index.rst @@ -0,0 +1,23 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +.. _ts_client_architecture: + +Time Sync Client Architecture +============================= + +.. toctree:: + + component_architecture + chklst_arc_inspection diff --git a/score/ts_client/docs/index.rst b/score/ts_client/docs/index.rst index b917ebe7..427ddc79 100644 --- a/score/ts_client/docs/index.rst +++ b/score/ts_client/docs/index.rst @@ -28,17 +28,6 @@ Time Sync Client :realizes: wp__cmpt_request :tags: time_ts_client -.. code-block:: rst - - .. comp:: Time Sync Client - :id: comp__time_ts_client - :security: YES - :safety: QM - :status: invalid - :implements: - :belongs_to: feat__time[version==1] - - Abstract ======== @@ -67,3 +56,4 @@ Component Detail Information :maxdepth: 1 requirements/index + architecture/index From a8c26c700b0e5594c4cd36111bc541fa0dab301e Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" <str1yok@bosch.com> Date: Thu, 6 Aug 2026 15:13:33 +0100 Subject: [PATCH 7/8] update safety classification to ASIL-B --- .../docs/architecture/chklst_arc_inspection.rst | 4 ++-- .../docs/architecture/component_architecture.rst | 10 +++++----- .../ts_client/docs/requirements/requirements.rst | 16 ++++++++-------- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/score/ts_client/docs/architecture/chklst_arc_inspection.rst b/score/ts_client/docs/architecture/chklst_arc_inspection.rst index 63f3bf1e..27952ced 100644 --- a/score/ts_client/docs/architecture/chklst_arc_inspection.rst +++ b/score/ts_client/docs/architecture/chklst_arc_inspection.rst @@ -17,7 +17,7 @@ :id: doc__time_ts_client_arc_inspection :status: draft :version: 1 - :safety: QM + :safety: ASIL-B :security: NO :realizes: wp__sw_arch_verification :tags: time_ts_client @@ -42,7 +42,7 @@ As described in the concept :need:`doc_concept__wp_inspections` the following "i - content responsible (author): <contributor/committer explicitly named here, who is the main author, as can be seen in config mgt tooling> - reviewer: <contributor/committer explicitly named here, who is the main content reviewer, must be different from content responsible> -- moderator: <committer explicitly named here, who is is the safety manager, security manager or quality manager initiating the inspection> +- moderator: <committer explicitly named here, who is the safety manager, security manager or quality manager initiating the inspection> Checklist --------- diff --git a/score/ts_client/docs/architecture/component_architecture.rst b/score/ts_client/docs/architecture/component_architecture.rst index cbb69e8f..9556cd30 100644 --- a/score/ts_client/docs/architecture/component_architecture.rst +++ b/score/ts_client/docs/architecture/component_architecture.rst @@ -21,7 +21,7 @@ Time Sync Client Architecture Documentation :id: doc__time_ts_client_architecture :status: draft :version: 1 - :safety: QM + :safety: ASIL-B :security: NO :realizes: wp__component_arch :tags: time_ts_client @@ -38,7 +38,7 @@ Requirements Linked to Component Architecture .. needtable:: Overview of Component Requirements :style: table :columns: title;id - :filter: search("comp_arc_sta__archdes$", "fulfils_back") + :filter: search("comp_arc_sta__time_ts_client__sv$", "fulfils_back") :colwidths: 70,30 Description @@ -68,7 +68,7 @@ A component can optional also consist of lower level components to further struc .. comp:: Time Sync Client :id: comp__time_ts_client :security: NO - :safety: QM + :safety: ASIL-B :status: valid :version: 1 :belongs_to: feat__time @@ -76,7 +76,7 @@ A component can optional also consist of lower level components to further struc .. comp_arc_sta:: Time Sync Client (Static View) :id: comp_arc_sta__time_ts_client__sv :security: NO - :safety: QM + :safety: ASIL-B :status: valid :version: 1 :belongs_to: comp__time_ts_client @@ -94,7 +94,7 @@ Dynamic Architecture .. comp_arc_dyn:: Time Sync Client Dynamic View :id: comp_arc_dyn__time_ts_client__dv :security: NO - :safety: QM + :safety: ASIL-B :status: valid :version: 1 :belongs_to: comp__time_ts_client diff --git a/score/ts_client/docs/requirements/requirements.rst b/score/ts_client/docs/requirements/requirements.rst index f5456d8b..c1800b08 100644 --- a/score/ts_client/docs/requirements/requirements.rst +++ b/score/ts_client/docs/requirements/requirements.rst @@ -19,10 +19,10 @@ Component Time Sync Client Requirements :id: doc__time_ts_client_requirements :status: draft :version: 1 - :safety: QM + :safety: ASIL-B :security: NO :realizes: wp__requirements_comp[version==1] - :tags: requirements, ts_client_library + :tags: requirements, time_ts_client Functional Requirements @@ -32,7 +32,7 @@ Functional Requirements :id: comp_req__time_ts_client__shared_memory_mgmt :reqtype: Functional :security: NO - :safety: QM + :safety: ASIL-B :derived_from: feat_req__time__vehicle_time_sync[version==1] :status: invalid :version: 1 @@ -44,7 +44,7 @@ Functional Requirements :id: comp_req__time_ts_client__data_publishing :reqtype: Functional :security: NO - :safety: QM + :safety: ASIL-B :derived_from: feat_req__time__vehicle_time_sync[version==1] :status: invalid :version: 1 @@ -56,7 +56,7 @@ Functional Requirements :id: comp_req__time_ts_client__data_reception :reqtype: Functional :security: NO - :safety: QM + :safety: ASIL-B :derived_from: feat_req__time__vehicle_time_sync[version==1] :status: invalid :version: 1 @@ -68,7 +68,7 @@ Functional Requirements :id: comp_req__time_ts_client__lockfree_sync :reqtype: Functional :security: NO - :safety: QM + :safety: ASIL-B :derived_from: feat_req__time__vehicle_time_sync[version==1] :status: invalid :version: 1 @@ -84,7 +84,7 @@ Non-Functional Requirements :id: comp_req__time_ts_client__low_latency :reqtype: Non-Functional :security: NO - :safety: QM + :safety: ASIL-B :derived_from: feat_req__time__vehicle_time_ctrl_flow[version==1] :status: invalid :version: 1 @@ -99,7 +99,7 @@ Assumption of Use Requirements :id: aou_req__time_ts_client__single_publisher :reqtype: Process :security: NO - :safety: QM + :safety: ASIL-B :status: invalid :version: 1 From 117b34b2dac7f74e4f0cf63d843dca46b3ee2f76 Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" <str1yok@bosch.com> Date: Thu, 6 Aug 2026 16:11:46 +0100 Subject: [PATCH 8/8] docs: update tags --- .../docs/architecture/chklst_arc_inspection.rst | 2 +- .../docs/architecture/component_architecture.rst | 8 ++++---- score/ts_client/docs/requirements/requirements.rst | 14 +++++++------- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/score/ts_client/docs/architecture/chklst_arc_inspection.rst b/score/ts_client/docs/architecture/chklst_arc_inspection.rst index 27952ced..a634181a 100644 --- a/score/ts_client/docs/architecture/chklst_arc_inspection.rst +++ b/score/ts_client/docs/architecture/chklst_arc_inspection.rst @@ -17,7 +17,7 @@ :id: doc__time_ts_client_arc_inspection :status: draft :version: 1 - :safety: ASIL-B + :safety: ASIL_B :security: NO :realizes: wp__sw_arch_verification :tags: time_ts_client diff --git a/score/ts_client/docs/architecture/component_architecture.rst b/score/ts_client/docs/architecture/component_architecture.rst index 9556cd30..34021d7e 100644 --- a/score/ts_client/docs/architecture/component_architecture.rst +++ b/score/ts_client/docs/architecture/component_architecture.rst @@ -21,7 +21,7 @@ Time Sync Client Architecture Documentation :id: doc__time_ts_client_architecture :status: draft :version: 1 - :safety: ASIL-B + :safety: ASIL_B :security: NO :realizes: wp__component_arch :tags: time_ts_client @@ -68,7 +68,7 @@ A component can optional also consist of lower level components to further struc .. comp:: Time Sync Client :id: comp__time_ts_client :security: NO - :safety: ASIL-B + :safety: ASIL_B :status: valid :version: 1 :belongs_to: feat__time @@ -76,7 +76,7 @@ A component can optional also consist of lower level components to further struc .. comp_arc_sta:: Time Sync Client (Static View) :id: comp_arc_sta__time_ts_client__sv :security: NO - :safety: ASIL-B + :safety: ASIL_B :status: valid :version: 1 :belongs_to: comp__time_ts_client @@ -94,7 +94,7 @@ Dynamic Architecture .. comp_arc_dyn:: Time Sync Client Dynamic View :id: comp_arc_dyn__time_ts_client__dv :security: NO - :safety: ASIL-B + :safety: ASIL_B :status: valid :version: 1 :belongs_to: comp__time_ts_client diff --git a/score/ts_client/docs/requirements/requirements.rst b/score/ts_client/docs/requirements/requirements.rst index c1800b08..b5de8f38 100644 --- a/score/ts_client/docs/requirements/requirements.rst +++ b/score/ts_client/docs/requirements/requirements.rst @@ -19,7 +19,7 @@ Component Time Sync Client Requirements :id: doc__time_ts_client_requirements :status: draft :version: 1 - :safety: ASIL-B + :safety: ASIL_B :security: NO :realizes: wp__requirements_comp[version==1] :tags: requirements, time_ts_client @@ -32,7 +32,7 @@ Functional Requirements :id: comp_req__time_ts_client__shared_memory_mgmt :reqtype: Functional :security: NO - :safety: ASIL-B + :safety: ASIL_B :derived_from: feat_req__time__vehicle_time_sync[version==1] :status: invalid :version: 1 @@ -44,7 +44,7 @@ Functional Requirements :id: comp_req__time_ts_client__data_publishing :reqtype: Functional :security: NO - :safety: ASIL-B + :safety: ASIL_B :derived_from: feat_req__time__vehicle_time_sync[version==1] :status: invalid :version: 1 @@ -56,7 +56,7 @@ Functional Requirements :id: comp_req__time_ts_client__data_reception :reqtype: Functional :security: NO - :safety: ASIL-B + :safety: ASIL_B :derived_from: feat_req__time__vehicle_time_sync[version==1] :status: invalid :version: 1 @@ -68,7 +68,7 @@ Functional Requirements :id: comp_req__time_ts_client__lockfree_sync :reqtype: Functional :security: NO - :safety: ASIL-B + :safety: ASIL_B :derived_from: feat_req__time__vehicle_time_sync[version==1] :status: invalid :version: 1 @@ -84,7 +84,7 @@ Non-Functional Requirements :id: comp_req__time_ts_client__low_latency :reqtype: Non-Functional :security: NO - :safety: ASIL-B + :safety: ASIL_B :derived_from: feat_req__time__vehicle_time_ctrl_flow[version==1] :status: invalid :version: 1 @@ -99,7 +99,7 @@ Assumption of Use Requirements :id: aou_req__time_ts_client__single_publisher :reqtype: Process :security: NO - :safety: ASIL-B + :safety: ASIL_B :status: invalid :version: 1