From 64933d458c31eaac40363b4a6fd262f88d464ad1 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel Date: Wed, 18 Feb 2026 13:49:06 +0100 Subject: [PATCH 01/36] 2501 attifunel: added missing templates --- .../platform/docs/safety_mgt/index.rst | 22 +++++ .../platform_safety_analysis_fdr.rst | 92 ++++++++++++++++++ .../platform_safety_package_fdr.rst | 66 +++++++++++++ .../safety_mgt/platform_safety_plan_fdr.rst | 96 +++++++++++++++++++ .../platform_verification_report.rst | 52 ++++++++++ process/folder_templates/platform/index.rst | 4 +- .../platform/safety_analysis/platform_dfa.rst | 11 +-- 7 files changed, 333 insertions(+), 10 deletions(-) create mode 100644 process/folder_templates/platform/docs/safety_mgt/index.rst create mode 100644 process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst create mode 100644 process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst create mode 100644 process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst create mode 100644 process/folder_templates/platform/docs/verification/platform_verification_report.rst diff --git a/process/folder_templates/platform/docs/safety_mgt/index.rst b/process/folder_templates/platform/docs/safety_mgt/index.rst new file mode 100644 index 0000000000..abc7e63abb --- /dev/null +++ b/process/folder_templates/platform/docs/safety_mgt/index.rst @@ -0,0 +1,22 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Safety Management +################# + +.. toctree:: + :titlesonly: + + platform_safety_plan_fdr + platform_safety_package_fdr diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst new file mode 100644 index 0000000000..a3045bbd2b --- /dev/null +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst @@ -0,0 +1,92 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + + +Safety Analysis Checklist +========================= + +.. document:: Platform Safety Analysis Checklist + :id: doc__module_name_safety_analysis_fdr + :status: draft + :safety: ASIL_B + :security: YES + :realizes: wp__fdr_reports + :tags: template + + + +**Purpose** +The purpose of this Safety Analysis (DFA and FMEA) checklist template is to collect the topics to be checked during verification of the Platform Safety Analysis. + +**Conduct** +As described in :need:`wf__p_formal_rv`, the formal document review is performed by an "external" safety manager: + +- reviewer: + +**Checklist** + +Please note that it is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item and additional 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. See also :ref:`review_concept` for further information about reviews in general and inspection in particular. + +.. list-table:: Safety Analysis Checklist + :header-rows: 1 + :widths: 10,30,30,15,8,8 + + * - Review ID + - Acceptance Criteria + - Guidance + - Passed + - Remarks + - Issue link + * - REQ_01_01 + - Is / are the attribute sufficient set correctly? + - The mitigations shall have a direct influence ont the violation by prevention, detection or mitigation to reduce the risk to an acceptable level. + - The mitigations are sufficient. + - + - + * - REQ_01_02 + - Are the templates for DFA and/or FMEA used? + - See :ref:`dfa_templates` / :ref:`FMEA_templates` and also :ref:`process_requirements_safety_analysis` + - Templates are used to generate the DFA or / and FMEA. + - + - + * - REQ_01_03 + - Were the failure initiators / fault models applied? + - See :need:`gd_guidl__dfa_failure_initiators` / :need:`gd_guidl__fault_models` + - The applicable items of the failure initiators / fault models are used to ensure a structured analysis. For all not applicable items an argument shall be given in the content of the document. + - + - + * - REQ_01_04 + - Are the failure effects clearly and completely described? + - Use the generic failure effect descriptions and enlarge the description if it's applicable to the considered element. + - The effects of the failure is described completely. The effect can be recognized easily. + - + - + * - REQ_01_06 + - Is the attribute "mitigated by" linked correct? + - Check if the correct failure effect is linked via "mitigated by". + - The "mitigated by" link is correct. + - + - + * - REQ_01_07 + - Is the sufficiency of the "mitigated by" (prevention, detection or mitigation) described or can it be recognized easily? + - The sufficiency of the "mitigated by" is described in the content of the document. It can be recognized easily. + - The "mitigated by" shows clearly that a fault / failure can be mitigated by the linked requirement by prevention, detection or mitigation. It shall be described in the contend. + - + - + * - REQ_01_08 + - Is the overall result of the Safety Analysis described in the report? + - It shall be shown in the report if the Safety Analysis are finished and if all artifacts are "valid" and "sufficient". + - The results of the Safety Analysis are described in the report. The report is available :need:`wp__verification_platform_ver_report`. + - + - diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst new file mode 100644 index 0000000000..761b7200eb --- /dev/null +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst @@ -0,0 +1,66 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Safety Package Formal Review Report +=================================== + +.. note:: Document header + +.. document:: Platform Safety Package Formal Review + :id: doc__platform_safety_package_fdr + :status: draft + :safety: ASIL_B + :security: NO + :realizes: wp__fdr_reports + :tags: template + + +**1. Purpose** + +The purpose of this review checklist is to report status of the formal review for the platform safety package. + +**2. Checklist** + +.. list-table:: Safety Package Checklist + :header-rows: 1 + + * - Id + - Safety package activity + - Compliant to ISO 26262? + - Comment + + * - 1 + - Is a safety package provided which matches the safety plan (i.e. all planned work products referenced)? + - [YES | NO ] + - + + * - 2 + - Is the argument how functional safety is achieved, provided in the safety package, plausible and sufficient? + - NO + - The argument is intentionally not provided by the project. + + * - 3 + - Are the referenced work products available? + - [YES | NO ] + - + + * - 4 + - Are the referenced work products in released state, including the process safety audit? + - [YES | NO ] + - + + * - 5 + - If safety related deviations from the process or safety concept are documented, are these argued understandably? + - [YES | NO ] + - diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst new file mode 100644 index 0000000000..087a69dcc7 --- /dev/null +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst @@ -0,0 +1,96 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Safety Plan Formal Review Report +================================ + +.. note:: Document header + +.. document:: PlatformSafety Plan Formal Review + :id: doc__platform_safety_plan_fdr + :status: draft + :safety: ASIL_B + :security: NO + :realizes: wp__fdr_reports + :tags: template + + +**1. Purpose** + +The purpose of this safety plan formal review checklist is to report status of the review for the platform safety plan. + +**2. Checklist** + +.. list-table:: Safety Plan Checklist + :header-rows: 1 + + * - Id + - Safety plan activity + - Compliant to ISO 26262? + - Comment + + * - 1 + - Is the rationale for the safety work products tailoring included? + - [YES | NO ] + - + + * - 2 + - Is impact analysis planned in case of re-use of SW (needed for every release following the first formal release)? + - [YES | NO ] + - + + * - 3 + - Does the safety plan define all needed activities for safety management (incl. Confirmation review and Safety Audit)? + - [YES | NO ] + - + + * - 4 + - Does the safety plan define all needed activities for System and SW development, integration and verification? + - [YES | NO ] + - + + * - 5 + - Does the safety plan define all needed activities for safety analysis and DFA? + - [YES | NO ] + - + + * - 6 + - Does the safety plan define all needed activities for supporting processes (incl. tool mgt)? + - [YES | NO ] + - + + * - 7 + - Does the safety plan document a responsible for all activities? + - [YES | NO ] + - + + * - 8 + - If OSS software components is used, is it planned to be qualified? + - [YES | NO ] + - + + * - 9 + - Is a safety manager and a project manager appointed for the project? + - [YES | NO ] + - + + * - 10 + - Is safety plan sufficiently linked to the project plan? + - [YES | NO ] + - + + * - 11 + - Is safety plan updated iteratively to show the progress? + - [YES | NO ] + - diff --git a/process/folder_templates/platform/docs/verification/platform_verification_report.rst b/process/folder_templates/platform/docs/verification/platform_verification_report.rst new file mode 100644 index 0000000000..ca245753c9 --- /dev/null +++ b/process/folder_templates/platform/docs/verification/platform_verification_report.rst @@ -0,0 +1,52 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Verification Report +=================== + +.. note:: Document header + +.. document:: platform Verification Report + :id: doc__platform_verification_report + :status: draft + :safety: ASIL_B + :security: YES + :realizes: wp__verification_platform_ver_report + :tags: template + + +Verification Report contains: + +**1. List of requirements and architecture tested ** + + - List of requirements (stakeholder and feature) tested by which test + - List of architecture elements tested by which test (can be several levels) + - For all tests "passed/failed" shall be reported + - For all tests, completeness verdict shall be report, including normal operation and failure reactions + - The list of requirements may also contain other verification methods like “Analysis” + +**2. Safety analyses ** + - Formal evidence about the performed DFA + - Formal evidence about the performed Safety Analyses (this has to be compared against safety plan, i.e. needed only if FMEA actually planned on platform level) + - Final statement resume (i.e. all passed, or are there open points, further actions needed, justifications etc.) + +**2. Integration test results ** + - Test results per test case from Platform Integration Test (:need:`wp__verification_platform_int_test`) + - Test results per test case from Feature Integration test (:need:`wp__verification_feat_int_test`) + - All test results shall include status ("passed/failed/not_run") + +**3. Integration test logs ** + - Test log per test case from Platform Integration Test (:need:`wp__verification_platform_int_test`) + - Test log per test case from Feature Integration test (:need:`wp__verification_feat_int_test`) + - All test results shall include status ("passed/failed/not_run") diff --git a/process/folder_templates/platform/index.rst b/process/folder_templates/platform/index.rst index 721fb404de..b7b6aa4e29 100644 --- a/process/folder_templates/platform/index.rst +++ b/process/folder_templates/platform/index.rst @@ -1,6 +1,6 @@ .. # ******************************************************************************* - # Copyright (c) 2024 Contributors to the Eclipse Foundation + # Copyright (c) 2026 Contributors to the Eclipse Foundation # # See the NOTICE file(s) distributed with this work for additional # information regarding copyright ownership. @@ -24,3 +24,5 @@ Platform requirements/stakeholder/chklst_req_inspection.rst safety_planning/index.rst safety_planning/platform_safety_analysis_fdr.rst + safety_mgt/index.rst + verification/platform_verification_report.rst diff --git a/process/folder_templates/platform/safety_analysis/platform_dfa.rst b/process/folder_templates/platform/safety_analysis/platform_dfa.rst index cf86ee24b4..2dafac8c92 100644 --- a/process/folder_templates/platform/safety_analysis/platform_dfa.rst +++ b/process/folder_templates/platform/safety_analysis/platform_dfa.rst @@ -29,13 +29,6 @@ Platform DFA (Dependent Failure Analysis) .. 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 Feature. - - - Modify ``Your Feature Name`` to be your Feature Name - - Modify ``id`` to be your Feature Name in upper snake case preceded by ``doc__`` and succeeded by ``_dfa`` - - Adjust ``status`` to be ``valid`` - - Adjust ``safety`` and ``tags`` according to your needs Dependent Failure Initiators ---------------------------- @@ -44,10 +37,10 @@ Dependent Failure Initiators .. plat_saf_dfa:: :violates: <Feature architecture> - :id: plat_saf_DFA__<Feature>__<Element descriptor> + :id: plat_saf_DFA__Platform__<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 Feature Requirement | ID from AoU Feature Requirement> + :mitigated_by: <ID from Stakeholder Requirement | ID from AoU Feature Requirement> :mitigation_issue: <ID from Issue Tracker> :sufficient: <yes|no> :status: <valid|invalid> From f15c6d4e0322b141bcbe33db675d8869ef9ed7a0 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Wed, 18 Feb 2026 13:49:28 +0100 Subject: [PATCH 02/36] 2501 attifunel: added missing templates From 654894814d71f6cc6fc98f2d1e7962b54cbb19c5 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Wed, 18 Feb 2026 14:16:15 +0100 Subject: [PATCH 03/36] 2501 attifunel: fixed index errors --- .../docs/verification/platform_verification_report.rst | 8 ++++---- process/folder_templates/platform/index.rst | 3 ++- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/process/folder_templates/platform/docs/verification/platform_verification_report.rst b/process/folder_templates/platform/docs/verification/platform_verification_report.rst index ca245753c9..4235dea692 100644 --- a/process/folder_templates/platform/docs/verification/platform_verification_report.rst +++ b/process/folder_templates/platform/docs/verification/platform_verification_report.rst @@ -28,7 +28,7 @@ Verification Report Verification Report contains: -**1. List of requirements and architecture tested ** +**1. List of requirements and architecture tested** - List of requirements (stakeholder and feature) tested by which test - List of architecture elements tested by which test (can be several levels) @@ -36,17 +36,17 @@ Verification Report contains: - For all tests, completeness verdict shall be report, including normal operation and failure reactions - The list of requirements may also contain other verification methods like “Analysis” -**2. Safety analyses ** +**2. Safety analyses** - Formal evidence about the performed DFA - Formal evidence about the performed Safety Analyses (this has to be compared against safety plan, i.e. needed only if FMEA actually planned on platform level) - Final statement resume (i.e. all passed, or are there open points, further actions needed, justifications etc.) -**2. Integration test results ** +**2. Integration test results** - Test results per test case from Platform Integration Test (:need:`wp__verification_platform_int_test`) - Test results per test case from Feature Integration test (:need:`wp__verification_feat_int_test`) - All test results shall include status ("passed/failed/not_run") -**3. Integration test logs ** +**3. Integration test logs** - Test log per test case from Platform Integration Test (:need:`wp__verification_platform_int_test`) - Test log per test case from Feature Integration test (:need:`wp__verification_feat_int_test`) - All test results shall include status ("passed/failed/not_run") diff --git a/process/folder_templates/platform/index.rst b/process/folder_templates/platform/index.rst index b7b6aa4e29..bc22e96849 100644 --- a/process/folder_templates/platform/index.rst +++ b/process/folder_templates/platform/index.rst @@ -25,4 +25,5 @@ Platform safety_planning/index.rst safety_planning/platform_safety_analysis_fdr.rst safety_mgt/index.rst - verification/platform_verification_report.rst + docs/safety_mgt/index.rst + docs/verification/platform_verification_report.rst From fabd70ca748ab03fdd7441ff0fd0845e545880f2 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Wed, 18 Feb 2026 14:21:06 +0100 Subject: [PATCH 04/36] 2501 attifunel fixed hopefully last index error --- process/folder_templates/platform/docs/safety_mgt/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/process/folder_templates/platform/docs/safety_mgt/index.rst b/process/folder_templates/platform/docs/safety_mgt/index.rst index abc7e63abb..2e1fc76a53 100644 --- a/process/folder_templates/platform/docs/safety_mgt/index.rst +++ b/process/folder_templates/platform/docs/safety_mgt/index.rst @@ -17,6 +17,7 @@ Safety Management .. toctree:: :titlesonly: - + platform_safety_plan_fdr platform_safety_package_fdr + platform_safety_analysis_fdr From 7a74e1b5a6b0bcac33af42b35c692fdf974892b4 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Wed, 18 Feb 2026 14:59:54 +0100 Subject: [PATCH 05/36] issue 2501 attifunel fixed TOC conflict --- process/folder_templates/platform/index.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/process/folder_templates/platform/index.rst b/process/folder_templates/platform/index.rst index bc22e96849..b67aa82a90 100644 --- a/process/folder_templates/platform/index.rst +++ b/process/folder_templates/platform/index.rst @@ -27,3 +27,6 @@ Platform safety_mgt/index.rst docs/safety_mgt/index.rst docs/verification/platform_verification_report.rst + requirements/stakeholder/chklst_req_inspection.rst + safety_planning/index.rst + safety_planning/platform_safety_analysis_fdr.rst From 0e54cb99fb05b691a98845a204304872d9a75be3 Mon Sep 17 00:00:00 2001 From: Philipp Ahmann <Philipp.Ahmann@de.bosch.com> Date: Wed, 18 Feb 2026 17:12:35 +0100 Subject: [PATCH 06/36] Fix build issues created during merge Correct one duplicated entry as copy-paste issue for safety_analysis_fdr Signed-off-by: Philipp Ahmann <Philipp.Ahmann@de.bosch.com> --- .../platform/docs/safety_mgt/platform_safety_analysis_fdr.rst | 2 +- process/folder_templates/platform/index.rst | 4 ---- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst index a3045bbd2b..5c8655ecc4 100644 --- a/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst @@ -17,7 +17,7 @@ Safety Analysis Checklist ========================= .. document:: Platform Safety Analysis Checklist - :id: doc__module_name_safety_analysis_fdr + :id: doc__platform_safety_analysis_fdr :status: draft :safety: ASIL_B :security: YES diff --git a/process/folder_templates/platform/index.rst b/process/folder_templates/platform/index.rst index b67aa82a90..9e6e940eee 100644 --- a/process/folder_templates/platform/index.rst +++ b/process/folder_templates/platform/index.rst @@ -24,9 +24,5 @@ Platform requirements/stakeholder/chklst_req_inspection.rst safety_planning/index.rst safety_planning/platform_safety_analysis_fdr.rst - safety_mgt/index.rst docs/safety_mgt/index.rst docs/verification/platform_verification_report.rst - requirements/stakeholder/chklst_req_inspection.rst - safety_planning/index.rst - safety_planning/platform_safety_analysis_fdr.rst From 0c2c356e7d5792a380ffaf930051df1e95a52550 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Wed, 18 Feb 2026 19:29:05 +0100 Subject: [PATCH 07/36] issue 574 attifunel fixed comments from review --- .../platform_safety_analysis_fdr.rst | 4 +- .../platform_safety_package_fdr.rst | 4 +- .../safety_mgt/platform_safety_plan_fdr.rst | 6 +- .../platform_verification_report.rst | 6 +- .../platform_safety_analysis_fdr.rst | 99 ------------------- 5 files changed, 10 insertions(+), 109 deletions(-) delete mode 100644 process/folder_templates/platform/safety_planning/platform_safety_analysis_fdr.rst diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst index 5c8655ecc4..0e9e2ff502 100644 --- a/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst @@ -13,8 +13,8 @@ # ******************************************************************************* -Safety Analysis Checklist -========================= +Platform Safety Analysis Checklist +================================== .. document:: Platform Safety Analysis Checklist :id: doc__platform_safety_analysis_fdr diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst index 761b7200eb..65d505a778 100644 --- a/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst @@ -12,8 +12,8 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Safety Package Formal Review Report -=================================== +Platform Safety Package Formal Review Report +============================================ .. note:: Document header diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst index 087a69dcc7..98c893cdcb 100644 --- a/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst @@ -12,12 +12,12 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Safety Plan Formal Review Report -================================ +Platform Safety Plan Formal Review Report +========================================= .. note:: Document header -.. document:: PlatformSafety Plan Formal Review +.. document:: Platform Safety Plan Formal Review :id: doc__platform_safety_plan_fdr :status: draft :safety: ASIL_B diff --git a/process/folder_templates/platform/docs/verification/platform_verification_report.rst b/process/folder_templates/platform/docs/verification/platform_verification_report.rst index 4235dea692..23b4068a4b 100644 --- a/process/folder_templates/platform/docs/verification/platform_verification_report.rst +++ b/process/folder_templates/platform/docs/verification/platform_verification_report.rst @@ -12,12 +12,12 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Verification Report -=================== +Platform Verification Report +============================ .. note:: Document header -.. document:: platform Verification Report +.. document:: Platform Verification Report :id: doc__platform_verification_report :status: draft :safety: ASIL_B diff --git a/process/folder_templates/platform/safety_planning/platform_safety_analysis_fdr.rst b/process/folder_templates/platform/safety_planning/platform_safety_analysis_fdr.rst deleted file mode 100644 index d97625d8da..0000000000 --- a/process/folder_templates/platform/safety_planning/platform_safety_analysis_fdr.rst +++ /dev/null @@ -1,99 +0,0 @@ -.. - # ******************************************************************************* - # 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 - # ******************************************************************************* - - -Safety Analysis Checklist -========================= - -.. document:: [Your Platform Name] Safety Analysis Checklist - :id: doc__platform_name_safety_analysis_fdr - :status: draft - :safety: ASIL_B - :security: YES - :realizes: wp__fdr_reports - :tags: template - -.. attention:: - The above directive must be updated according to your Platform. - - - Modify ``Your Platform Name`` to be your Platform Name - - Modify ``id`` to be your Platform Name in lower snake case preceded by ``doc__`` and followed by ``_safety _analysis_fdr`` - - Adjust ``status`` to be ``valid`` - - Adjust ``safety``, ``security`` and ``tags`` according to your needs - - -**Purpose** -The purpose of this Safety Analysis (DFA and FMEA) checklist template is to collect the topics to be checked during verification of the Safety Analysis. - -**Conduct** -As described in :need:`wf__p_formal_rv`, the formal document review is performed by an "external" safety manager: - -- reviewer: <committer with safety manager skills explicitly named here> - -**Checklist** - -Please note that it is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item and additional 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. See also :ref:`review_concept` for further information about reviews in general and inspection in particular. - -.. list-table:: Safety Analysis Checklist - :header-rows: 1 - :widths: 10,30,30,15,8,8 - - * - Review ID - - Acceptance Criteria - - Guidance - - Passed - - Remarks - - Issue link - * - REQ_01_01 - - Is / are the attribute sufficient set correctly? - - The mitigations shall have a direct influence ont the violation by prevention, detection or mitigation to reduce the risk to an acceptable level. - - The mitigations are sufficient. - - <yes|no> - - - * - REQ_01_02 - - Are the templates for DFA and/or FMEA used? - - See :ref:`dfa_templates` / :ref:`FMEA_templates` and also :ref:`process_requirements_safety_analysis` - - Templates are used to generate the DFA or / and FMEA. - - <yes|no> - - - * - REQ_01_03 - - Were the failure initiators / fault models applied? - - See :need:`gd_guidl__dfa_failure_initiators` / :need:`gd_guidl__fault_models` - - The applicable items of the failure initiators / fault models are used to ensure a structured analysis. For all not applicable items an argument shall be given in the content of the document. - - <yes|no> - - - * - REQ_01_04 - - Are the failure effects clearly and completely described? - - Use the generic failure effect descriptions and enlarge the description if it's applicable to the considered element. - - The effects of the failure is described completely. The effect can be recognized easily. - - <yes|no> - - - * - REQ_01_06 - - Is the attribute "mitigated by" linked correct? - - Check if the correct failure effect is linked via "mitigated by". - - The "mitigated by" link is correct. - - <yes|no> - - - * - REQ_01_07 - - Is the sufficiency of the "mitigated by" (prevention, detection or mitigation) described or can it be recognized easily? - - The sufficiency of the "mitigated by" is described in the content of the document. It can be recognized easily. - - The "mitigated by" shows clearly that a fault / failure can be mitigated by the linked requirement by prevention, detection or mitigation. It shall be described in the contend. - - <yes|no> - - - * - REQ_01_08 - - Is the overall result of the Safety Analysis described in the report? - - It shall be shown in the report if the Safety Analysis are finished and if all artifacts are "valid" and "sufficient". - - The results of the Safety Analysis are described in the report. The report is available :need:`wp__verification_platform_ver_report`. - - <yes|no> - - From 97298f7643324d74e6954ab0f3391c3c2a436afa Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Wed, 18 Feb 2026 19:33:38 +0100 Subject: [PATCH 08/36] issue 2501 attifunel fixed TOC problem --- process/folder_templates/platform/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/process/folder_templates/platform/index.rst b/process/folder_templates/platform/index.rst index 9e6e940eee..0a95bec675 100644 --- a/process/folder_templates/platform/index.rst +++ b/process/folder_templates/platform/index.rst @@ -25,4 +25,4 @@ Platform safety_planning/index.rst safety_planning/platform_safety_analysis_fdr.rst docs/safety_mgt/index.rst - docs/verification/platform_verification_report.rst + docs/verification/platform_verification_report.rst From 5b6a3f0c940e4ed12145cfca877c977111d188aa Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Wed, 18 Feb 2026 19:50:19 +0100 Subject: [PATCH 09/36] issue 2501 attifunel fixed python version in bazel file --- MODULE.bazel | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MODULE.bazel b/MODULE.bazel index 31b3576376..6500714ab2 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -29,7 +29,7 @@ bazel_dep(name = "rules_pkg", version = "1.1.0") # Python version # ############################################################################### -bazel_dep(name = "rules_python", version = "1.4.1") +bazel_dep(name = "rules_python", version = "1.8.3") PYTHON_VERSION = "3.12" From ed6cc64136a16a15853ced59c03029225f2faecf Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Thu, 19 Feb 2026 09:30:21 +0100 Subject: [PATCH 10/36] issue 2501 attifunel fixed missing link --- process/folder_templates/platform/index.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/process/folder_templates/platform/index.rst b/process/folder_templates/platform/index.rst index 0a95bec675..2b63337db4 100644 --- a/process/folder_templates/platform/index.rst +++ b/process/folder_templates/platform/index.rst @@ -23,6 +23,5 @@ Platform safety_analysis/platform_dfa.rst requirements/stakeholder/chklst_req_inspection.rst safety_planning/index.rst - safety_planning/platform_safety_analysis_fdr.rst docs/safety_mgt/index.rst - docs/verification/platform_verification_report.rst + docs/verification/platform_verification_report.rst From 3bb696609e3171c74a73983f57e46f57f3546af7 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Thu, 19 Feb 2026 09:37:53 +0100 Subject: [PATCH 11/36] issue 2501 attifunel fixing "platform name"-type link --- .../platform/docs/safety_mgt/platform_safety_analysis_fdr.rst | 2 +- .../safety_analysis/guidance/safety_analysis_checklist.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst index 0e9e2ff502..8ca74deff0 100644 --- a/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst @@ -17,7 +17,7 @@ Platform Safety Analysis Checklist ================================== .. document:: Platform Safety Analysis Checklist - :id: doc__platform_safety_analysis_fdr + :id: doc__platform_safety_analysis_fdr :status: draft :safety: ASIL_B :security: YES diff --git a/process/process_areas/safety_analysis/guidance/safety_analysis_checklist.rst b/process/process_areas/safety_analysis/guidance/safety_analysis_checklist.rst index a5c8e4f419..d7aed9b8f3 100644 --- a/process/process_areas/safety_analysis/guidance/safety_analysis_checklist.rst +++ b/process/process_areas/safety_analysis/guidance/safety_analysis_checklist.rst @@ -25,5 +25,5 @@ Safety Analysis Checklist For the content see here: - - :need:`doc__platform_name_safety_analysis_fdr` (platform) + - :need:`doc__platform_safety_analysis_fdr` (platform) - :need:`doc__module_name_safety_analysis_fdr` (module) From 4fb3d34590ca9ca8f70a72d060ad996b1e70fac8 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Thu, 19 Feb 2026 18:03:36 +0100 Subject: [PATCH 12/36] issue 2501 attifunel fixed further comments --- .../folder_templates/platform/docs/safety_mgt/index.rst | 2 ++ .../safety_mgt}/platform_dfa.rst | 0 .../docs/safety_mgt/platform_safety_package_fdr.rst | 9 +++++++-- .../safety_mgt/platform_safety_plan.rst} | 0 .../docs/safety_mgt/platform_safety_plan_fdr.rst | 9 +++++++-- process/folder_templates/platform/index.rst | 4 +--- 6 files changed, 17 insertions(+), 7 deletions(-) rename process/folder_templates/platform/{safety_analysis => docs/safety_mgt}/platform_dfa.rst (100%) rename process/folder_templates/platform/{safety_planning/index.rst => docs/safety_mgt/platform_safety_plan.rst} (100%) diff --git a/process/folder_templates/platform/docs/safety_mgt/index.rst b/process/folder_templates/platform/docs/safety_mgt/index.rst index 2e1fc76a53..34106b16ce 100644 --- a/process/folder_templates/platform/docs/safety_mgt/index.rst +++ b/process/folder_templates/platform/docs/safety_mgt/index.rst @@ -18,6 +18,8 @@ Safety Management .. toctree:: :titlesonly: + platform_dfa platform_safety_plan_fdr platform_safety_package_fdr platform_safety_analysis_fdr + platform_safety_plan diff --git a/process/folder_templates/platform/safety_analysis/platform_dfa.rst b/process/folder_templates/platform/docs/safety_mgt/platform_dfa.rst similarity index 100% rename from process/folder_templates/platform/safety_analysis/platform_dfa.rst rename to process/folder_templates/platform/docs/safety_mgt/platform_dfa.rst diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst index 65d505a778..497309008c 100644 --- a/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst @@ -26,11 +26,16 @@ Platform Safety Package Formal Review Report :tags: template -**1. Purpose** +**Purpose** The purpose of this review checklist is to report status of the formal review for the platform safety package. -**2. Checklist** +**Conduct** +As described in :need:`wf__p_formal_rv`, the formal document review is performed by an "external" safety manager: + +- reviewer: <committer with safety manager skills explicitly named here> + +**Checklist** .. list-table:: Safety Package Checklist :header-rows: 1 diff --git a/process/folder_templates/platform/safety_planning/index.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst similarity index 100% rename from process/folder_templates/platform/safety_planning/index.rst rename to process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst index 98c893cdcb..20bcbe5664 100644 --- a/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst @@ -26,11 +26,16 @@ Platform Safety Plan Formal Review Report :tags: template -**1. Purpose** +**Purpose** The purpose of this safety plan formal review checklist is to report status of the review for the platform safety plan. -**2. Checklist** +**Conduct** +As described in :need:`wf__p_formal_rv`, the formal document review is performed by an "external" safety manager: + +- reviewer: <committer with safety manager skills explicitly named here> + +**Checklist** .. list-table:: Safety Plan Checklist :header-rows: 1 diff --git a/process/folder_templates/platform/index.rst b/process/folder_templates/platform/index.rst index 2b63337db4..6a3da8bc56 100644 --- a/process/folder_templates/platform/index.rst +++ b/process/folder_templates/platform/index.rst @@ -20,8 +20,6 @@ Platform .. toctree:: :hidden: - safety_analysis/platform_dfa.rst - requirements/stakeholder/chklst_req_inspection.rst - safety_planning/index.rst + requirements/stakeholder/chklst_req_inspection.rst docs/safety_mgt/index.rst docs/verification/platform_verification_report.rst From 422dce029a98d526f65602ba48627785777a1387 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 11:55:46 +0100 Subject: [PATCH 13/36] 2501 attifunel fixed further review comments --- .../platform/docs/release/release_note.rst | 123 ++++++++++++++++++ .../platform_safety_analysis_fdr.rst | 12 +- .../safety_mgt/platform_safety_manual.rst | 98 ++++++++++++++ .../docs/safety_mgt/platform_safety_plan.rst | 2 +- 4 files changed, 228 insertions(+), 7 deletions(-) create mode 100644 process/folder_templates/platform/docs/release/release_note.rst create mode 100644 process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst diff --git a/process/folder_templates/platform/docs/release/release_note.rst b/process/folder_templates/platform/docs/release/release_note.rst new file mode 100644 index 0000000000..506e7d9631 --- /dev/null +++ b/process/folder_templates/platform/docs/release/release_note.rst @@ -0,0 +1,123 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Platform Release Note Template +============================== + +.. gd_temp:: Platform Release Note Template + :id: gd_temp__rel_plat_rel_note + :status: draft + :complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__aspice_40__SUP-8-BP7, std_req__aspice_40__SPL-2-BP1, std_req__aspice_40__iic-11-03, std_req__aspice_40__iic-18-06, std_req__aspice_40__SPL-2-BP2, std_req__aspice_40__SPL-2-BP3, std_req__aspice_40__iic-11-04, std_req__aspice_40__SPL-2-BP4, std_req__aspice_40__SPL-2-BP6 + :tags: template + + | Platform Release Notes + | ====================== + | Release Tag: vX.Y.Z + | Origin Release Tag: vU.V.W + | Release Commit Hash: a1b2c3d4e5f6g7h8i9j0 + | Release Date: YYYY-MM-DD + | Safety: [QM | ASIL_B] + | Security: [NO | YES] + | + | Overview + | -------- + | This document provides an overview of the changes, improvements, and bug fixes included in the platform release version vX.Y.Z + | as compared to the platform origin release (which is usually the previous release). + | + | Disclaimer + | ---------- + | This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment. + | The work products compiled in the safety package are created with care according to a process satisfying standards, but the **<e.g. S-CORE>** project, + | being a non-profit and open source organization, can not take over any liability for its content. + | + | New Features + | ------------ + | - **Feature 1**: Brief description of the new feature. + | - **Feature 2**: Brief description of the new feature. + | - **Feature 3**: Brief description of the new feature. + | + | Improvements + | ------------ + | - **Improvement 1**: Brief description of the improvement. + | - **Improvement 2**: Brief description of the improvement. + | - **Improvement 3**: Brief description of the improvement. + | + | Bug Fixes + | --------- + | - **Bug 1**: Brief description of the bug fix. + | - **Bug 2**: Brief description of the bug fix. + | - **Bug 3**: Brief description of the bug fix. + | + | Integrated Software Modules + | --------------------------- + | - **Module 1**: Version and brief description of the module. Link to Software module release note. + | - **Module 2**: Version and brief description of the module. Link to Software module release note. + | - **Module 3**: Version and brief description of the module. Link to Software module release note. + | + | Performed Verification + | ---------------------- + | This release note is based on the verification as documented in platform verification report + | **<add link here>** (report derived from template :need:`gd_temp__platform_ver_report`). + | + | Known Issues + | ------------ + | - **Issue 1**: Brief description of the known issue. Justification regarding safety impact. + | - **Issue 2**: Brief description of the known issue. Justification regarding safety impact. + | - **Issue 3**: Brief description of the known issue. Justification regarding safety impact. + | + | Known Vulnerabilities + | --------------------- + | - **CVE 1**: Brief description of the known CVE. Justification regarding security impact. + | - **CVE 2**: Brief description of the known CVE. Justification regarding security impact. + | - **CVE 3**: Brief description of the known CVE. Justification regarding security impact. + | + | Upgrade Instructions + | -------------------- + | + | 1. **Step 1**: Description of the first step. + | 2. **Step 2**: Description of the second step. + | 3. **Step 3**: Description of the third step. + | + | Contact Information + | ------------------- + | + | For any questions or support, please contact the *Project Lead* or raise an issue/discussion. + + +.. gd_temp:: Module Release Note Template + :id: gd_temp__rel_mod_rel_note + :status: valid + :complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__iso26262__support_12425, std_req__aspice_40__SPL-2-BP1, std_req__aspice_40__iic-11-03, std_req__aspice_40__iic-18-06, std_req__aspice_40__SPL-2-BP2, std_req__aspice_40__SPL-2-BP3, std_req__aspice_40__iic-11-04, std_req__aspice_40__SPL-2-BP4, std_req__aspice_40__SPL-2-BP6, std_req__aspice_40__REU-2-BP6 + + For the content see here: :need:`doc__module_name_release_note` + + +.. gd_temp:: Release Issue Template + :id: gd_temp__rel_issue + :status: valid + :complies: std_req__iso26262__management_64131, std_req__iso26262__management_64132, std_req__iso26262__management_64133, std_req__aspice_40__SPL-2-BP5, std_req__aspice_40__SPL-2-BP8 + + | Copy the below steps into the release ticket: + | + | Release **<add version number>** for **<platform/module_name>** + | ------------------------------------------------------- + | + | 1. Link this issue to the correct milestone and assign to a project/module lead + | 2. Check respective Verification report on the release candidate's baseline + | 3. Check bugfixes or justify failed tests + | 4. Check the safety package completeness (includes "valid" documents and work products status, supported by the safety manager) + | 5. Create/update the release note (pull request to close this issue) + | 6. Document project manager's consent by asking review approval of the release note + | 7. Create the "release" in version management tool according to :need:`gd_guidl__rel_management` + | 8. Merge PR and close this issue to complete the release diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst index 8ca74deff0..df6aa34efa 100644 --- a/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst @@ -13,11 +13,11 @@ # ******************************************************************************* -Platform Safety Analysis Checklist -================================== +Platform Safety Analysis Formal Review Report +============================================= -.. document:: Platform Safety Analysis Checklist - :id: doc__platform_safety_analysis_fdr +.. document:: Platform Safety Analysis Formal Review Report + :id: doc__platform_safety_analysis_fdr :status: draft :safety: ASIL_B :security: YES @@ -27,12 +27,12 @@ Platform Safety Analysis Checklist **Purpose** -The purpose of this Safety Analysis (DFA and FMEA) checklist template is to collect the topics to be checked during verification of the Platform Safety Analysis. +The purpose of this Safety Analysis (DFA and FMEA) formal review report template is to collect the topics to be checked during verification of the Platform Safety Analysis. **Conduct** As described in :need:`wf__p_formal_rv`, the formal document review is performed by an "external" safety manager: -- reviewer: <committer with safety manager skills explicitly named here> +- reviewer: **<committer with safety manager skills explicitly named here>** **Checklist** diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst new file mode 100644 index 0000000000..95b7ce9a6e --- /dev/null +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst @@ -0,0 +1,98 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Platform Safety Manual +====================== + +.. note:: Document header + +.. document:: Platform Safety Manual + :id: doc__platform_safety_manual + :status: draft + :safety: ASIL_B + :security: NO + :realizes: wp__module_safety_manual + :tags: template + +.. attention:: + The above directive must be updated. + + - Adjust ``status`` to be ``valid`` + - Adjust ``tags`` according to your needs + +Introduction/Scope +------------------ + +Assumed Platform Safety Requirements +------------------------------------ +| For the Platform the following safety related stakeholder requirements are assumed to define the top level functionality (purpose) of the Platform. I.e. from these all the feature and component requirements implemented are derived. +| **<List here all the stakeholder requirements, with safety not equal to QM, the module's components requirements are derived from. For the platform all are relevant.>** + +Assumptions of Use +------------------ + +Assumptions on the Environment +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +| Generally the assumption of the project platform SEooC is that it is integrated in a safe system, i.e. the POSIX OS it runs on is qualified and also the HW related failures are taken into account by the system integrator, if not otherwise stated in the module's safety concept. +| **<List here all the OS calls the project platform expects to be safe.>** + +List of AoUs expected from the environment the platform runs on: + +.. needtable:: + :style: table + :columns: title;id;status + :colwidths: 25,25,25 + :sort: title + + results = [] + + for need in needs.filter_types(["aou_req"]): + if need and "environment" in need["tags"]: + results.append(need) + +Assumptions on the User +^^^^^^^^^^^^^^^^^^^^^^^ +| As there is no assumption on which specific OS and HW is used, the integration testing of the stakeholder requirements is expected to be performed by the user of the platform SEooC. Tests covering all stakeholder and feature requirements performed on a reference platform (tbd link to reference platform specification), reviewed and passed are included in the platform SEooC safety package. +| Additionally the components of the platform may have additional specific assumptions how they are used. These are part of every module documentation: <link to add>. Assumptions from components to their users can be fulfilled in two ways: +| 1. There are assumption which need to be fulfilled by all SW components, e.g. "every user of an IPC mechanism needs to make sure that he provides correct data (including appropriate ASIL level)" - in this case the AoU is marked as "platform". +| 2. There are assumption which can be fulfilled by a safety mechanism realized by some other project platform component and are therefore not relevant for an user who uses the whole platform. But those are relevant if you chose to use the module SEooC stand-alone - in this case the AoU is marked as "module". An example would be the "JSON read" which requires "The user shall provide a string as input which is not corrupted due to HW or QM SW errors." - which is covered when using together with safe project platform persistency feature. + +**List of AoUs on the user of the platform:** + +**Note: Platform safety manual collects all platform wide AoU (have to be fulfilled by the user for any feature).** + +.. needtable:: + :style: table + :columns: title;id;status + :colwidths: 25,25,25 + :sort: title + + results = [] + + for need in needs.filter_types(["aou_req"]): + if need and "environment" not in need["tags"]: + results.append(need) + +Safety concept of the SEooC +--------------------------- +| **<Describe here the safety concept incl. which faults are taken care of, reactions of the implemented functions under anomalous operating conditions ... if this is not already documented sufficiently in the feature documentation "safety impact" section of all the features the module is used in.>** + +Safety Anomalies +---------------- +| Anomalies (bugs in ASIL SW, detected by testing or by users, which could not be fixed) known before release are documented in the platform/module release notes **<add link to release note>**. + +References +---------- +| **<link to the user manual>** +| **<other links>** diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst index f00f27e757..5b263ecb04 100644 --- a/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst @@ -26,7 +26,7 @@ Safety Planning :tags: template .. attention:: - The above directive must be updated according to your Platform. + The above directive must be updated. - Adjust ``status`` to be ``valid`` - Adjust ``safety``, ``security`` and ``tags`` according to your needs From 987e20eacf472d4f0e571ffd6fbccc36a9be6340 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 12:05:46 +0100 Subject: [PATCH 14/36] 2501 attifunel: fixed build errors --- process/folder_templates/platform/index.rst | 3 +- .../guidance/release_templates.rst | 106 +----------------- 2 files changed, 3 insertions(+), 106 deletions(-) diff --git a/process/folder_templates/platform/index.rst b/process/folder_templates/platform/index.rst index 6a3da8bc56..6d5ee71814 100644 --- a/process/folder_templates/platform/index.rst +++ b/process/folder_templates/platform/index.rst @@ -20,6 +20,7 @@ Platform .. toctree:: :hidden: - requirements/stakeholder/chklst_req_inspection.rst + requirements/stakeholder/chklst_req_inspection.rst + release/release_note.rst docs/safety_mgt/index.rst docs/verification/platform_verification_report.rst diff --git a/process/process_areas/release_management/guidance/release_templates.rst b/process/process_areas/release_management/guidance/release_templates.rst index ea267f09dc..b9af4761e7 100644 --- a/process/process_areas/release_management/guidance/release_templates.rst +++ b/process/process_areas/release_management/guidance/release_templates.rst @@ -15,108 +15,4 @@ Templates ========= -.. gd_temp:: Platform Release Note Template - :id: gd_temp__rel_plat_rel_note - :status: valid - :complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__aspice_40__SUP-8-BP7, std_req__aspice_40__SPL-2-BP1, std_req__aspice_40__iic-11-03, std_req__aspice_40__iic-18-06, std_req__aspice_40__SPL-2-BP2, std_req__aspice_40__SPL-2-BP3, std_req__aspice_40__iic-11-04, std_req__aspice_40__SPL-2-BP4, std_req__aspice_40__SPL-2-BP6 - - | Platform Release Notes - | ====================== - | Release Tag: vX.Y.Z - | Origin Release Tag: vU.V.W - | Release Commit Hash: a1b2c3d4e5f6g7h8i9j0 - | Release Date: YYYY-MM-DD - | Safety: [QM | ASIL_B] - | Security: [NO | YES] - | - | Overview - | -------- - | This document provides an overview of the changes, improvements, and bug fixes included in the platform release version vX.Y.Z - | as compared to the platform origin release (which is usually the previous release). - | - | Disclaimer - | ---------- - | This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment. - | The work products compiled in the safety package are created with care according to a process satisfying standards, but the <e.g. S-CORE> project, - | being a non-profit and open source organization, can not take over any liability for its content. - | - | New Features - | ------------ - | - **Feature 1**: Brief description of the new feature. - | - **Feature 2**: Brief description of the new feature. - | - **Feature 3**: Brief description of the new feature. - | - | Improvements - | ------------ - | - **Improvement 1**: Brief description of the improvement. - | - **Improvement 2**: Brief description of the improvement. - | - **Improvement 3**: Brief description of the improvement. - | - | Bug Fixes - | --------- - | - **Bug 1**: Brief description of the bug fix. - | - **Bug 2**: Brief description of the bug fix. - | - **Bug 3**: Brief description of the bug fix. - | - | Integrated Software Modules - | --------------------------- - | - **Module 1**: Version and brief description of the module. Link to Software module release note. - | - **Module 2**: Version and brief description of the module. Link to Software module release note. - | - **Module 3**: Version and brief description of the module. Link to Software module release note. - | - | Performed Verification - | ---------------------- - | This release note is based on the verification as documented in platform verification report - | <add link here> (report derived from template :need:`gd_temp__platform_ver_report`). - | - | Known Issues - | ------------ - | - **Issue 1**: Brief description of the known issue. Justification regarding safety impact. - | - **Issue 2**: Brief description of the known issue. Justification regarding safety impact. - | - **Issue 3**: Brief description of the known issue. Justification regarding safety impact. - | - | Known Vulnerabilities - | --------------------- - | - **CVE 1**: Brief description of the known CVE. Justification regarding security impact. - | - **CVE 2**: Brief description of the known CVE. Justification regarding security impact. - | - **CVE 3**: Brief description of the known CVE. Justification regarding security impact. - | - | Upgrade Instructions - | -------------------- - | - | 1. **Step 1**: Description of the first step. - | 2. **Step 2**: Description of the second step. - | 3. **Step 3**: Description of the third step. - | - | Contact Information - | ------------------- - | - | For any questions or support, please contact the *Project Lead* or raise an issue/discussion. - - -.. gd_temp:: Module Release Note Template - :id: gd_temp__rel_mod_rel_note - :status: valid - :complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__iso26262__support_12425, std_req__aspice_40__SPL-2-BP1, std_req__aspice_40__iic-11-03, std_req__aspice_40__iic-18-06, std_req__aspice_40__SPL-2-BP2, std_req__aspice_40__SPL-2-BP3, std_req__aspice_40__iic-11-04, std_req__aspice_40__SPL-2-BP4, std_req__aspice_40__SPL-2-BP6, std_req__aspice_40__REU-2-BP6 - - For the content see here: :need:`doc__module_name_release_note` - - -.. gd_temp:: Release Issue Template - :id: gd_temp__rel_issue - :status: valid - :complies: std_req__iso26262__management_64131, std_req__iso26262__management_64132, std_req__iso26262__management_64133, std_req__aspice_40__SPL-2-BP5, std_req__aspice_40__SPL-2-BP8 - - | Copy the below steps into the release ticket: - | - | Release <add version number> for <platform/module_name> - | ------------------------------------------------------- - | - | 1. Link this issue to the correct milestone and assign to a project/module lead - | 2. Check respective Verification report on the release candidate's baseline - | 3. Check bugfixes or justify failed tests - | 4. Check the safety package completeness (includes "valid" documents and work products status, supported by the safety manager) - | 5. Create/update the release note (pull request to close this issue) - | 6. Document project manager's consent by asking review approval of the release note - | 7. Create the "release" in version management tool according to :need:`gd_guidl__rel_management` - | 8. Merge PR and close this issue to complete the release +See :ref:`gd_temp__rel_plat_rel_note` From a4c8721a640923373e591fe7bcd03d30c8e4d048 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 14:22:01 +0100 Subject: [PATCH 15/36] 2501 attifunel fixed errors and further comments --- process/folder_templates/platform/docs/safety_mgt/index.rst | 1 + .../platform/docs/safety_mgt/platform_safety_plan.rst | 4 ++-- process/folder_templates/platform/index.rst | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/process/folder_templates/platform/docs/safety_mgt/index.rst b/process/folder_templates/platform/docs/safety_mgt/index.rst index 34106b16ce..2555b037fb 100644 --- a/process/folder_templates/platform/docs/safety_mgt/index.rst +++ b/process/folder_templates/platform/docs/safety_mgt/index.rst @@ -19,6 +19,7 @@ Safety Management :titlesonly: platform_dfa + platform_safety_manual platform_safety_plan_fdr platform_safety_package_fdr platform_safety_analysis_fdr diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst index 5b263ecb04..84952d436f 100644 --- a/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst @@ -14,8 +14,8 @@ .. _platform_safety_plan_template: -Safety Planning -############### +Platform Safety Planning +######################## .. document:: Platform Safety Plan :id: doc__platform_safety_plan diff --git a/process/folder_templates/platform/index.rst b/process/folder_templates/platform/index.rst index 6d5ee71814..af7fee49ad 100644 --- a/process/folder_templates/platform/index.rst +++ b/process/folder_templates/platform/index.rst @@ -21,6 +21,6 @@ Platform :hidden: requirements/stakeholder/chklst_req_inspection.rst - release/release_note.rst + docs/release/release_note.rst docs/safety_mgt/index.rst docs/verification/platform_verification_report.rst From 72755c39e537d2ec1ca4b4ea5dc28adb441d09f7 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 14:27:51 +0100 Subject: [PATCH 16/36] 2501 attifunel try to fix again ref error --- .../release_management/guidance/release_templates.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/process/process_areas/release_management/guidance/release_templates.rst b/process/process_areas/release_management/guidance/release_templates.rst index b9af4761e7..86fea78e12 100644 --- a/process/process_areas/release_management/guidance/release_templates.rst +++ b/process/process_areas/release_management/guidance/release_templates.rst @@ -15,4 +15,4 @@ Templates ========= -See :ref:`gd_temp__rel_plat_rel_note` +See :need:`gd_temp__rel_plat_rel_note` From 5b9d554c5494bddda77624e83390ae63c9111227 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 14:37:33 +0100 Subject: [PATCH 17/36] 2501 attifunel try to fix again ref error --- .../release_management/guidance/release_templates.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/process/process_areas/release_management/guidance/release_templates.rst b/process/process_areas/release_management/guidance/release_templates.rst index 86fea78e12..11ceae5390 100644 --- a/process/process_areas/release_management/guidance/release_templates.rst +++ b/process/process_areas/release_management/guidance/release_templates.rst @@ -12,7 +12,9 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* + Templates ========= -See :need:`gd_temp__rel_plat_rel_note` +See :ref:`gd_temp__rel_plat_rel_note` + From e0c3d0be66540a69aeff2ad53bd488ce7fca7bf5 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 15:04:40 +0100 Subject: [PATCH 18/36] 2501 attifunel fixed duplicate ver. rep. templates --- .../platform_verification_report.rst | 70 ++++----- .../guidance/verification_report_template.rst | 133 +----------------- 2 files changed, 43 insertions(+), 160 deletions(-) diff --git a/process/folder_templates/platform/docs/verification/platform_verification_report.rst b/process/folder_templates/platform/docs/verification/platform_verification_report.rst index 23b4068a4b..7f71ee23fb 100644 --- a/process/folder_templates/platform/docs/verification/platform_verification_report.rst +++ b/process/folder_templates/platform/docs/verification/platform_verification_report.rst @@ -1,17 +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 - # ******************************************************************************* - Platform Verification Report ============================ @@ -23,30 +9,48 @@ Platform Verification Report :safety: ASIL_B :security: YES :realizes: wp__verification_platform_ver_report + :complies: std_req__iso26262__software_1041, std_req__iso26262__software_1042, std_req__iso26262__software_1044, + std_req__iso26262__support_9431, std_req__iso26262__support_9432, std_req__iso26262__support_9433, std_req__iso26262__support_9434, + std_req__iso26262__analysis_749, std_req__iso26262__analysis_848 :tags: template + **Place the document header here following the definitions in template + :need:`gd_temp__documentation`.** + + This verification report is based on the :need:`wp__verification_plan`. + It covers all the selected features of the SW platform. + + Verification Report contains: + + **1. Verification Coverage** + + **1.1. on Requirements** + - Lists of feature requirements tested by which test case, passed/failed/not_run and completeness verdict + (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) + - For external component Assumptions of Use: coverage by platform safety manual or feature + - This is split in a list of QM requirements tested and a separate list of tests for ASIL rated requirements. + - List of feature requirements (ASIL rated) linked to inspection checklist and verdict (derived from PR export) + + **1.2. on Architecture** + - List of feature architecture tags tested by which test case, passed/failed and completeness verdict + (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) + - This is split in a list of QM features tested and a separate list of tests for ASIL rated features. + - List of feature architecture tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export) + + - The lists may also contain other verification methods like "Analysis" - process tbd -Verification Report contains: + **2. DFA Report** + - List of the performed Feature DFA, pass/fail with open mitigations -**1. List of requirements and architecture tested** + **3. Safety Analysis Report** + - List of the performed Feature Safety Analysis, pass/fail with open mitigations - - List of requirements (stakeholder and feature) tested by which test - - List of architecture elements tested by which test (can be several levels) - - For all tests "passed/failed" shall be reported - - For all tests, completeness verdict shall be report, including normal operation and failure reactions - - The list of requirements may also contain other verification methods like “Analysis” + **4. Test results** + - Test result per test case with status passed/failed/not_run -**2. Safety analyses** - - Formal evidence about the performed DFA - - Formal evidence about the performed Safety Analyses (this has to be compared against safety plan, i.e. needed only if FMEA actually planned on platform level) - - Final statement resume (i.e. all passed, or are there open points, further actions needed, justifications etc.) + **5. Test logs** + - Test log per test case with status passed/failed/not_run -**2. Integration test results** - - Test results per test case from Platform Integration Test (:need:`wp__verification_platform_int_test`) - - Test results per test case from Feature Integration test (:need:`wp__verification_feat_int_test`) - - All test results shall include status ("passed/failed/not_run") + **Note1:** The verification report is valid for the platform version tagged together with the report -**3. Integration test logs** - - Test log per test case from Platform Integration Test (:need:`wp__verification_platform_int_test`) - - Test log per test case from Feature Integration test (:need:`wp__verification_feat_int_test`) - - All test results shall include status ("passed/failed/not_run") + **Note2:** All the above lists are generated automatically diff --git a/process/process_areas/verification/guidance/verification_report_template.rst b/process/process_areas/verification/guidance/verification_report_template.rst index 3f74cdc8b3..9ee219bb7b 100644 --- a/process/process_areas/verification/guidance/verification_report_template.rst +++ b/process/process_areas/verification/guidance/verification_report_template.rst @@ -14,133 +14,12 @@ .. _verification_report_templates: -Verification Report Templates -============================= +Module Verification Report Templates +==================================== -.. gd_temp:: Module Verification Report Template - :id: gd_temp__mod_ver_report - :status: valid - :complies: std_req__iso26262__software_942, std_req__iso26262__software_943, std_req__iso26262__software_944, - std_req__iso26262__software_1041, std_req__iso26262__software_1042, std_req__iso26262__software_1043, - std_req__iso26262__support_9431, std_req__iso26262__support_9432, std_req__iso26262__support_9433, std_req__iso26262__support_9434, - std_req__iso26262__support_12422, std_req__iso26262__support_12424, std_req__iso26262__support_12425, std_req__iso26262__support_1243, - std_req__iso26262__analysis_749, std_req__iso26262__analysis_848, - std_req__aspice_40__SWE-4-BP3, std_req__aspice_40__SWE-5-BP4, std_req__aspice_40__SWE-5-BP5, std_req__aspice_40__SWE-6-BP3, std_req__aspice_40__iic-03-50, std_req__aspice_40__iic-15-52, - std_req__aspice_40__SWE-4-BP5, std_req__aspice_40__SWE-5-BP7, std_req__aspice_40__SWE-6-BP5, std_req__aspice_40__iic-13-51, std_req__aspice_40__iic-13-52 +See :need:`doc__module_name_verification_report`. - This document implements :need:`wp__verification_module_ver_report`. +Platform Verification Report Templates +====================================== - | Place the document header here following the definitions in template - | :need:`gd_temp__documentation`. - | - | This verification report is based on the :need:`wp__verification_plan`. - | It covers all the components of the above stated module. - | - | Verification Report contains: - | - | **1. Verification Coverage** - | - | **1.1. on Requirements** - | - Lists of component requirements (incl. AoU satisfied by the component) tested by which test case, passed/failed/not_run and completeness verdict - | (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - | - For external component Assumptions of Use: coverage by platform safety manual or feature/components incl. test case, passed/failed and completeness verdict - | - This is split in a list of QM requirements tested and a separate list of tests for ASIL rated requirements. - | - List of component requirements (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - | - | **1.2. on Architecture** - | - List of component architecture tags tested by which test case, passed/failed and completeness verdict - | (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - | - This is split in a list of QM components tested and a separate list of tests for ASIL rated components. - | - List of component architecture tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - | - | **1.3. on Detailed Design** - | - List of detailed design tags tested by which test case, passed/failed and completeness verdict - | (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - | - This is split in a list of QM components tested and a separate list of tests for ASIL rated components. - | - List of detailed design tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - | - | - The lists may also contain other verification methods like "Analysis" - process tbd - | - | **2. DFA Report** - | - List of the performed component DFA, pass/fail with open mitigations - | - | **3. Safety Analysis Report** - | - List of the performed component Safety Analysis, pass/fail with open mitigations - | - | **4. Unit Verification Coverage** - | - | **4.1. Structural Coverage** - | - List of the units with C0(line) and C1(branch) coverage absolute and percentage - | (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - | - List includes a column for the safety rating of each unit. - | - | **4.2. Static Code Analysis** - | - List of the units with compiler warning numbers and coding rule violation numbers - | (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - | - List includes a column for the safety rating of each unit. - | - | **4.3. Manual Code Inspection** - | - List of components (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - | - | **5. Software component qualification verification report** - | - Contains the needed verification results if for some components a qualification of pre-developed SW is performed. - | - | **6. Test results** - | - Test result per test case with status passed/failed/not_run - | - | **7. Test logs** - | - Test log per test case with status passed/failed/not_run - - **Note1:** The verification report is valid for the module version tagged together with the report - - **Note2:** All the above lists are generated automatically - -.. gd_temp:: Platform Verification Report Template - :id: gd_temp__platform_ver_report - :status: valid - :complies: std_req__iso26262__software_1041, std_req__iso26262__software_1042, std_req__iso26262__software_1044, - std_req__iso26262__support_9431, std_req__iso26262__support_9432, std_req__iso26262__support_9433, std_req__iso26262__support_9434, - std_req__iso26262__analysis_749, std_req__iso26262__analysis_848 - - This document implements :need:`wp__verification_platform_ver_report`. - - | Place the document header here following the definitions in template - | :need:`gd_temp__documentation`. - | - | This verification report is based on the :need:`wp__verification_plan`. - | It covers all the selected features of the SW platform. - | - | Verification Report contains: - | - | **1. Verification Coverage** - | - | **1.1. on Requirements** - | - Lists of feature requirements tested by which test case, passed/failed/not_run and completeness verdict - | (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - | - For external component Assumptions of Use: coverage by platform safety manual or feature - | - This is split in a list of QM requirements tested and a separate list of tests for ASIL rated requirements. - | - List of feature requirements (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - | - | **1.2. on Architecture** - | - List of feature architecture tags tested by which test case, passed/failed and completeness verdict - | (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - | - This is split in a list of QM features tested and a separate list of tests for ASIL rated features. - | - List of feature architecture tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - | - | - The lists may also contain other verification methods like "Analysis" - process tbd - | - | **2. DFA Report** - | - List of the performed Feature DFA, pass/fail with open mitigations - | - | **3. Safety Analysis Report** - | - List of the performed Feature Safety Analysis, pass/fail with open mitigations - | - | **4. Test results** - | - Test result per test case with status passed/failed/not_run - | - | **5. Test logs** - | - Test log per test case with status passed/failed/not_run - - **Note1:** The verification report is valid for the platform version tagged together with the report - - **Note2:** All the above lists are generated automatically +See :need:`doc__platform_verification_report`. From d1d955e3d4ac9a75da431519f0602b3799aa9fb0 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 15:14:15 +0100 Subject: [PATCH 19/36] 2501 attifunel fixed duplicate ver. rep. templates --- .../docs/verification/module_verification_report.rst | 3 +-- .../docs/verification/platform_verification_report.rst | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst b/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst index 7083f1d80f..a42d085fd2 100644 --- a/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst +++ b/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst @@ -18,7 +18,7 @@ Verification Report .. note:: Document header .. document:: [Your Module Name] Verification Report - :id: doc__module_name_verification_report + :id: gd_temp__mod_ver_report :status: draft :safety: ASIL_B :security: NO @@ -33,7 +33,6 @@ Verification Report - Adjust ``status`` to be ``valid`` - Adjust ``safety`` and ``tags`` according to your needs - This verification report is based on the :need:`gd_temp__verification_plan`. It covers all the components of the above stated module. diff --git a/process/folder_templates/platform/docs/verification/platform_verification_report.rst b/process/folder_templates/platform/docs/verification/platform_verification_report.rst index 7f71ee23fb..5981a86f5c 100644 --- a/process/folder_templates/platform/docs/verification/platform_verification_report.rst +++ b/process/folder_templates/platform/docs/verification/platform_verification_report.rst @@ -4,7 +4,7 @@ Platform Verification Report .. note:: Document header .. document:: Platform Verification Report - :id: doc__platform_verification_report + :id: gd_temp__platform_ver_report :status: draft :safety: ASIL_B :security: YES From 77ca7ed723b8cdbb6b7322ebde6597d465f40b5d Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 15:27:59 +0100 Subject: [PATCH 20/36] 2501 fix links from guidance to templates --- .../module_name/docs/release/release_note.rst | 2 +- .../platform_verification_report.rst | 7 ++--- .../guidance/verification_report_template.rst | 31 +++++++++++++++---- 3 files changed, 28 insertions(+), 12 deletions(-) diff --git a/process/folder_templates/modules/module_name/docs/release/release_note.rst b/process/folder_templates/modules/module_name/docs/release/release_note.rst index 215065943e..0f3324b5cf 100644 --- a/process/folder_templates/modules/module_name/docs/release/release_note.rst +++ b/process/folder_templates/modules/module_name/docs/release/release_note.rst @@ -91,7 +91,7 @@ Release Note | Performed Verification | ---------------------- | This release note is based on the verification as documented in module verification report -| :need:`doc__module_name_verification_report`. +| :need:`gd_temp__mod_ver_report`. | | Known Issues | ------------ diff --git a/process/folder_templates/platform/docs/verification/platform_verification_report.rst b/process/folder_templates/platform/docs/verification/platform_verification_report.rst index 5981a86f5c..acffa83f97 100644 --- a/process/folder_templates/platform/docs/verification/platform_verification_report.rst +++ b/process/folder_templates/platform/docs/verification/platform_verification_report.rst @@ -4,14 +4,11 @@ Platform Verification Report .. note:: Document header .. document:: Platform Verification Report - :id: gd_temp__platform_ver_report + :id: doc__platform_verification_report :status: draft :safety: ASIL_B :security: YES :realizes: wp__verification_platform_ver_report - :complies: std_req__iso26262__software_1041, std_req__iso26262__software_1042, std_req__iso26262__software_1044, - std_req__iso26262__support_9431, std_req__iso26262__support_9432, std_req__iso26262__support_9433, std_req__iso26262__support_9434, - std_req__iso26262__analysis_749, std_req__iso26262__analysis_848 :tags: template **Place the document header here following the definitions in template @@ -26,7 +23,7 @@ Platform Verification Report **1.1. on Requirements** - Lists of feature requirements tested by which test case, passed/failed/not_run and completeness verdict - (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) + (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - For external component Assumptions of Use: coverage by platform safety manual or feature - This is split in a list of QM requirements tested and a separate list of tests for ASIL rated requirements. - List of feature requirements (ASIL rated) linked to inspection checklist and verdict (derived from PR export) diff --git a/process/process_areas/verification/guidance/verification_report_template.rst b/process/process_areas/verification/guidance/verification_report_template.rst index 9ee219bb7b..dfec446e78 100644 --- a/process/process_areas/verification/guidance/verification_report_template.rst +++ b/process/process_areas/verification/guidance/verification_report_template.rst @@ -14,12 +14,31 @@ .. _verification_report_templates: -Module Verification Report Templates -==================================== +Verification Report Templates +============================= -See :need:`doc__module_name_verification_report`. +.. gd_temp:: Module Verification Report Template + :id: gd_temp__mod_ver_report + :status: valid + :complies: std_req__iso26262__software_942, std_req__iso26262__software_943, std_req__iso26262__software_944, + std_req__iso26262__software_1041, std_req__iso26262__software_1042, std_req__iso26262__software_1043, + std_req__iso26262__support_9431, std_req__iso26262__support_9432, std_req__iso26262__support_9433, std_req__iso26262__support_9434, + std_req__iso26262__support_12422, std_req__iso26262__support_12424, std_req__iso26262__support_12425, std_req__iso26262__support_1243, + std_req__iso26262__analysis_749, std_req__iso26262__analysis_848, + std_req__aspice_40__SWE-4-BP3, std_req__aspice_40__SWE-5-BP4, std_req__aspice_40__SWE-5-BP5, std_req__aspice_40__SWE-6-BP3, std_req__aspice_40__iic-03-50, std_req__aspice_40__iic-15-52, + std_req__aspice_40__SWE-4-BP5, std_req__aspice_40__SWE-5-BP7, std_req__aspice_40__SWE-6-BP5, std_req__aspice_40__iic-13-51, std_req__aspice_40__iic-13-52 -Platform Verification Report Templates -====================================== + This document implements :need:`wp__verification_module_ver_report`. -See :need:`doc__platform_verification_report`. + | For the content, see :need:`doc__module_name_verification_report`. + +.. gd_temp:: Platform Verification Report Template + :id: gd_temp__platform_ver_report + :status: valid + :complies: std_req__iso26262__software_1041, std_req__iso26262__software_1042, std_req__iso26262__software_1044, + std_req__iso26262__support_9431, std_req__iso26262__support_9432, std_req__iso26262__support_9433, std_req__iso26262__support_9434, + std_req__iso26262__analysis_749, std_req__iso26262__analysis_848 + + This document implements :need:`wp__verification_platform_ver_report`. + + | For the content, see :need:`doc__platform_verification_report`. From e315dde945c199d87b1ea8f5d483824f31a60ae2 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 15:35:38 +0100 Subject: [PATCH 21/36] 2501 fixing wrong links again --- .../module_verification_report.rst | 2 +- .../platform_verification_report.rst | 2 +- .../guidance/release_templates.rst | 35 +++++++++++++++++-- 3 files changed, 35 insertions(+), 4 deletions(-) diff --git a/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst b/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst index a42d085fd2..bf112f5c7e 100644 --- a/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst +++ b/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst @@ -18,7 +18,7 @@ Verification Report .. note:: Document header .. document:: [Your Module Name] Verification Report - :id: gd_temp__mod_ver_report + :id: doc__module_name_verification_report :status: draft :safety: ASIL_B :security: NO diff --git a/process/folder_templates/platform/docs/verification/platform_verification_report.rst b/process/folder_templates/platform/docs/verification/platform_verification_report.rst index acffa83f97..adc5347955 100644 --- a/process/folder_templates/platform/docs/verification/platform_verification_report.rst +++ b/process/folder_templates/platform/docs/verification/platform_verification_report.rst @@ -23,7 +23,7 @@ Platform Verification Report **1.1. on Requirements** - Lists of feature requirements tested by which test case, passed/failed/not_run and completeness verdict - (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) + (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - For external component Assumptions of Use: coverage by platform safety manual or feature - This is split in a list of QM requirements tested and a separate list of tests for ASIL rated requirements. - List of feature requirements (ASIL rated) linked to inspection checklist and verdict (derived from PR export) diff --git a/process/process_areas/release_management/guidance/release_templates.rst b/process/process_areas/release_management/guidance/release_templates.rst index 11ceae5390..70eb746238 100644 --- a/process/process_areas/release_management/guidance/release_templates.rst +++ b/process/process_areas/release_management/guidance/release_templates.rst @@ -12,9 +12,40 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* - Templates ========= -See :ref:`gd_temp__rel_plat_rel_note` +.. gd_temp:: Platform Release Note Template + :id: gd_temp__rel_plat_rel_note + :status: valid + :complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__aspice_40__SUP-8-BP7, std_req__aspice_40__SPL-2-BP1, std_req__aspice_40__iic-11-03, std_req__aspice_40__iic-18-06, std_req__aspice_40__SPL-2-BP2, std_req__aspice_40__SPL-2-BP3, std_req__aspice_40__iic-11-04, std_req__aspice_40__SPL-2-BP4, std_req__aspice_40__SPL-2-BP6 + + For the content see here: :need:`doc__platform_release_note` + + +.. gd_temp:: Module Release Note Template + :id: gd_temp__rel_mod_rel_note + :status: valid + :complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__iso26262__support_12425, std_req__aspice_40__SPL-2-BP1, std_req__aspice_40__iic-11-03, std_req__aspice_40__iic-18-06, std_req__aspice_40__SPL-2-BP2, std_req__aspice_40__SPL-2-BP3, std_req__aspice_40__iic-11-04, std_req__aspice_40__SPL-2-BP4, std_req__aspice_40__SPL-2-BP6, std_req__aspice_40__REU-2-BP6 + + For the content see here: :need:`doc__module_name_release_note` + + +.. gd_temp:: Release Issue Template + :id: gd_temp__rel_issue + :status: valid + :complies: std_req__iso26262__management_64131, std_req__iso26262__management_64132, std_req__iso26262__management_64133, std_req__aspice_40__SPL-2-BP5, std_req__aspice_40__SPL-2-BP8 + | Copy the below steps into the release ticket: + | + | Release <add version number> for <platform/module_name> + | ------------------------------------------------------- + | + | 1. Link this issue to the correct milestone and assign to a project/module lead + | 2. Check respective Verification report on the release candidate's baseline + | 3. Check bugfixes or justify failed tests + | 4. Check the safety package completeness (includes "valid" documents and work products status, supported by the safety manager) + | 5. Create/update the release note (pull request to close this issue) + | 6. Document project manager's consent by asking review approval of the release note + | 7. Create the "release" in version management tool according to :need:`gd_guidl__rel_management` + | 8. Merge PR and close this issue to complete the release From 7c3662ceeac926dda66451f738079c5557bb184c Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 15:43:12 +0100 Subject: [PATCH 22/36] 2501 fixing further indent problems --- process/folder_templates/platform/docs/release/release_note.rst | 2 +- .../platform/docs/verification/platform_verification_report.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/process/folder_templates/platform/docs/release/release_note.rst b/process/folder_templates/platform/docs/release/release_note.rst index 506e7d9631..a188c26de3 100644 --- a/process/folder_templates/platform/docs/release/release_note.rst +++ b/process/folder_templates/platform/docs/release/release_note.rst @@ -16,7 +16,7 @@ Platform Release Note Template ============================== .. gd_temp:: Platform Release Note Template - :id: gd_temp__rel_plat_rel_note + :id: doc__platform_release_note :status: draft :complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__aspice_40__SUP-8-BP7, std_req__aspice_40__SPL-2-BP1, std_req__aspice_40__iic-11-03, std_req__aspice_40__iic-18-06, std_req__aspice_40__SPL-2-BP2, std_req__aspice_40__SPL-2-BP3, std_req__aspice_40__iic-11-04, std_req__aspice_40__SPL-2-BP4, std_req__aspice_40__SPL-2-BP6 :tags: template diff --git a/process/folder_templates/platform/docs/verification/platform_verification_report.rst b/process/folder_templates/platform/docs/verification/platform_verification_report.rst index adc5347955..9a0fb86d5f 100644 --- a/process/folder_templates/platform/docs/verification/platform_verification_report.rst +++ b/process/folder_templates/platform/docs/verification/platform_verification_report.rst @@ -30,7 +30,7 @@ Platform Verification Report **1.2. on Architecture** - List of feature architecture tags tested by which test case, passed/failed and completeness verdict - (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) + (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - This is split in a list of QM features tested and a separate list of tests for ASIL rated features. - List of feature architecture tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export) From f88b151c25d0e71cc08733b614b4df6d0874eb66 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 15:50:14 +0100 Subject: [PATCH 23/36] 2501 fixing further indent and links problems --- .../platform/docs/release/release_note.rst | 8 ++++++-- .../platform_verification_report.rst | 16 ++++++++-------- 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/process/folder_templates/platform/docs/release/release_note.rst b/process/folder_templates/platform/docs/release/release_note.rst index a188c26de3..728987afde 100644 --- a/process/folder_templates/platform/docs/release/release_note.rst +++ b/process/folder_templates/platform/docs/release/release_note.rst @@ -15,10 +15,14 @@ Platform Release Note Template ============================== -.. gd_temp:: Platform Release Note Template +.. note:: Document header + +.. document:: Platform Release Note :id: doc__platform_release_note :status: draft - :complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__aspice_40__SUP-8-BP7, std_req__aspice_40__SPL-2-BP1, std_req__aspice_40__iic-11-03, std_req__aspice_40__iic-18-06, std_req__aspice_40__SPL-2-BP2, std_req__aspice_40__SPL-2-BP3, std_req__aspice_40__iic-11-04, std_req__aspice_40__SPL-2-BP4, std_req__aspice_40__SPL-2-BP6 + :safety: ASIL_B + :security: NO + :realizes: wp__platform_sw_release_note :tags: template | Platform Release Notes diff --git a/process/folder_templates/platform/docs/verification/platform_verification_report.rst b/process/folder_templates/platform/docs/verification/platform_verification_report.rst index 9a0fb86d5f..9bfd0c1da8 100644 --- a/process/folder_templates/platform/docs/verification/platform_verification_report.rst +++ b/process/folder_templates/platform/docs/verification/platform_verification_report.rst @@ -29,24 +29,24 @@ Platform Verification Report - List of feature requirements (ASIL rated) linked to inspection checklist and verdict (derived from PR export) **1.2. on Architecture** - - List of feature architecture tags tested by which test case, passed/failed and completeness verdict + - List of feature architecture tags tested by which test case, passed/failed and completeness verdict (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - - This is split in a list of QM features tested and a separate list of tests for ASIL rated features. - - List of feature architecture tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export) + - This is split in a list of QM features tested and a separate list of tests for ASIL rated features. + - List of feature architecture tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - - The lists may also contain other verification methods like "Analysis" - process tbd + - The lists may also contain other verification methods like "Analysis" - process tbd **2. DFA Report** - - List of the performed Feature DFA, pass/fail with open mitigations + - List of the performed Feature DFA, pass/fail with open mitigations **3. Safety Analysis Report** - - List of the performed Feature Safety Analysis, pass/fail with open mitigations + - List of the performed Feature Safety Analysis, pass/fail with open mitigations **4. Test results** - - Test result per test case with status passed/failed/not_run + - Test result per test case with status passed/failed/not_run **5. Test logs** - - Test log per test case with status passed/failed/not_run + - Test log per test case with status passed/failed/not_run **Note1:** The verification report is valid for the platform version tagged together with the report From 919dc34ffe9c3da08e822904e18a1e62d24d32cf Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 16:02:16 +0100 Subject: [PATCH 24/36] 2501 fixed copypaste error --- .../platform/docs/release/release_note.rst | 30 +------------------ 1 file changed, 1 insertion(+), 29 deletions(-) diff --git a/process/folder_templates/platform/docs/release/release_note.rst b/process/folder_templates/platform/docs/release/release_note.rst index 728987afde..6d4fe12085 100644 --- a/process/folder_templates/platform/docs/release/release_note.rst +++ b/process/folder_templates/platform/docs/release/release_note.rst @@ -18,7 +18,7 @@ Platform Release Note Template .. note:: Document header .. document:: Platform Release Note - :id: doc__platform_release_note + :id: gd_temp__rel_mod_rel_note :status: draft :safety: ASIL_B :security: NO @@ -97,31 +97,3 @@ Platform Release Note Template | ------------------- | | For any questions or support, please contact the *Project Lead* or raise an issue/discussion. - - -.. gd_temp:: Module Release Note Template - :id: gd_temp__rel_mod_rel_note - :status: valid - :complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__iso26262__support_12425, std_req__aspice_40__SPL-2-BP1, std_req__aspice_40__iic-11-03, std_req__aspice_40__iic-18-06, std_req__aspice_40__SPL-2-BP2, std_req__aspice_40__SPL-2-BP3, std_req__aspice_40__iic-11-04, std_req__aspice_40__SPL-2-BP4, std_req__aspice_40__SPL-2-BP6, std_req__aspice_40__REU-2-BP6 - - For the content see here: :need:`doc__module_name_release_note` - - -.. gd_temp:: Release Issue Template - :id: gd_temp__rel_issue - :status: valid - :complies: std_req__iso26262__management_64131, std_req__iso26262__management_64132, std_req__iso26262__management_64133, std_req__aspice_40__SPL-2-BP5, std_req__aspice_40__SPL-2-BP8 - - | Copy the below steps into the release ticket: - | - | Release **<add version number>** for **<platform/module_name>** - | ------------------------------------------------------- - | - | 1. Link this issue to the correct milestone and assign to a project/module lead - | 2. Check respective Verification report on the release candidate's baseline - | 3. Check bugfixes or justify failed tests - | 4. Check the safety package completeness (includes "valid" documents and work products status, supported by the safety manager) - | 5. Create/update the release note (pull request to close this issue) - | 6. Document project manager's consent by asking review approval of the release note - | 7. Create the "release" in version management tool according to :need:`gd_guidl__rel_management` - | 8. Merge PR and close this issue to complete the release From e644491ccb7a669b8f37c4bb9e5d4ee33eabca48 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 16:07:04 +0100 Subject: [PATCH 25/36] 2501 fixing wrong doc id --- process/folder_templates/platform/docs/release/release_note.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/process/folder_templates/platform/docs/release/release_note.rst b/process/folder_templates/platform/docs/release/release_note.rst index 6d4fe12085..daa1f42b8e 100644 --- a/process/folder_templates/platform/docs/release/release_note.rst +++ b/process/folder_templates/platform/docs/release/release_note.rst @@ -18,7 +18,7 @@ Platform Release Note Template .. note:: Document header .. document:: Platform Release Note - :id: gd_temp__rel_mod_rel_note + :id: doc__platform_release_note :status: draft :safety: ASIL_B :security: NO From 8af722f65e642a157901093b07c7514c2bd55fd5 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 16:54:11 +0100 Subject: [PATCH 26/36] 2501 fixing ambiguity in Safety Analyses --- .../verification/platform_verification_report.rst | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/process/folder_templates/platform/docs/verification/platform_verification_report.rst b/process/folder_templates/platform/docs/verification/platform_verification_report.rst index 9bfd0c1da8..88eee619ed 100644 --- a/process/folder_templates/platform/docs/verification/platform_verification_report.rst +++ b/process/folder_templates/platform/docs/verification/platform_verification_report.rst @@ -36,16 +36,13 @@ Platform Verification Report - The lists may also contain other verification methods like "Analysis" - process tbd - **2. DFA Report** - - List of the performed Feature DFA, pass/fail with open mitigations + **2. Safety Analyses Report** + - List of the performed Feature Safety Analyses, pass/fail with open mitigations - **3. Safety Analysis Report** - - List of the performed Feature Safety Analysis, pass/fail with open mitigations - - **4. Test results** + **3. Test results** - Test result per test case with status passed/failed/not_run - **5. Test logs** + **4. Test logs** - Test log per test case with status passed/failed/not_run **Note1:** The verification report is valid for the platform version tagged together with the report From c947aaa2deba9594f9d4b40918004eef184c1113 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 17:02:56 +0100 Subject: [PATCH 27/36] 2501 some fixes at verification report template --- .../platform_verification_report.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/process/folder_templates/platform/docs/verification/platform_verification_report.rst b/process/folder_templates/platform/docs/verification/platform_verification_report.rst index 88eee619ed..524d5a5719 100644 --- a/process/folder_templates/platform/docs/verification/platform_verification_report.rst +++ b/process/folder_templates/platform/docs/verification/platform_verification_report.rst @@ -22,11 +22,11 @@ Platform Verification Report **1. Verification Coverage** **1.1. on Requirements** - - Lists of feature requirements tested by which test case, passed/failed/not_run and completeness verdict + - Lists of stakeholder and feature requirements tested by which test case, passed/failed/not_run and completeness verdict (this shall be generated by tools and accompanied by progress charts to be usable also for project steering) - - For external component Assumptions of Use: coverage by platform safety manual or feature + - For external component Assumptions of Use: coverage by platform safety manual - This is split in a list of QM requirements tested and a separate list of tests for ASIL rated requirements. - - List of feature requirements (ASIL rated) linked to inspection checklist and verdict (derived from PR export) + - List of stakeholder requirements (ASIL rated) linked to inspection checklist and verdict (derived from PR export) **1.2. on Architecture** - List of feature architecture tags tested by which test case, passed/failed and completeness verdict @@ -34,16 +34,17 @@ Platform Verification Report - This is split in a list of QM features tested and a separate list of tests for ASIL rated features. - List of feature architecture tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - - The lists may also contain other verification methods like "Analysis" - process tbd + - The lists may also contain other verification methods **2. Safety Analyses Report** - - List of the performed Feature Safety Analyses, pass/fail with open mitigations + - List of the performed Platform and Feature Safety Analyses, pass/fail with open mitigations **3. Test results** - - Test result per test case with status passed/failed/not_run - + - Test result per test case with status passed/failed/not_run for :need:`wp__verification_platform_int_test` and :need:`wp__verification_feat_int_test` + **4. Test logs** - - Test log per test case with status passed/failed/not_run + - Test log per test case with status passed/failed/not_run for :need:`wp__verification_platform_int_test` and :need:`wp__verification_feat_int_test` + with status passed/failed/not_run **Note1:** The verification report is valid for the platform version tagged together with the report From 82b1737242221c2520e9b554bd5a6c788ca94ee3 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Tue, 24 Feb 2026 17:09:41 +0100 Subject: [PATCH 28/36] 2501 fixed indent error --- .../docs/verification/platform_verification_report.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/process/folder_templates/platform/docs/verification/platform_verification_report.rst b/process/folder_templates/platform/docs/verification/platform_verification_report.rst index 524d5a5719..cc6d5ca479 100644 --- a/process/folder_templates/platform/docs/verification/platform_verification_report.rst +++ b/process/folder_templates/platform/docs/verification/platform_verification_report.rst @@ -34,17 +34,17 @@ Platform Verification Report - This is split in a list of QM features tested and a separate list of tests for ASIL rated features. - List of feature architecture tags (ASIL rated) linked to inspection checklist and verdict (derived from PR export) - - The lists may also contain other verification methods + - The lists may also contain other verification methods **2. Safety Analyses Report** - List of the performed Platform and Feature Safety Analyses, pass/fail with open mitigations **3. Test results** - Test result per test case with status passed/failed/not_run for :need:`wp__verification_platform_int_test` and :need:`wp__verification_feat_int_test` - + **4. Test logs** - Test log per test case with status passed/failed/not_run for :need:`wp__verification_platform_int_test` and :need:`wp__verification_feat_int_test` - with status passed/failed/not_run + with status passed/failed/not_run **Note1:** The verification report is valid for the platform version tagged together with the report From f34ceda4f00cd51322d01c126e44c7626d158902 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Thu, 26 Feb 2026 09:22:45 +0100 Subject: [PATCH 29/36] fixing merging conflicts + further comments --- .../module_name/docs/release/release_note.rst | 2 +- .../platform/docs/release/release_note.rst | 152 +++++++++--------- .../platform_safety_analysis_fdr.rst | 99 ++++++------ .../safety_mgt/platform_safety_manual.rst | 11 +- 4 files changed, 135 insertions(+), 129 deletions(-) diff --git a/process/folder_templates/modules/module_name/docs/release/release_note.rst b/process/folder_templates/modules/module_name/docs/release/release_note.rst index 0f3324b5cf..215065943e 100644 --- a/process/folder_templates/modules/module_name/docs/release/release_note.rst +++ b/process/folder_templates/modules/module_name/docs/release/release_note.rst @@ -91,7 +91,7 @@ Release Note | Performed Verification | ---------------------- | This release note is based on the verification as documented in module verification report -| :need:`gd_temp__mod_ver_report`. +| :need:`doc__module_name_verification_report`. | | Known Issues | ------------ diff --git a/process/folder_templates/platform/docs/release/release_note.rst b/process/folder_templates/platform/docs/release/release_note.rst index daa1f42b8e..5729010c82 100644 --- a/process/folder_templates/platform/docs/release/release_note.rst +++ b/process/folder_templates/platform/docs/release/release_note.rst @@ -12,7 +12,7 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Platform Release Note Template +Platform Release Note ============================== .. note:: Document header @@ -25,75 +25,81 @@ Platform Release Note Template :realizes: wp__platform_sw_release_note :tags: template - | Platform Release Notes - | ====================== - | Release Tag: vX.Y.Z - | Origin Release Tag: vU.V.W - | Release Commit Hash: a1b2c3d4e5f6g7h8i9j0 - | Release Date: YYYY-MM-DD - | Safety: [QM | ASIL_B] - | Security: [NO | YES] - | - | Overview - | -------- - | This document provides an overview of the changes, improvements, and bug fixes included in the platform release version vX.Y.Z - | as compared to the platform origin release (which is usually the previous release). - | - | Disclaimer - | ---------- - | This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment. - | The work products compiled in the safety package are created with care according to a process satisfying standards, but the **<e.g. S-CORE>** project, - | being a non-profit and open source organization, can not take over any liability for its content. - | - | New Features - | ------------ - | - **Feature 1**: Brief description of the new feature. - | - **Feature 2**: Brief description of the new feature. - | - **Feature 3**: Brief description of the new feature. - | - | Improvements - | ------------ - | - **Improvement 1**: Brief description of the improvement. - | - **Improvement 2**: Brief description of the improvement. - | - **Improvement 3**: Brief description of the improvement. - | - | Bug Fixes - | --------- - | - **Bug 1**: Brief description of the bug fix. - | - **Bug 2**: Brief description of the bug fix. - | - **Bug 3**: Brief description of the bug fix. - | - | Integrated Software Modules - | --------------------------- - | - **Module 1**: Version and brief description of the module. Link to Software module release note. - | - **Module 2**: Version and brief description of the module. Link to Software module release note. - | - **Module 3**: Version and brief description of the module. Link to Software module release note. - | - | Performed Verification - | ---------------------- - | This release note is based on the verification as documented in platform verification report - | **<add link here>** (report derived from template :need:`gd_temp__platform_ver_report`). - | - | Known Issues - | ------------ - | - **Issue 1**: Brief description of the known issue. Justification regarding safety impact. - | - **Issue 2**: Brief description of the known issue. Justification regarding safety impact. - | - **Issue 3**: Brief description of the known issue. Justification regarding safety impact. - | - | Known Vulnerabilities - | --------------------- - | - **CVE 1**: Brief description of the known CVE. Justification regarding security impact. - | - **CVE 2**: Brief description of the known CVE. Justification regarding security impact. - | - **CVE 3**: Brief description of the known CVE. Justification regarding security impact. - | - | Upgrade Instructions - | -------------------- - | - | 1. **Step 1**: Description of the first step. - | 2. **Step 2**: Description of the second step. - | 3. **Step 3**: Description of the third step. - | - | Contact Information - | ------------------- - | - | For any questions or support, please contact the *Project Lead* or raise an issue/discussion. + .. attention:: + The above directive must be updated. + + - Adjust ``status`` to be ``valid`` + - Adjust ``safety`` and ``tags`` according to your needs + + Platform Release Notes + ====================== + Release Tag: vX.Y.Z + Origin Release Tag: vU.V.W + Release Commit Hash: a1b2c3d4e5f6g7h8i9j0 + Release Date: YYYY-MM-DD + Safety: [QM | ASIL_B] + Security: [NO | YES] + + Overview + -------- + This document provides an overview of the changes, improvements, and bug fixes included in the platform release version vX.Y.Z + as compared to the platform origin release (which is usually the previous release). + + Disclaimer + ---------- + This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment. + The work products compiled in the safety package are created with care according to a process satisfying standards, but the **<e.g. S-CORE>** project, + being a non-profit and open source organization, can not take over any liability for its content. + + New Features + ------------ + - **Feature 1**: Brief description of the new feature. + - **Feature 2**: Brief description of the new feature. + - **Feature 3**: Brief description of the new feature. + + Improvements + ------------ + - **Improvement 1**: Brief description of the improvement. + - **Improvement 2**: Brief description of the improvement. + - **Improvement 3**: Brief description of the improvement. + + Bug Fixes + --------- + - **Bug 1**: Brief description of the bug fix. + - **Bug 2**: Brief description of the bug fix. + - **Bug 3**: Brief description of the bug fix. + + Integrated Software Modules + --------------------------- + - **Module 1**: Version and brief description of the module. Link to Software module release note. + - **Module 2**: Version and brief description of the module. Link to Software module release note. + - **Module 3**: Version and brief description of the module. Link to Software module release note. + + Performed Verification + --------------------- + This release note is based on the verification as documented in platform verification report + **<add link here>** (report derived from template :need:`gd_temp__platform_ver_report`). + + Known Issues + ------------ + - **Issue 1**: Brief description of the known issue. Justification regarding safety impact. + - **Issue 2**: Brief description of the known issue. Justification regarding safety impact. + - **Issue 3**: Brief description of the known issue. Justification regarding safety impact. + + Known Vulnerabilities + --------------------- + - **CVE 1**: Brief description of the known CVE. Justification regarding security impact. + - **CVE 2**: Brief description of the known CVE. Justification regarding security impact. + - **CVE 3**: Brief description of the known CVE. Justification regarding security impact. + + Upgrade Instructions + -------------------- + + 1. **Step 1**: Description of the first step. + 2. **Step 2**: Description of the second step. + 3. **Step 3**: Description of the third step. + + Contact Information + ------------------- + + For any questions or support, please contact the *Project Lead* or raise an issue/discussion. diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst index df6aa34efa..574350b99f 100644 --- a/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst @@ -40,53 +40,52 @@ Please note that it is mandatory to fill in the "passed" column with "yes" or "n .. list-table:: Safety Analysis Checklist :header-rows: 1 - :widths: 10,30,30,15,8,8 - - * - Review ID - - Acceptance Criteria - - Guidance - - Passed - - Remarks - - Issue link - * - REQ_01_01 - - Is / are the attribute sufficient set correctly? - - The mitigations shall have a direct influence ont the violation by prevention, detection or mitigation to reduce the risk to an acceptable level. - - The mitigations are sufficient. - - <yes|no> - - - * - REQ_01_02 - - Are the templates for DFA and/or FMEA used? - - See :ref:`dfa_templates` / :ref:`FMEA_templates` and also :ref:`process_requirements_safety_analysis` - - Templates are used to generate the DFA or / and FMEA. - - <yes|no> - - - * - REQ_01_03 - - Were the failure initiators / fault models applied? - - See :need:`gd_guidl__dfa_failure_initiators` / :need:`gd_guidl__fault_models` - - The applicable items of the failure initiators / fault models are used to ensure a structured analysis. For all not applicable items an argument shall be given in the content of the document. - - <yes|no> - - - * - REQ_01_04 - - Are the failure effects clearly and completely described? - - Use the generic failure effect descriptions and enlarge the description if it's applicable to the considered element. - - The effects of the failure is described completely. The effect can be recognized easily. - - <yes|no> - - - * - REQ_01_06 - - Is the attribute "mitigated by" linked correct? - - Check if the correct failure effect is linked via "mitigated by". - - The "mitigated by" link is correct. - - <yes|no> - - - * - REQ_01_07 - - Is the sufficiency of the "mitigated by" (prevention, detection or mitigation) described or can it be recognized easily? - - The sufficiency of the "mitigated by" is described in the content of the document. It can be recognized easily. - - The "mitigated by" shows clearly that a fault / failure can be mitigated by the linked requirement by prevention, detection or mitigation. It shall be described in the contend. - - <yes|no> - - - * - REQ_01_08 - - Is the overall result of the Safety Analysis described in the report? - - It shall be shown in the report if the Safety Analysis are finished and if all artifacts are "valid" and "sufficient". - - The results of the Safety Analysis are described in the report. The report is available :need:`wp__verification_platform_ver_report`. - - <yes|no> - - + :widths: 10,10,30,30,20 + + * - ID + - Safety analysis activity + - Compliant to ISO 26262? + - Reference + - Comment + + * - 1 + - Is it plausible that each potential identified dependent failure that has been identified, will lead to a dependent failure which cause a violation of FFI? + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_742>` + - <Rationale for result> + + * - 2 + - Are the failure initiators :need:`[[title]] <gd_guidl__dfa_failure_initiators>` / fault models :need:`[[title]] <gd_guidl__fault_models>` applied? + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_744>` + - <Rationale for result> + + * - 3 + - Are measures defined to resolute the identified potential dependent failures? + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_746>`, :need:`[[title]] <std_req__iso26262__analysis_747>` + - <Rationale for result> + + * - 4 + - Is the result of the safety analysis indicate if the safety requirements are complied? + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_842>` + - <Rationale for result> + + * - 5 + - Are for all not complied safety requirements mitigations defined to resolute the non-compliance? The mitigations shall have a direct influence on the violation by prevention, detection or mitigation to reduce the risk to an acceptable level. + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_843>` + - <Rationale for result> + + * - 6 + - Are the mitigations effective and implemented? + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_844>` + - <Rationale for result> + + * - 7 + - Are the templates for DFA and/or FMEA used? See :ref:`dfa_templates` / :ref:`FMEA_templates` and also :ref:`process_requirements_safety_analysis` + - [YES | NO ] + - :need:`[[title]] <std_req__iso26262__analysis_748>`, :need:`[[title]] <std_req__iso26262__analysis_849>`, :need:`[[title]] <std_req__iso26262__analysis_8410>` + - <Rationale for result> diff --git a/process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst b/process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst index 95b7ce9a6e..584590cc74 100644 --- a/process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst +++ b/process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst @@ -22,7 +22,7 @@ Platform Safety Manual :status: draft :safety: ASIL_B :security: NO - :realizes: wp__module_safety_manual + :realizes: wp__platform_safety_manual :tags: template .. attention:: @@ -33,18 +33,19 @@ Platform Safety Manual Introduction/Scope ------------------ +| **<Put here explanatory text introducing origin, scope, rationale, main functionalities, overall description (with special regard on safety); e.g. link to platform architecture picture>** Assumed Platform Safety Requirements ------------------------------------ | For the Platform the following safety related stakeholder requirements are assumed to define the top level functionality (purpose) of the Platform. I.e. from these all the feature and component requirements implemented are derived. -| **<List here all the stakeholder requirements, with safety not equal to QM, the module's components requirements are derived from. For the platform all are relevant.>** +| **<List here all the stakeholder requirements, with safety not equal to QM. For the platform all are relevant.>** Assumptions of Use ------------------ Assumptions on the Environment ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -| Generally the assumption of the project platform SEooC is that it is integrated in a safe system, i.e. the POSIX OS it runs on is qualified and also the HW related failures are taken into account by the system integrator, if not otherwise stated in the module's safety concept. +| Generally the assumption of the project platform SEooC is that it is integrated in a safe system, i.e. the POSIX OS it runs on is qualified and also the HW related failures are taken into account by the system integrator, if not otherwise stated in the platform safety concept. | **<List here all the OS calls the project platform expects to be safe.>** List of AoUs expected from the environment the platform runs on: @@ -86,11 +87,11 @@ Assumptions on the User Safety concept of the SEooC --------------------------- -| **<Describe here the safety concept incl. which faults are taken care of, reactions of the implemented functions under anomalous operating conditions ... if this is not already documented sufficiently in the feature documentation "safety impact" section of all the features the module is used in.>** +| **<Describe here the safety concept incl. which faults are taken care of, reactions of the implemented functions under anomalous operating conditions>** Safety Anomalies ---------------- -| Anomalies (bugs in ASIL SW, detected by testing or by users, which could not be fixed) known before release are documented in the platform/module release notes **<add link to release note>**. +| Anomalies (bugs in ASIL SW, detected by testing or by users, which could not be fixed) known before release are documented in the platform release notes **<add link to release note>**. References ---------- From 37f3368d2f44a6e887d3877b43809d89bc644583 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Thu, 26 Feb 2026 09:27:57 +0100 Subject: [PATCH 30/36] fixed header subtitle in RN --- process/folder_templates/platform/docs/release/release_note.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/process/folder_templates/platform/docs/release/release_note.rst b/process/folder_templates/platform/docs/release/release_note.rst index 5729010c82..7cb94f7607 100644 --- a/process/folder_templates/platform/docs/release/release_note.rst +++ b/process/folder_templates/platform/docs/release/release_note.rst @@ -13,7 +13,7 @@ # ******************************************************************************* Platform Release Note -============================== +===================== .. note:: Document header From 369d7c1dfe83a7db6f8d48037b06bca3ae71d1bf Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Thu, 26 Feb 2026 09:34:15 +0100 Subject: [PATCH 31/36] fixed subtitle --- process/folder_templates/platform/docs/release/release_note.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/process/folder_templates/platform/docs/release/release_note.rst b/process/folder_templates/platform/docs/release/release_note.rst index 7cb94f7607..6668792180 100644 --- a/process/folder_templates/platform/docs/release/release_note.rst +++ b/process/folder_templates/platform/docs/release/release_note.rst @@ -76,7 +76,7 @@ Platform Release Note - **Module 3**: Version and brief description of the module. Link to Software module release note. Performed Verification - --------------------- + ---------------------- This release note is based on the verification as documented in platform verification report **<add link here>** (report derived from template :need:`gd_temp__platform_ver_report`). From b0185c0fdab6b258363fa44b3ee281b8a42c276e Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Thu, 26 Feb 2026 09:44:55 +0100 Subject: [PATCH 32/36] fixed duplicate header --- .../folder_templates/platform/docs/release/release_note.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/process/folder_templates/platform/docs/release/release_note.rst b/process/folder_templates/platform/docs/release/release_note.rst index 6668792180..f619899057 100644 --- a/process/folder_templates/platform/docs/release/release_note.rst +++ b/process/folder_templates/platform/docs/release/release_note.rst @@ -31,8 +31,8 @@ Platform Release Note - Adjust ``status`` to be ``valid`` - Adjust ``safety`` and ``tags`` according to your needs - Platform Release Notes - ====================== + + Release Tag: vX.Y.Z Origin Release Tag: vU.V.W Release Commit Hash: a1b2c3d4e5f6g7h8i9j0 From 78710581de335cc53b6b13e96644a00a66b2dfe8 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Thu, 26 Feb 2026 09:51:34 +0100 Subject: [PATCH 33/36] fixing indentation --- .../platform/docs/release/release_note.rst | 141 +++++++++--------- 1 file changed, 70 insertions(+), 71 deletions(-) diff --git a/process/folder_templates/platform/docs/release/release_note.rst b/process/folder_templates/platform/docs/release/release_note.rst index f619899057..fe2462811d 100644 --- a/process/folder_templates/platform/docs/release/release_note.rst +++ b/process/folder_templates/platform/docs/release/release_note.rst @@ -32,74 +32,73 @@ Platform Release Note - Adjust ``safety`` and ``tags`` according to your needs - - Release Tag: vX.Y.Z - Origin Release Tag: vU.V.W - Release Commit Hash: a1b2c3d4e5f6g7h8i9j0 - Release Date: YYYY-MM-DD - Safety: [QM | ASIL_B] - Security: [NO | YES] - - Overview - -------- - This document provides an overview of the changes, improvements, and bug fixes included in the platform release version vX.Y.Z - as compared to the platform origin release (which is usually the previous release). - - Disclaimer - ---------- - This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment. - The work products compiled in the safety package are created with care according to a process satisfying standards, but the **<e.g. S-CORE>** project, - being a non-profit and open source organization, can not take over any liability for its content. - - New Features - ------------ - - **Feature 1**: Brief description of the new feature. - - **Feature 2**: Brief description of the new feature. - - **Feature 3**: Brief description of the new feature. - - Improvements - ------------ - - **Improvement 1**: Brief description of the improvement. - - **Improvement 2**: Brief description of the improvement. - - **Improvement 3**: Brief description of the improvement. - - Bug Fixes - --------- - - **Bug 1**: Brief description of the bug fix. - - **Bug 2**: Brief description of the bug fix. - - **Bug 3**: Brief description of the bug fix. - - Integrated Software Modules - --------------------------- - - **Module 1**: Version and brief description of the module. Link to Software module release note. - - **Module 2**: Version and brief description of the module. Link to Software module release note. - - **Module 3**: Version and brief description of the module. Link to Software module release note. - - Performed Verification - ---------------------- - This release note is based on the verification as documented in platform verification report - **<add link here>** (report derived from template :need:`gd_temp__platform_ver_report`). - - Known Issues - ------------ - - **Issue 1**: Brief description of the known issue. Justification regarding safety impact. - - **Issue 2**: Brief description of the known issue. Justification regarding safety impact. - - **Issue 3**: Brief description of the known issue. Justification regarding safety impact. - - Known Vulnerabilities - --------------------- - - **CVE 1**: Brief description of the known CVE. Justification regarding security impact. - - **CVE 2**: Brief description of the known CVE. Justification regarding security impact. - - **CVE 3**: Brief description of the known CVE. Justification regarding security impact. - - Upgrade Instructions - -------------------- - - 1. **Step 1**: Description of the first step. - 2. **Step 2**: Description of the second step. - 3. **Step 3**: Description of the third step. - - Contact Information - ------------------- - - For any questions or support, please contact the *Project Lead* or raise an issue/discussion. + Release Tag: vX.Y.Z + Origin Release Tag: vU.V.W + Release Commit Hash: a1b2c3d4e5f6g7h8i9j0 + Release Date: YYYY-MM-DD + Safety: [QM | ASIL_B] + Security: [NO | YES] + + Overview + -------- + This document provides an overview of the changes, improvements, and bug fixes included in the platform release version vX.Y.Z + as compared to the platform origin release (which is usually the previous release). + + Disclaimer + ---------- + This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment. + The work products compiled in the safety package are created with care according to a process satisfying standards, but the **<e.g. S-CORE>** project, + being a non-profit and open source organization, can not take over any liability for its content. + + New Features + ------------ + - **Feature 1**: Brief description of the new feature. + - **Feature 2**: Brief description of the new feature. + - **Feature 3**: Brief description of the new feature. + + Improvements + ------------ + - **Improvement 1**: Brief description of the improvement. + - **Improvement 2**: Brief description of the improvement. + - **Improvement 3**: Brief description of the improvement. + + Bug Fixes + --------- + - **Bug 1**: Brief description of the bug fix. + - **Bug 2**: Brief description of the bug fix. + - **Bug 3**: Brief description of the bug fix. + + Integrated Software Modules + --------------------------- + - **Module 1**: Version and brief description of the module. Link to Software module release note. + - **Module 2**: Version and brief description of the module. Link to Software module release note. + - **Module 3**: Version and brief description of the module. Link to Software module release note. + + Performed Verification + ---------------------- + This release note is based on the verification as documented in platform verification report + **<add link here>** (report derived from template :need:`gd_temp__platform_ver_report`). + + Known Issues + ------------ + - **Issue 1**: Brief description of the known issue. Justification regarding safety impact. + - **Issue 2**: Brief description of the known issue. Justification regarding safety impact. + - **Issue 3**: Brief description of the known issue. Justification regarding safety impact. + + Known Vulnerabilities + --------------------- + - **CVE 1**: Brief description of the known CVE. Justification regarding security impact. + - **CVE 2**: Brief description of the known CVE. Justification regarding security impact. + - **CVE 3**: Brief description of the known CVE. Justification regarding security impact. + + Upgrade Instructions + -------------------- + + 1. **Step 1**: Description of the first step. + 2. **Step 2**: Description of the second step. + 3. **Step 3**: Description of the third step. + + Contact Information + ------------------- + + For any questions or support, please contact the *Project Lead* or raise an issue/discussion. From 42cc947faa84b64f8bce05383795fa153ccd5a50 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Thu, 26 Feb 2026 09:55:25 +0100 Subject: [PATCH 34/36] fixing indentation --- .../modules/module_name/docs/release/release_note.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/process/folder_templates/modules/module_name/docs/release/release_note.rst b/process/folder_templates/modules/module_name/docs/release/release_note.rst index 215065943e..728108b2d0 100644 --- a/process/folder_templates/modules/module_name/docs/release/release_note.rst +++ b/process/folder_templates/modules/module_name/docs/release/release_note.rst @@ -122,9 +122,6 @@ Release Note | Contributor 1 | Contributor 2 | - ---- - | Contact Information | ------------------- | From a10598f850bd9a587761addbd787161437ba9cbb Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Thu, 26 Feb 2026 10:03:25 +0100 Subject: [PATCH 35/36] trying to fix indent issues --- .../platform/docs/release/release_note.rst | 169 ++++++++++-------- 1 file changed, 93 insertions(+), 76 deletions(-) diff --git a/process/folder_templates/platform/docs/release/release_note.rst b/process/folder_templates/platform/docs/release/release_note.rst index fe2462811d..6e6d134d35 100644 --- a/process/folder_templates/platform/docs/release/release_note.rst +++ b/process/folder_templates/platform/docs/release/release_note.rst @@ -26,79 +26,96 @@ Platform Release Note :tags: template .. attention:: - The above directive must be updated. - - - Adjust ``status`` to be ``valid`` - - Adjust ``safety`` and ``tags`` according to your needs - - - Release Tag: vX.Y.Z - Origin Release Tag: vU.V.W - Release Commit Hash: a1b2c3d4e5f6g7h8i9j0 - Release Date: YYYY-MM-DD - Safety: [QM | ASIL_B] - Security: [NO | YES] - - Overview - -------- - This document provides an overview of the changes, improvements, and bug fixes included in the platform release version vX.Y.Z - as compared to the platform origin release (which is usually the previous release). - - Disclaimer - ---------- - This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment. - The work products compiled in the safety package are created with care according to a process satisfying standards, but the **<e.g. S-CORE>** project, - being a non-profit and open source organization, can not take over any liability for its content. - - New Features - ------------ - - **Feature 1**: Brief description of the new feature. - - **Feature 2**: Brief description of the new feature. - - **Feature 3**: Brief description of the new feature. - - Improvements - ------------ - - **Improvement 1**: Brief description of the improvement. - - **Improvement 2**: Brief description of the improvement. - - **Improvement 3**: Brief description of the improvement. - - Bug Fixes - --------- - - **Bug 1**: Brief description of the bug fix. - - **Bug 2**: Brief description of the bug fix. - - **Bug 3**: Brief description of the bug fix. - - Integrated Software Modules - --------------------------- - - **Module 1**: Version and brief description of the module. Link to Software module release note. - - **Module 2**: Version and brief description of the module. Link to Software module release note. - - **Module 3**: Version and brief description of the module. Link to Software module release note. - - Performed Verification - ---------------------- - This release note is based on the verification as documented in platform verification report - **<add link here>** (report derived from template :need:`gd_temp__platform_ver_report`). - - Known Issues - ------------ - - **Issue 1**: Brief description of the known issue. Justification regarding safety impact. - - **Issue 2**: Brief description of the known issue. Justification regarding safety impact. - - **Issue 3**: Brief description of the known issue. Justification regarding safety impact. - - Known Vulnerabilities - --------------------- - - **CVE 1**: Brief description of the known CVE. Justification regarding security impact. - - **CVE 2**: Brief description of the known CVE. Justification regarding security impact. - - **CVE 3**: Brief description of the known CVE. Justification regarding security impact. - - Upgrade Instructions - -------------------- - - 1. **Step 1**: Description of the first step. - 2. **Step 2**: Description of the second step. - 3. **Step 3**: Description of the third step. - - Contact Information - ------------------- - - For any questions or support, please contact the *Project Lead* or raise an issue/discussion. + The above directive must be updated. + + - Adjust ``status`` to be ``valid`` + - Adjust ``safety`` and ``tags`` according to your needs + + + +| Release Tag: vX.Y.Z +| Origin Release Tag: vU.V.W +| Release Commit Hash: a1b2c3d4e5f6g7h8i9j0 +| Release Date: YYYY-MM-DD +| Safety: [QM | ASIL_B] +| Security: [NO | YES] +| +| Overview +| -------- +| +| This document provides an overview of the changes, improvements, and bug fixes included in the software platform release version vX.Y.Z +| as compared to the platform's origin release (which is usually the previous release). +| +| Disclaimer +| ---------- +| This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment. +| The work products compiled in the safety package are created with care according to a process satisfying standards, but the as the project, +| being a non-profit and open source organization, can not take over any liability for its content. +| +| New Features +| ------------ +| +| - **Feature 1**: Brief description of the new feature. +| - **Feature 2**: Brief description of the new feature. +| - **Feature 3**: Brief description of the new feature. +| +| Improvements +| ------------ +| +| - **Improvement 1**: Brief description of the improvement. +| - **Improvement 2**: Brief description of the improvement. +| - **Improvement 3**: Brief description of the improvement. +| +| Bug Fixes +| --------- +| +| - **Bug 1**: Brief description of the bug fix. +| - **Bug 2**: Brief description of the bug fix. +| - **Bug 3**: Brief description of the bug fix. +| +| Other changes by Label +| ---------------------- +| +| - **Label 1/Refactor 1**: Brief description of the change. +| - **Label 2/Refactor 2**: Brief description of the change. +| - **Label 3/Refactor 3**: Brief description of the change. +| +| Compatibility +| ------------- +| +| - **Dependencies**: List any dependencies and their versions. +| +| Performed Verification +| ---------------------- +| This release note is based on the verification as documented in platform verification report +| :need:`doc__platform_verification_report`. +| +| Known Issues +| ------------ +| +| - **Issue 1**: Brief description of the known issue. Justification regarding safety impact. +| - **Issue 2**: Brief description of the known issue. Justification regarding safety impact. +| - **Issue 3**: Brief description of the known issue. Justification regarding safety impact. +| +| Known Vulnerabilities +| --------------------- +| +| - **CVE 1**: Brief description of the known CVE. Justification regarding security impact. +| - **CVE 2**: Brief description of the known CVE. Justification regarding security impact. +| - **CVE 3**: Brief description of the known CVE. Justification regarding security impact. +| +| Upgrade Instructions +| -------------------- +| +| 1. **Step 1**: Description of the first step. +| 2. **Step 2**: Description of the second step. +| 3. **Step 3**: Description of the third step. +| +| Contributors +| ------------ +| +| Thanks to everyone who contributed to this release: +| +| Contributor 1 +| Contributor 2 +| From e1fd4a02451f263d9994f705662842386368deb3 Mon Sep 17 00:00:00 2001 From: Attilio Stefano Funel <attiliostefano.funel@etas.com> Date: Thu, 26 Feb 2026 10:13:49 +0100 Subject: [PATCH 36/36] restored 6. and 7. of module verification report --- .../docs/verification/module_verification_report.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst b/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst index bf112f5c7e..5d28ec3831 100644 --- a/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst +++ b/process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst @@ -85,6 +85,12 @@ Verification Report contains: **5. Software component qualification verification report** - Contains the needed verification results if for some components a qualification of pre-developed SW is performed. +**6. Test results** + - Test result per test case with status passed/failed/not_run + +**7. Test logs** + - Test log per test case with status passed/failed/not_run + **Note1:** The verification report is valid for the module version tagged together with the report **Note2:** All the above lists are generated automatically