From 5ead87486cde424ec9f6a1cbf5ec45890492ba10 Mon Sep 17 00:00:00 2001 From: vaishnavi yendole Date: Mon, 26 Oct 2026 11:29:27 +0530 Subject: [PATCH] docs: add Unit Test work product for mw::log backend Adds a formal document:: page realizing wp__verification_sw_unit_test for the log_backend component, linking the existing gTest unit test suites under score/mw/log/ to the work product. Replaces the placeholder '' entry in the module safety plan with a reference to the new doc. Fixes #231 --- .../mw_log/detailed_design/index.rst | 10 +++++++ .../mw_log/detailed_design/unit_test.rst | 26 +++++++++++++++++++ docs/module/safety_mgt/module_safety_plan.rst | 2 +- 3 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 docs/components/mw_log/detailed_design/unit_test.rst diff --git a/docs/components/mw_log/detailed_design/index.rst b/docs/components/mw_log/detailed_design/index.rst index c64d3a76..abf91614 100644 --- a/docs/components/mw_log/detailed_design/index.rst +++ b/docs/components/mw_log/detailed_design/index.rst @@ -188,6 +188,16 @@ the diagrams. The interface documentation is part of the headers. datarouter_backend/index +Unit Test +--------- + +The unit test documentation for the ``mw::log`` backend can be found here: + +.. toctree:: + + unit_test + + Inspection Checklist ==================== diff --git a/docs/components/mw_log/detailed_design/unit_test.rst b/docs/components/mw_log/detailed_design/unit_test.rst new file mode 100644 index 00000000..b568a52f --- /dev/null +++ b/docs/components/mw_log/detailed_design/unit_test.rst @@ -0,0 +1,26 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Unit Test +######### + +.. document:: mw::log Backend Unit Test + :id: doc__mw_log_backend_unit_test + :status: draft + :version: 1 + :safety: ASIL_B + :security: YES + :realizes: wp__verification_sw_unit_test + +`score/mw/log `_ diff --git a/docs/module/safety_mgt/module_safety_plan.rst b/docs/module/safety_mgt/module_safety_plan.rst index 28cc0c51..6a4c931b 100644 --- a/docs/module/safety_mgt/module_safety_plan.rst +++ b/docs/module/safety_mgt/module_safety_plan.rst @@ -173,7 +173,7 @@ Component Logging Backend Work products List * - :need:`wp__verification_sw_unit_test` - :need:`gd_guidl__verification_guide` - :ndf:`copy('status', need_id='gd_guidl__verification_guide')` - - + - :need:`doc__mw_log_backend_unit_test` * - :need:`wp__sw_implementation_inspection` - :need:`gd_chklst__impl_inspection_checklist`