From 308a6cd21829604970c8cb30ae90124c18a15dc0 Mon Sep 17 00:00:00 2001 From: Ryan Steel Date: Fri, 14 Aug 2026 13:47:18 +0100 Subject: [PATCH 01/11] docs: add module_template docs boilerplate to ts_client --- .../chklst_impl_inspection.rst | 125 +++++++++++ .../docs/detailed_design/detailed_design.rst | 96 +++++++++ .../ts_client/docs/detailed_design/index.rst | 45 ++++ score/ts_client/docs/index.rst | 75 +++++++ score/ts_client/docs/{ => manuals}/.gitkeep | 0 .../requirements/chklst_req_inspection.rst | 194 ++++++++++++++++++ score/ts_client/docs/requirements/index.rst | 24 +++ .../docs/requirements/requirements.rst | 106 ++++++++++ .../docs/safety_analysis/aou_requirements.rst | 62 ++++++ score/ts_client/docs/safety_analysis/dfa.rst | 60 ++++++ score/ts_client/docs/safety_analysis/fmea.rst | 133 ++++++++++++ .../ts_client/docs/security_analysis/.gitkeep | 0 12 files changed, 920 insertions(+) create mode 100644 score/ts_client/docs/detailed_design/chklst_impl_inspection.rst create mode 100644 score/ts_client/docs/detailed_design/detailed_design.rst create mode 100644 score/ts_client/docs/detailed_design/index.rst create mode 100644 score/ts_client/docs/index.rst rename score/ts_client/docs/{ => manuals}/.gitkeep (100%) 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 create mode 100644 score/ts_client/docs/safety_analysis/aou_requirements.rst create mode 100644 score/ts_client/docs/safety_analysis/dfa.rst create mode 100644 score/ts_client/docs/safety_analysis/fmea.rst create mode 100644 score/ts_client/docs/security_analysis/.gitkeep diff --git a/score/ts_client/docs/detailed_design/chklst_impl_inspection.rst b/score/ts_client/docs/detailed_design/chklst_impl_inspection.rst new file mode 100644 index 00000000..22b8ddb7 --- /dev/null +++ b/score/ts_client/docs/detailed_design/chklst_impl_inspection.rst @@ -0,0 +1,125 @@ +.. + # ******************************************************************************* + # 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 Implementation Inspection Checklist + :id: doc__ts_client_impl_inspection + :status: draft + :version: 1 + :safety: ASIL_B + :security: NO + :realizes: wp__sw_implementation_inspection + :tags: ts_client + +.. note:: + Work in progress: structure, titles, and needs IDs only. Content and req/comp/feat traceability links to follow in later PRs. + +.. attention:: + The above directive must be updated according to your Component. + + - Adjust ``status`` to be ``valid`` + - Adjust ``safety``, ``security`` and ``tags`` according to your needs + +Implementation Inspection Checklist +=================================== + +Purpose +------- + +The purpose of this checklist is to collect the topics to be checked during implementation, +i.e. in the detailed design and the source code of the units. + +The checklist shall be agnostic to which programming language is used. Differences shall be treated +by linking to C++ or Rust specific documentation. + +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:: Implementation Checklist + :header-rows: 1 + :widths: 10,30,50,6,6,8 + + * - Review ID + - Acceptance Criteria + - Guidance + - Passed + - Remarks + - Issue link + * - IMPL_01_01 + - Is the design according to guidelines? + - see :need:`gd_temp__detailed_design` and :need:`doc_concept__imp_concept` + (e.g. are the views done with the proposed UML diagrams) + - + - + - + * - IMPL_01_02 + - Is the implementation according to specification? + - Check if the linked component requirements are fulfilled + and detailed design also matches architecture description. + - + - + - + * - IMPL_01_03 + - Are the design decisions and constraints documented? + - Check also for plausibility of these. + - + - + - + * - IMPL_01_04 + - Are all external libraries used by the component specified in the detailed design? + - Check the automated dependency analysis. + Also make sure ASIL rated units also only use ASIL rated libraries. + - + - + - + * - IMPL_02_01 + - Are the static and dynamic code analysis reports verified for violations? + - All violations in ASIL related code must be justified. This includes the checks of coding guidelines. + - + - + - + * - IMPL_02_02 + - Do manual checks, that are derived from the coding guideline, find no safety critical error? + - Check this for the programming language used (e.g. C++ , Rust ) + - + - + - + * - IMPL_03_01 + - Do the UID of the interface in component documentation match the implemented interface names of the unit? + - Compare interface UIDs (which contains the interface name) in component architecture/detailed design documentation + with public interfaces in source code (e.g. API headers, traits, public types/functions). + - + - + - + * - IMPL_03_02 + - Are detailed design and source code consistent and is the respective traceability established ? + - Check if available static and dynamic design diagrams and the textual descriptions match the code + (e.g. naming of interfaces, units, functions/operations/messages, data types). + Check if the folder/file names of the units and its source code matches the intended functionality. + For example if a unit is named "communication" it should not contain code for "data processing". + - + - + - diff --git a/score/ts_client/docs/detailed_design/detailed_design.rst b/score/ts_client/docs/detailed_design/detailed_design.rst new file mode 100644 index 00000000..bcd6ab92 --- /dev/null +++ b/score/ts_client/docs/detailed_design/detailed_design.rst @@ -0,0 +1,96 @@ +.. + # ******************************************************************************* + # 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_detailed_design: + +Time Sync Client Detailed Design +================================= + +.. document:: Time Sync Client Detailed Design + :id: doc__ts_client_detailed_design + :status: draft + :version: 1 + :safety: ASIL_B + :security: NO + :realizes: wp__sw_implementation + :tags: ts_client + +.. note:: + Work in progress: structure, titles, and needs IDs only. Content and req/comp/feat traceability links to follow in later PRs. + +.. attention:: + The above directive must be updated according to your Component. + + - Adjust ``status`` to be ``valid`` + - Adjust ``safety`` and ``tags`` according to your needs + +Detailed Design for Time Sync Client +===================================== + +Description +----------- + +| Design Decisions - For the documentation of the decision the :need:`gd_temp__change_decision_record` can be used. +| Design Constraints + +Example: + + - component is split into two units unit1 and unit2 based on single responsibility principle. + - unit2 is injected to unit1 one via dependency injection for testability. + +Rationale Behind Decomposition into Units +****************************************** +| mandatory: a motivation for the decomposition into one or more units. + +.. note:: Reason for split into multiple units could be- + - Based on design principles like SOLID,DRY etc + - Based on design pattern's etc. + +Static Diagrams for Unit Interactions +------------------------------------- + +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 + +Dynamic Diagrams for Unit Interactions (optional) +-------------------------------------------------- + +A dynamic view illustrates how the units within a component interact over their +interfaces to fulfill a specific use case or functionality. It is optional when the +component's behaviour is straightforward and can be understood from the static view +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 + +Units within the Component +-------------------------- + +The relationship between a unit and its parent component is established implicitly +through the file path. Each component has its own directory, and units residing +within that directory belong to it. The unit's attributes and behaviour are documented +in the source code itself. A separate static diagram per unit is not required. + +Interface documentation of a software unit is part of the source code (e.g. public +API headers, trait definitions, or documented function signatures). + +Example: + +- unit1: implements the main logic (see source code for details) +- unit2: injected into unit1 via dependency injection for testability diff --git a/score/ts_client/docs/detailed_design/index.rst b/score/ts_client/docs/detailed_design/index.rst new file mode 100644 index 00000000..f898e2bf --- /dev/null +++ b/score/ts_client/docs/detailed_design/index.rst @@ -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 + # ******************************************************************************* + +.. _ts_client_detailed_design_index: + +Detailed Design +############### + +.. note:: + Work in progress: page structure only, content to follow in later PRs. + +.. attention:: + + The detailed design document is optional and should be created if the design of the component is complex and cannot be easily understood from the architecture documentation and interface documentation alone. + But the inspection checklist for the implementation is mandatory. + + +Detail design example +--------------------- + +An example of documenting detailed design can be found in: + + .. toctree:: + + detailed_design_example + +Inspection Checklist +-------------------- + +The checklist for verification of the detailed design and code can be found here: + +.. toctree:: + + chklst_impl_inspection diff --git a/score/ts_client/docs/index.rst b/score/ts_client/docs/index.rst new file mode 100644 index 00000000..d98267d7 --- /dev/null +++ b/score/ts_client/docs/index.rst @@ -0,0 +1,75 @@ +.. + # ******************************************************************************* + # 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: + +Time Sync Client +################ + +.. document:: Time Sync Client + :id: doc__ts_client + :status: draft + :version: 1 + :safety: ASIL_B + :security: NO + :realizes: wp__cmpt_request + :tags: ts_client + +.. comp:: Time Sync Client + :id: comp__time_ts_client + :security: NO + :safety: ASIL_B + :status: valid + :version: 1 + :belongs_to: feat__time + +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 + + detailed_design/index + requirements/index + safety_analysis/dfa + safety_analysis/fmea + safety_analysis/aou_requirements diff --git a/score/ts_client/docs/.gitkeep b/score/ts_client/docs/manuals/.gitkeep similarity index 100% rename from score/ts_client/docs/.gitkeep rename to score/ts_client/docs/manuals/.gitkeep 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..9a5d1ef2 --- /dev/null +++ b/score/ts_client/docs/requirements/chklst_req_inspection.rst @@ -0,0 +1,194 @@ +.. + # ******************************************************************************* + # 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 Requirements Inspection Checklist + :id: doc__ts_client_req_inspection + :status: draft + :version: 2 + :safety: ASIL_B + :security: NO + :realizes: wp__requirements_inspect + :tags: ts_client + +.. note:: + Work in progress: structure, titles, and needs IDs only. Content and req/comp/feat traceability links to follow in later PRs. + +.. attention:: + The above directive must be updated according to your Component. + + - 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: "ts_client" in docname and "requirements" in docname and docname is not None and status == "valid" + :style: table + :types: comp_req + :tags: ts_client + :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: "ts_client" in docname and "requirements" in docname and docname is not None and status == "valid" + :style: table + :types: aou_req + :tags: ts_client + :columns: id;status;tags + :colwidths: 25,25,25 + :sort: title + +.. attention:: + The above tables filtering must be updated according to your Component. diff --git a/score/ts_client/docs/requirements/index.rst b/score/ts_client/docs/requirements/index.rst new file mode 100644 index 00000000..400d1d03 --- /dev/null +++ b/score/ts_client/docs/requirements/index.rst @@ -0,0 +1,24 @@ +.. + # ******************************************************************************* + # 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 +############ + +.. note:: + Work in progress: page structure only, content to follow in later PRs. + +.. 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..493da20f --- /dev/null +++ b/score/ts_client/docs/requirements/requirements.rst @@ -0,0 +1,106 @@ +.. + # ******************************************************************************* + # 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 Time Sync Client Requirements +######################################## + +.. document:: Time Sync Client Requirements + :id: doc__ts_client_requirements + :status: draft + :version: 1 + :safety: ASIL_B + :security: NO + :realizes: wp__requirements_comp[version==1] + :tags: ts_client + +.. note:: + Work in progress: structure, titles, and needs IDs only. Content and req/comp/feat traceability links to follow in later PRs. + +.. attention:: + The above directive must be updated according to your Component. + + - Adjust ``status`` to be ``valid`` + - Adjust ``safety``, ``security`` and ``tags`` according to your needs + + +=================================================================== + +Functional Requirements +----------------------- + +.. comp_req:: Some Title + :id: comp_req__ts_client__some_title + :reqtype: Functional + :security: NO + :safety: ASIL_B + :derived_from: feat_req__time__example_req + :status: invalid + :version: 1 + :satisfied_by: comp__time_ts_client + + 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__ts_client__next_title + :reqtype: Process + :security: NO + :safety: ASIL_B + :status: invalid + :version: 1 + + The Component User shall do xyz to use the component safely/securely + +Environmental Requirements +-------------------------- + +.. aou_req:: Another Title + :id: aou_req__ts_client__another + :reqtype: Process + :security: NO + :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 "ts_client" in id + :+tags: ts_client diff --git a/score/ts_client/docs/safety_analysis/aou_requirements.rst b/score/ts_client/docs/safety_analysis/aou_requirements.rst new file mode 100644 index 00000000..5a5cf16a --- /dev/null +++ b/score/ts_client/docs/safety_analysis/aou_requirements.rst @@ -0,0 +1,62 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +AoU Component Requirements Template +=================================== + +.. document:: Time Sync Client Component AoU + :id: doc__ts_client_feat_aou + :status: draft + :version: 1 + :safety: ASIL_B + :security: NO + :realizes: wp__requirements_comp_aou + :tags: ts_client + +.. note:: + Work in progress: structure, titles, and needs IDs only. Content and req/comp/feat traceability links to follow in later PRs. + + +.. attention:: + The above directive must be updated according to your Component. + + - Adjust ``status`` to be ``valid`` + - Adjust ``safety``, ``security`` and ``tags`` according to your needs + +This page contains Assumption of Use requirement snippets that belong to the +template repository. + +Component AoU +------------- + +.. code-block:: rst + + .. aou_req:: Next Title + :id: aou_req__ts_client__next_title + :reqtype: Process + :security: NO + :safety: ASIL_B + :status: invalid + + The Component User shall do xyz to use the component safely/securely + + .. aou_req:: Another Title + :id: aou_req__ts_client__another + :reqtype: Process + :security: NO + :safety: ASIL_B + :status: invalid + :tags: environment + + The Component shall only be used in a xyz environment to ensure its proper functioning. diff --git a/score/ts_client/docs/safety_analysis/dfa.rst b/score/ts_client/docs/safety_analysis/dfa.rst new file mode 100644 index 00000000..82c27854 --- /dev/null +++ b/score/ts_client/docs/safety_analysis/dfa.rst @@ -0,0 +1,60 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + + +DFA (Dependent Failure Analysis) +================================ + +.. document:: Time Sync Client DFA + :id: doc__ts_client_dfa + :status: draft + :version: 1 + :safety: ASIL_B + :security: NO + :realizes: wp__sw_component_dfa + :tags: ts_client + +.. note:: + Work in progress: structure, titles, and needs IDs only. Content and req/comp/feat traceability links to follow in later PRs. + +.. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram. + +.. attention:: + The above directive must be updated according to your Component. + + - Adjust ``status`` to be ``valid`` + - Adjust ``safety`` and ``tags`` according to your needs + +Dependent Failure Initiators +---------------------------- + +.. code-block:: rst + + .. comp_saf_dfa:: + :violates: <Component architecture> + :id: comp_saf_dfa__<Component>__<Element descriptor> + :failure_id: <ID from DFA failure initiators :need:`gd_guidl__dfa_failure_initiators`> + :failure_effect: "description of failure effect of the failure initiator on the element" + :mitigated_by: <ID from Component Requirement | ID from AoU Component Requirement> + :mitigation_issue: <ID from Issue Tracker> + :sufficient: <yes|no> + :status: <valid|invalid> + +.. note:: Argument is inside the 'content'. Therefore content is mandatory. + +.. attention:: + The above directive must be updated according to your component DFA. + + - The above "code-block" directive must be updated + - Fill in all the needed information in the <brackets> diff --git a/score/ts_client/docs/safety_analysis/fmea.rst b/score/ts_client/docs/safety_analysis/fmea.rst new file mode 100644 index 00000000..93406716 --- /dev/null +++ b/score/ts_client/docs/safety_analysis/fmea.rst @@ -0,0 +1,133 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + + +FMEA (Failure Modes and Effects Analysis) +========================================= + +.. document:: Time Sync Client FMEA + :id: doc__ts_client_fmea + :status: draft + :version: 1 + :safety: ASIL_B + :security: NO + :realizes: wp__sw_component_fmea + :tags: ts_client + +.. note:: + Work in progress: structure, titles, and needs IDs only. Content and req/comp/feat traceability links to follow in later PRs. + +.. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram. + +.. attention:: + The above directive must be updated according to your Component. + + - Adjust ``status`` to be ``valid`` + - Adjust ``safety`` and ``tags`` according to your needs + +Failure Mode List +----------------- + +.. list-table:: Fault Models for sequence diagrams + :header-rows: 1 + :widths: 10,20,10,20 + + * - ID + - Failure Mode + - Applicability + - Rationale + * - MF_01_01 + - message is not received (is a subset/more precise description of MF_01_05) + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - MF_01_02 + - message received too late (only relevant if delay is a realistic fault) + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - MF_01_03 + - message received too early (usually not a problem) + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - MF_01_04 + - message not received correctly by all recipients (different messages or messages partly lost). Only relevant if the same message goes to multiple recipients. + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - MF_01_05 + - message is corrupted + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - MF_01_06 + - message is not sent + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - MF_01_07 + - message is unintended sent + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - CO_01_01 + - minimum constraint boundary is violated + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - CO_01_02 + - maximum constraint boundary is violated + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - EX_01_01 + - Process calculates wrong result(s) (is a subset/more precise description of MF_01_05 or MF_01_04). This failure mode is related to the analysis if e.g. internal safety mechanisms are required (level 2 function, plausibility check of the output, …) because of the size / complexity of the feature. + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - EX_01_02 + - processing too slow (only relevant if timing is considered) + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - EX_01_03 + - processing too fast (only relevant if timing is considered) + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - EX_01_04 + - loss of execution + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - EX_01_05 + - processing changes to arbitrary process + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + * - EX_01_06 + - processing is not complete (infinite loop) + - <yes | no> + - <Rationale if not applicable, otherwise link to filled out FMEA> + +FMEA +---- +For all identified applicable failure initiators, the FMEA is performed in the following section. + +.. code-block:: rst + + .. comp_saf_fmea:: <Title> + :violates: <Component architecture> + :id: comp_saf_fmea__<Component>__<Element descriptor> + :fault_id: <ID from fault model :need:`gd_guidl__fault_models`> + :failure_effect: "description of failure effect of the fault model on the element" + :mitigated_by: <ID from Component Requirement | ID from AoU Component Requirement> + :mitigation_issue: <ID from Issue Tracker> + :sufficient: <yes|no> + :status: <valid|invalid> + + .. note:: argument is inside the 'content'. Therefore content is mandatory + +.. attention:: + The above directive must be updated according to your component FMEA. + + - The above "code-block" directive must be updated + - Fill in all the needed information in the <brackets> diff --git a/score/ts_client/docs/security_analysis/.gitkeep b/score/ts_client/docs/security_analysis/.gitkeep new file mode 100644 index 00000000..e69de29b From 48aa2c00bf0fe458211dead8384313e727d3f151 Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" <str1yok@bosch.com> Date: Tue, 4 Aug 2026 10:38:36 +0100 Subject: [PATCH 02/11] docs: ts_client component requirements template --- score/ts_client/docs/requirements/index.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/score/ts_client/docs/requirements/index.rst b/score/ts_client/docs/requirements/index.rst index 400d1d03..9eea1fc7 100644 --- a/score/ts_client/docs/requirements/index.rst +++ b/score/ts_client/docs/requirements/index.rst @@ -15,9 +15,6 @@ Requirements ############ -.. note:: - Work in progress: page structure only, content to follow in later PRs. - .. toctree:: requirements From 3066e78719d564a189c5fe015ee77050e1424699 Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" <str1yok@bosch.com> Date: Tue, 4 Aug 2026 14:08:22 +0100 Subject: [PATCH 03/11] chore: update to latest docs_as_code implementation --- .gitignore | 16 +++++++++++++++- BUILD | 3 ++- MODULE.bazel | 5 +++-- MODULE.bazel.lock | 16 +++++++++++++--- 4 files changed, 33 insertions(+), 7 deletions(-) diff --git a/.gitignore b/.gitignore index 630b0b8a..61133aa2 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 65931225..ffaedcca 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 4a01c4bc..283a5170 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 96859963..8c735d53 100644 --- a/MODULE.bazel.lock +++ b/MODULE.bazel.lock @@ -539,6 +539,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", @@ -1019,7 +1021,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", @@ -1036,7 +1040,10 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.0.0/MODULE.bazel": "522dc070354e6be2f984468a4243fe4ab8bec690922df5f31f7f0916ee264e20", "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.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.3.0/MODULE.bazel": "97c3ab10cafe3f519293fb1fab2de3c3970f9d70e55255c72f4dfe87ec55a240", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_lifecycle_health/0.3.0/source.json": "138d840f0ec2c7a915f935803426920b0f344f7e0038db885fe4ebd32829a514", @@ -1057,7 +1064,9 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.5.2/MODULE.bazel": "be52d29278d6671221f28921e8f1acfce29c3bfc3e6b4f503f0625ab2c61586f", "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.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", @@ -1067,6 +1076,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 c06c315863201af5a040721b953cbd67edf62cff Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" <str1yok@bosch.com> Date: Tue, 4 Aug 2026 15:25:25 +0100 Subject: [PATCH 04/11] 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 | 23 ++-- .../docs/requirements/requirements.rst | 108 +++++++++--------- 5 files changed, 81 insertions(+), 87 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 d7d50f3d..cdc48dc0 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 <features/time_daemon/index>`. +For a detailed concept and architectural design, please refer to the :doc:`time_daemon Concept Documentation <docs/features/time_daemon/index>`. .. 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 d98267d7..dc0edc49 100644 --- a/score/ts_client/docs/index.rst +++ b/score/ts_client/docs/index.rst @@ -21,7 +21,7 @@ Time Sync Client :id: doc__ts_client :status: draft :version: 1 - :safety: ASIL_B + :safety: QM :security: NO :realizes: wp__cmpt_request :tags: ts_client @@ -37,29 +37,22 @@ Time Sync Client 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 diff --git a/score/ts_client/docs/requirements/requirements.rst b/score/ts_client/docs/requirements/requirements.rst index 493da20f..dc5c8cd3 100644 --- a/score/ts_client/docs/requirements/requirements.rst +++ b/score/ts_client/docs/requirements/requirements.rst @@ -16,91 +16,89 @@ Component Time Sync Client Requirements ######################################## .. document:: Time Sync Client Requirements - :id: doc__ts_client_requirements + :id: doc__time_ts_client_requirements :status: draft :version: 1 - :safety: ASIL_B + :safety: QM :security: NO :realizes: wp__requirements_comp[version==1] - :tags: ts_client + :tags: requirements, ts_client_library -.. note:: - Work in progress: structure, titles, and needs IDs only. Content and req/comp/feat traceability links to follow in later PRs. - -.. attention:: - The above directive must be updated according to your Component. - - - Adjust ``status`` to be ``valid`` - - Adjust ``safety``, ``security`` and ``tags`` according to your needs - -<Headlines (for the list of requirements if structuring is needed)> -=================================================================== Functional Requirements ----------------------- -.. comp_req:: Some Title - :id: comp_req__ts_client__some_title +.. comp_req:: Shared Memory Channel Management + :id: comp_req__time_ts_client__shared_memory_mgmt :reqtype: Functional :security: NO - :safety: ASIL_B - :derived_from: feat_req__time__example_req + :safety: QM + :derived_from: feat_req__time__vehicle_time_sync[version==1] :status: invalid :version: 1 - :satisfied_by: comp__time_ts_client - 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__ts_client__next_title - :reqtype: Process +.. comp_req:: Lock-Free Data Synchronization + :id: comp_req__time_ts_client__lockfree_sync + :reqtype: Functional :security: NO - :safety: ASIL_B + :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__ts_client__another - :reqtype: Process +Non-Functional Requirements +--------------------------- + +.. comp_req:: Low-Latency Time Data Access + :id: comp_req__time_ts_client__low_latency + :reqtype: Non-Functional :security: NO - :safety: ASIL_B + :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 (<Functional|Interface|Process|Non-Functional>) - - 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 "ts_client" in id - :+tags: ts_client +.. needextend:: is_external == False and "time_ts_client" in id + :+tags: time_ts_client From d17fd5887807d77ed185bd25d164c564f13613d7 Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" <str1yok@bosch.com> Date: Tue, 4 Aug 2026 15:56:16 +0100 Subject: [PATCH 05/11] undo docs infra changes --- .gitignore | 16 +--------------- BUILD | 3 +-- MODULE.bazel | 5 ++--- MODULE.bazel.lock | 16 +++------------- conf.py => docs/conf.py | 20 +++++++++----------- index.rst => docs/index.rst | 11 ++--------- 6 files changed, 18 insertions(+), 53 deletions(-) rename conf.py => docs/conf.py (87%) rename index.rst => docs/index.rst (94%) diff --git a/.gitignore b/.gitignore index 61133aa2..630b0b8a 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 ffaedcca..65931225 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 283a5170..4a01c4bc 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 8c735d53..96859963 100644 --- a/MODULE.bazel.lock +++ b/MODULE.bazel.lock @@ -539,8 +539,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", @@ -1021,9 +1019,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", @@ -1040,10 +1036,7 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.0.0/MODULE.bazel": "522dc070354e6be2f984468a4243fe4ab8bec690922df5f31f7f0916ee264e20", "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.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.3.0/MODULE.bazel": "97c3ab10cafe3f519293fb1fab2de3c3970f9d70e55255c72f4dfe87ec55a240", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_lifecycle_health/0.3.0/source.json": "138d840f0ec2c7a915f935803426920b0f344f7e0038db885fe4ebd32829a514", @@ -1064,9 +1057,7 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.5.2/MODULE.bazel": "be52d29278d6671221f28921e8f1acfce29c3bfc3e6b4f503f0625ab2c61586f", "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.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", @@ -1076,7 +1067,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 cdc48dc0..d7d50f3d 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 <docs/features/time_daemon/index>`. +For a detailed concept and architectural design, please refer to the :doc:`time_daemon Concept Documentation <features/time_daemon/index>`. .. 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 b96a8e81bbb6f2e7d598a4044e07cba19d61a3dc Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" <str1yok@bosch.com> Date: Tue, 4 Aug 2026 16:02:17 +0100 Subject: [PATCH 06/11] 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 d11414e4cbfe46eb104daa731a221246ef913f0b Mon Sep 17 00:00:00 2001 From: "Ryan Steel (ETAS)" <str1yok@bosch.com> Date: Wed, 5 Aug 2026 14:16:46 +0100 Subject: [PATCH 07/11] 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 ++ 3 files changed, 338 insertions(+) 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): <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> + +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 <gd_req__arch_build_blocks_corr>`) is implemented. Refer to `Tool Requirements <https://eclipse-score.github.io/docs-as-code/main/internals/requirements/requirements.html>`_ 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 <gd_req__arch_build_blocks_corr>`) is implemented by automated tool check. See `Tool Requirements <https://eclipse-score.github.io/docs-as-code/main/internals/requirements/requirements.html>`_. + 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 +-------- + +<Brief summary of the architecture.> + +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 +----------- + +<General Description> + +<Design Decisions - For the documentation of the decision the :need:`gd_temp__change_decision_record` can be used.> + +<Design Constraints> + +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:: <Title> + :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 From 04f74f22761efd1f1a2084201afc452583247fca 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 08/11] 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 c863c0a6f255bcc6b6cf05a37944cfefd29fa800 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 09/11] 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 From 1910331ac32c9fc42643be728d7ea5407c619958 Mon Sep 17 00:00:00 2001 From: Ryan Steel <str1yok@bosch.com> Date: Fri, 14 Aug 2026 16:12:28 +0100 Subject: [PATCH 10/11] docs: remove unnecessary architecture dir --- .../architecture/chklst_arc_inspection.rst | 200 ------------------ .../architecture/component_architecture.rst | 115 ---------- score/ts_client/docs/architecture/index.rst | 23 -- 3 files changed, 338 deletions(-) delete mode 100644 score/ts_client/docs/architecture/chklst_arc_inspection.rst delete mode 100644 score/ts_client/docs/architecture/component_architecture.rst delete 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 deleted file mode 100644 index a634181a..00000000 --- a/score/ts_client/docs/architecture/chklst_arc_inspection.rst +++ /dev/null @@ -1,200 +0,0 @@ -.. - # ******************************************************************************* - # 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: ASIL_B - :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): <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 the safety manager, security manager or quality manager initiating the inspection> - -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 <gd_req__arch_build_blocks_corr>`) is implemented. Refer to `Tool Requirements <https://eclipse-score.github.io/docs-as-code/main/internals/requirements/requirements.html>`_ 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 <gd_req__arch_build_blocks_corr>`) is implemented by automated tool check. See `Tool Requirements <https://eclipse-score.github.io/docs-as-code/main/internals/requirements/requirements.html>`_. - 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 deleted file mode 100644 index 34021d7e..00000000 --- a/score/ts_client/docs/architecture/component_architecture.rst +++ /dev/null @@ -1,115 +0,0 @@ -.. - # ******************************************************************************* - # 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: ASIL_B - :security: NO - :realizes: wp__component_arch - :tags: time_ts_client - - -Overview --------- - -<Brief summary of the architecture.> - -Requirements Linked to Component Architecture ---------------------------------------------- - -.. needtable:: Overview of Component Requirements - :style: table - :columns: title;id - :filter: search("comp_arc_sta__time_ts_client__sv$", "fulfils_back") - :colwidths: 70,30 - -Description ------------ - -<General Description> - -<Design Decisions - For the documentation of the decision the :need:`gd_temp__change_decision_record` can be used.> - -<Design Constraints> - -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: ASIL_B - :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: ASIL_B - :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: ASIL_B - :status: valid - :version: 1 - :belongs_to: comp__time_ts_client - :fulfils: - - Put here a sequence diagram - -Interfaces ----------- - -.. code-block:: rst - - .. real_arc_int:: <Title> - :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 deleted file mode 100644 index 02fbfe12..00000000 --- a/score/ts_client/docs/architecture/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. - # ******************************************************************************* - # 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 From 3df133b5a3b3744791c82c58a25e710d9ac7e78a Mon Sep 17 00:00:00 2001 From: Ryan Steel <str1yok@bosch.com> Date: Fri, 14 Aug 2026 17:06:09 +0100 Subject: [PATCH 11/11] docs: move requirements to index.rst --- score/ts_client/docs/requirements/index.rst | 99 +++++++++++++++- .../docs/requirements/requirements.rst | 109 ------------------ 2 files changed, 96 insertions(+), 112 deletions(-) delete mode 100644 score/ts_client/docs/requirements/requirements.rst diff --git a/score/ts_client/docs/requirements/index.rst b/score/ts_client/docs/requirements/index.rst index 9eea1fc7..dc4d9417 100644 --- a/score/ts_client/docs/requirements/index.rst +++ b/score/ts_client/docs/requirements/index.rst @@ -12,10 +12,103 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Requirements -############ +Component Time Sync Client Requirements +######################################## + +.. document:: Time Sync Client Requirements + :id: doc__time_ts_client_requirements + :status: draft + :version: 1 + :safety: ASIL_B + :security: NO + :realizes: wp__requirements_comp[version==1] + :tags: requirements, time_ts_client + + +Functional Requirements +----------------------- + +.. comp_req:: Shared Memory Channel Management + :id: comp_req__time_ts_client__shared_memory_mgmt + :reqtype: Functional + :security: NO + :safety: ASIL_B + :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. + +.. comp_req:: Time Synchronization Data Publishing + :id: comp_req__time_ts_client__data_publishing + :reqtype: Functional + :security: NO + :safety: ASIL_B + :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. + +.. comp_req:: Time Synchronization Data Reception + :id: comp_req__time_ts_client__data_reception + :reqtype: Functional + :security: NO + :safety: ASIL_B + :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. + +.. comp_req:: Lock-Free Data Synchronization + :id: comp_req__time_ts_client__lockfree_sync + :reqtype: Functional + :security: NO + :safety: ASIL_B + :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. + + +Non-Functional Requirements +--------------------------- + +.. comp_req:: Low-Latency Time Data Access + :id: comp_req__time_ts_client__low_latency + :reqtype: Non-Functional + :security: NO + :safety: ASIL_B + :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. + +Assumption of Use Requirements +------------------------------ + +.. aou_req:: Single Publisher Process + :id: aou_req__time_ts_client__single_publisher + :reqtype: Process + :security: NO + :safety: ASIL_B + :status: invalid + :version: 1 + + 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 .. toctree:: + :maxdepth: 1 - requirements chklst_req_inspection diff --git a/score/ts_client/docs/requirements/requirements.rst b/score/ts_client/docs/requirements/requirements.rst deleted file mode 100644 index b5de8f38..00000000 --- a/score/ts_client/docs/requirements/requirements.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. - # ******************************************************************************* - # 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 Time Sync Client Requirements -######################################## - -.. document:: Time Sync Client Requirements - :id: doc__time_ts_client_requirements - :status: draft - :version: 1 - :safety: ASIL_B - :security: NO - :realizes: wp__requirements_comp[version==1] - :tags: requirements, time_ts_client - - -Functional Requirements ------------------------ - -.. comp_req:: Shared Memory Channel Management - :id: comp_req__time_ts_client__shared_memory_mgmt - :reqtype: Functional - :security: NO - :safety: ASIL_B - :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. - -.. comp_req:: Time Synchronization Data Publishing - :id: comp_req__time_ts_client__data_publishing - :reqtype: Functional - :security: NO - :safety: ASIL_B - :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. - -.. comp_req:: Time Synchronization Data Reception - :id: comp_req__time_ts_client__data_reception - :reqtype: Functional - :security: NO - :safety: ASIL_B - :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. - -.. comp_req:: Lock-Free Data Synchronization - :id: comp_req__time_ts_client__lockfree_sync - :reqtype: Functional - :security: NO - :safety: ASIL_B - :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. - - -Non-Functional Requirements ---------------------------- - -.. comp_req:: Low-Latency Time Data Access - :id: comp_req__time_ts_client__low_latency - :reqtype: Non-Functional - :security: NO - :safety: ASIL_B - :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. - -Assumption of Use Requirements ------------------------------- - -.. aou_req:: Single Publisher Process - :id: aou_req__time_ts_client__single_publisher - :reqtype: Process - :security: NO - :safety: ASIL_B - :status: invalid - :version: 1 - - 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