From 842df64178dcb5c0c63a45d01ad73b35b57bd418 Mon Sep 17 00:00:00 2001 From: "jhr2hi@bosch.com" Date: Tue, 15 Sep 2026 15:42:03 +0200 Subject: [PATCH] improvement of module verification report --- .../module_verification_report.rst | 32 +++++++------------ 1 file changed, 12 insertions(+), 20 deletions(-) diff --git a/docs/verification_report/module_verification_report.rst b/docs/verification_report/module_verification_report.rst index 8bcfea1d..89ce1954 100644 --- a/docs/verification_report/module_verification_report.rst +++ b/docs/verification_report/module_verification_report.rst @@ -15,8 +15,6 @@ Verification Report =================== -.. note:: Document header - .. document:: [Module Name] Verification Report :id: doc__mod_temp_verification_report :status: draft @@ -26,8 +24,18 @@ Verification Report :realizes: wp__verification_module_ver_report :tags: template + Verification report for the [Module Name] module. This report is generated based on the module verification plan and the module verification work product (:need:`wp__verification_module_ver_report`), and covers all components of the module. + .. attention:: - In a module the above directive must be replaced by the following directive. + + The verification report is automatically generated by a tool based on the code block above (see `module_verification_report.need `_). It contains all information required for module verification, is based on the module verification plan and the module verification work product (:need:`wp__verification_module_ver_report`), and covers all components of the module. + + When this template is used in a module, replace the placeholder directive above with a module-specific directive. The following example shows the required structure; adapt its values to your module as described below. + + - Modify ``module pretty name`` to be your Module Name + - Modify ``module formal name`` to be your Module Name in lower case + - Adjust ``status`` to be ``valid`` + - Adjust ``safety`` and ``tags`` according to your needs .. code-block:: rst @@ -40,28 +48,12 @@ Verification Report :realizes: wp__verification_module_ver_report :version: 1 -.. attention:: - - The above directive must be updated according to your Module. - - - Modify ``module pretty name`` to be your Module Name - - Modify ``module formal name`` to be your Module Name in lower case - - Adjust ``status`` to be ``valid`` - - Adjust ``safety`` and ``tags`` according to your needs - .. note:: - The verification report is generated automatically by the codeblock above by the tools and contains all the needed information for the module verification. The report is based on the module verification plan and workproduct module verification product (:need:`wp__verification_module_ver_report`) and covers all the components of the module. - - The generated report should contain the following parts which bases : + An possible example for a generated verification report is shown below and might contain the following parts, which are described in the following sections and is based on the :need:`gd_temp__verification_plan`. This description can be deleted in a real module, but is kept here in the module template for documentation purposes. .. code-block:: rst - This verification report is based on the :need:`gd_temp__verification_plan`. - It covers all the components of the above stated module. - - Verification Report contains: - **1. Verification Coverage** **1.1. on Requirements**