From 2475433e065988b1f7a1945b8450998264e4f193 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Arkadiusz=20J=C4=99drzejewski?= Date: Thu, 20 Nov 2025 10:04:51 +0000 Subject: [PATCH] docs: initial docs from template Adapted docs from template. --- docs/index.rst | 19 +- docs/module/log/architecture/index.rst | 97 +++++ docs/module/log/component_classification.rst | 188 ++++++++++ docs/module/log/detailed_design/index.rst | 72 ++++ docs/module/log/index.rst | 164 +++++++++ docs/module/log/requirements/index.rst | 35 ++ docs/module/log/safety_analysis/dfa.rst | 51 +++ docs/module/log/safety_analysis/fmea.rst | 51 +++ docs/module_docs/index.rst | 27 ++ docs/module_docs/manual/index.rst | 21 ++ docs/module_docs/manual/safety_manual.rst | 90 +++++ docs/module_docs/release/release_note.rst | 92 +++++ docs/module_docs/safety_mgt/index.rst | 23 ++ .../safety_mgt/module_safety_package_fdr.rst | 63 ++++ .../safety_mgt/module_safety_plan.rst | 340 ++++++++++++++++++ .../safety_mgt/module_safety_plan_fdr.rst | 93 +++++ .../module_verification_report.rst | 81 +++++ 17 files changed, 1496 insertions(+), 11 deletions(-) create mode 100644 docs/module/log/architecture/index.rst create mode 100644 docs/module/log/component_classification.rst create mode 100644 docs/module/log/detailed_design/index.rst create mode 100644 docs/module/log/index.rst create mode 100644 docs/module/log/requirements/index.rst create mode 100644 docs/module/log/safety_analysis/dfa.rst create mode 100644 docs/module/log/safety_analysis/fmea.rst create mode 100644 docs/module_docs/index.rst create mode 100644 docs/module_docs/manual/index.rst create mode 100644 docs/module_docs/manual/safety_manual.rst create mode 100644 docs/module_docs/release/release_note.rst create mode 100644 docs/module_docs/safety_mgt/index.rst create mode 100644 docs/module_docs/safety_mgt/module_safety_package_fdr.rst create mode 100644 docs/module_docs/safety_mgt/module_safety_plan.rst create mode 100644 docs/module_docs/safety_mgt/module_safety_plan_fdr.rst create mode 100644 docs/module_docs/verification/module_verification_report.rst diff --git a/docs/index.rst b/docs/index.rst index 54a223a..e80e2eb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,25 +12,22 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Base Libraries - Rust -============================= +Rust Base Libraries +=================== -This documentation describes the Rust base libraries. +.. toctree:: + :maxdepth: 1 + :glob: + :titlesonly: -.. contents:: Table of Contents - :depth: 2 - :local: + module_docs/index + module/*/index Overview -------- Foundational Rust libraries providing common functionality for S-CORE modules. -Requirements ------------- - -- TODO: add requirements once available. - Project Layout -------------- diff --git a/docs/module/log/architecture/index.rst b/docs/module/log/architecture/index.rst new file mode 100644 index 0000000..4b4fe2e --- /dev/null +++ b/docs/module/log/architecture/index.rst @@ -0,0 +1,97 @@ +.. + # ******************************************************************************* + # Copyright (c) 2025 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_architecture_log: + +Component Architecture +====================== + +.. document:: Log Architecture + :id: doc__log_architecture + :status: draft + :safety: QM + :security: NO + :realizes: wp__component_arch + :tags: log + + +Overview +-------- + +Document describes Log component architecture. + + +Description +----------- + +TODO: description + + +Rationale Behind Architecture Decomposition +******************************************* + +TODO: decomposition rationale + +Static Architecture +------------------- + +TODO: static architecture + +.. .. comp_arc_sta:: Log (Static View) +.. :id: comp_arc_sta__log__static_view +.. :security: YES +.. :safety: QM +.. :status: invalid +.. :implements: logic_arc_int__log__interface_name +.. :fulfils: +.. :includes: + +.. .. uml:: _assets/TODO.puml + + +Dynamic Architecture +-------------------- + +TODO: dynamic architecture + +.. .. comp_arc_dyn:: Dynamic View +.. :id: comp_arc_dyn__log__dynamic_view +.. :security: YES +.. :safety: QM +.. :status: invalid +.. :fulfils: comp_req__log__some_title + +.. .. uml:: _assets/TODO.puml + + +Interfaces +---------- + +TODO: put log interfaces. + +.. .. code-block:: rst + +.. .. real_arc_int:: mw_log +.. :id: real_arc_int__log__interface +.. :security: NO +.. :safety: QM +.. :fulfils: +.. :language: rust + +.. .. uml:: _assets/TODO.puml + +Lower Level Components +---------------------- + +TODO: remove section if unused diff --git a/docs/module/log/component_classification.rst b/docs/module/log/component_classification.rst new file mode 100644 index 0000000..4580133 --- /dev/null +++ b/docs/module/log/component_classification.rst @@ -0,0 +1,188 @@ +.. + # ******************************************************************************* + # Copyright (c) 2025 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 Classification +======================== + + +.. document:: Log Component Classification + :id: doc__log_comp_class + :status: draft + :safety: QM + :security: NO + :realizes: wp__sw_component_class + :tags: log + + +| Classification of +| +| +| +| Additional documentation considered: +| + + +Step 1: Determine (P): the uncertainty of the Processes applied +--------------------------------------------------------------- + +| Apply the process measures to determine (P). +| The result of a process measure shall have as outcome [HE, PE, NE] +| - HE: High Evidence +| - PE: Partly Evidence but Manageable +| - NE: No Evidence + +.. list-table:: Determine (P) + :header-rows: 1 + + * - Id + - Indicator for applying process + - Result + - Rationale for result + + * - 1 + - Are rules, state-of-the art processes applied for the design, implementation and verification? + - + - + + * - 2 + - Are requirements available? + - + - + + * - 3 + - Are specifications for functionalities and properties available (architecture)? + - + - + + * - 4 + - Are design specifications available? + - + - + + * - 5 + - Are configuration specification and data available, if applicable? + - + - + + * - 6 + - Are verification measures including tests and reports available? + - + - + + +| (P=1) shall be selected when none of the determined process measures indicate PE or NE. +| (P=2) shall be selected when at least one of the determined process measures indicate PE or NE, but the gaps evaluated are acceptable, means +| the risk of systematic faults due to these gaps is sufficiently low or manageable by mitigating the gaps. +| (P=3) in all other cases. + + is determined as P=<1|2|3> + + +Step 2: Determine (C): the uncertainty of finding systematic faults based on the Complexity +------------------------------------------------------------------------------------------- + +| Apply the complexity measures to determine (C). +| The result of a complexity measure shall have as outcome [NH, HM, NM] +| - NH: Not High +| - HM: High but Manageable +| - NM: high and Not Manageable +| +| **Complexity measure for programming language: ** + +