diff --git a/MODULE.bazel b/MODULE.bazel index 339213741..e6ededc57 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -31,12 +31,12 @@ bazel_dep(name = "google_benchmark", version = "1.9.5", dev_dependency = True) # S-CORE process rules bazel_dep(name = "score_bazel_platforms", version = "0.1.2", dev_dependency = True) -bazel_dep(name = "score_docs_as_code", version = "4.6.1", dev_dependency = True) +bazel_dep(name = "score_docs_as_code", version = "6.0.0", dev_dependency = True) bazel_dep(name = "score_tooling", version = "1.3.1", dev_dependency = True) bazel_dep(name = "score_rust_policies", version = "0.0.5", dev_dependency = True) bazel_dep(name = "score_cpp_policies", version = "0.0.1", dev_dependency = True) bazel_dep(name = "score_process", version = "2.0.2", dev_dependency = True) -bazel_dep(name = "score_platform", version = "0.6.2", dev_dependency = True) +bazel_dep(name = "score_platform", version = "0.6.3", dev_dependency = True) ## Configure the C++ toolchain bazel_dep(name = "score_bazel_cpp_toolchains", version = "0.5.4", dev_dependency = True) diff --git a/MODULE.bazel.lock b/MODULE.bazel.lock index 7eb61df3c..2b1c83d7a 100644 --- a/MODULE.bazel.lock +++ b/MODULE.bazel.lock @@ -495,6 +495,8 @@ "https://bcr.bazel.build/modules/rules_swift/1.18.0/MODULE.bazel": "a6aba73625d0dc64c7b4a1e831549b6e375fbddb9d2dde9d80c9de6ec45b24c9", "https://bcr.bazel.build/modules/rules_swift/2.1.1/MODULE.bazel": "494900a80f944fc7aa61500c2073d9729dff0b764f0e89b824eb746959bc1046", "https://bcr.bazel.build/modules/rules_swift/2.1.1/source.json": "40fc69dfaac64deddbb75bd99cdac55f4427d9ca0afbe408576a65428427a186", + "https://bcr.bazel.build/modules/sphinxdocs/2.2.0/MODULE.bazel": "e046c573919d72605d62c352a08d9223a10aafef3a7cb70d0fe253ebdd97019e", + "https://bcr.bazel.build/modules/sphinxdocs/2.2.0/source.json": "b1da19a3d14a1dd8aa6a9ccaedc42bbe0313c8160a77ba5cca336cca1315298d", "https://bcr.bazel.build/modules/stardoc/0.5.0/MODULE.bazel": "f9f1f46ba8d9c3362648eea571c6f9100680efc44913618811b58cc9c02cd678", "https://bcr.bazel.build/modules/stardoc/0.5.1/MODULE.bazel": "1a05d92974d0c122f5ccf09291442580317cdd859f07a8655f1db9a60374f9f8", "https://bcr.bazel.build/modules/stardoc/0.5.3/MODULE.bazel": "c7f6948dae6999bf0db32c1858ae345f112cacf98f174c7a8bb707e41b974f1c", @@ -952,7 +954,8 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_dash_license_checker/0.1.1/MODULE.bazel": "76681dbd2d45b5c540869a2337174086c56c54953aab1d02cd878b59d31d13a5", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.7.0/MODULE.bazel": "f9a5971fbd05f0ed14e7a373dbf58af72a5c58d081537a75c314daaf61c92ae9", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.8.0/MODULE.bazel": "89f855b94d041d2e61ff9667562fb4539c146249f6fb4c5dddf3d13bb9064aa7", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.8.0/source.json": "ef316fad71fdbd53daf43fc0a82fbc7c293908a2712214ff79134c177d028024", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.9.0/MODULE.bazel": "2a04a354eb7a77d478bb43ba20b1dac0758af858172a760e4290621bef1a2f28", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_devcontainer/1.9.0/source.json": "6f72c780f1fb167be7cbc01801b86534a9e7102003168dcdf2c8886cfb1bb209", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/0.2.4/MODULE.bazel": "ea4801e96c87e2b8650a0fa9e5fed9b8bdbef05c1bc3e30003ba527d5af60a43", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/0.2.6/MODULE.bazel": "1af2963e91c6472555e222f0aba3dc2f5492d04598298209a361978ee3e321e3", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/0.3.3/MODULE.bazel": "95d2b7d44d461c1cf9bd016605f740716fd4ea1303f5f2ed93de3566b90feb1b", @@ -966,14 +969,15 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.5.0/MODULE.bazel": "4cfe52fe8b8dbeaf7e87500036391da278f72f1c2b41b689ffdd4337196dd8fe", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.6.0/MODULE.bazel": "d5fbfed7b9bd65f10830e2290045dea639a8cfcaf9f9f0f7a1b12888c14e7d2b", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.6.1/MODULE.bazel": "0dae734ea8a99970a7417829b3115af02717b29f0fc40a8ebd3c1afcc71e1e21", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/4.6.1/source.json": "3299daf219b15ba4aff6ca801385abebe0aaf364f71e391cd76cf9d38f3741f6", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/6.0.0/MODULE.bazel": "ab2af2d8fab73e4512d2e2bd399a64d10c5c5463388322f7025637b13ec7585c", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_docs_as_code/6.0.0/source.json": "c3992257800c4e3408be5e4656c0903fc19d3933011cc58e85d9a29c7214f374", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_format_checker/0.1.1/MODULE.bazel": "1acc254faa90e9f97b79ac69af25b6c21c561f8d6079914f6352b9b20d26bd37", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_itf/0.5.0/MODULE.bazel": "d3ae40173462419b4e14e3fea96a49eab8822be7292f94890beb8cc73173eaa1", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_itf/0.5.0/source.json": "3c0fcd761e221bc33e6ebbeb0f92ce71b5d6f1f946b60ccf4fe7cf3a4c00d211", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.1.0/MODULE.bazel": "cc9eae86e76f2a930510ed6e50ec991bb5661687e24881685b39c322087adf6f", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.1.1/MODULE.bazel": "eb086ba99f9319371fbbd0a9252dfd27b0817039b88bd4d691602974b1ada005", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.6.2/MODULE.bazel": "e88e7d086a08e1b451a68b60038b8b1f3c028aae7efc0bc9d8b39b6261ba040d", - "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.6.2/source.json": "87edd5be1382fec29c3276a7df3034d918f1d047e4814981d2ca725906460629", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.6.3/MODULE.bazel": "2fdb3cca15348f127fc356b27f84bd58d841530a94c58aedeefe09c47d8bfe8a", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_platform/0.6.3/source.json": "9594a1e59507baeccb71e6b2faace9677d4d5db2cc76b142f8577ccd1ff3f282", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.0.4/MODULE.bazel": "f74302cb90a7c4878db302276afae82966878099861dcfca3ef43256131dab52", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.0.5/MODULE.bazel": "ed17c232ebd65e9d50fd5c1832f90f95ffe95b2a1113d63a176295a2af64d111", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_process/1.1.0/MODULE.bazel": "97dd927309f87ecb73629725683028a5dbb37a49b1159c771292e6993569055b", @@ -1004,6 +1008,7 @@ "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_tooling/1.1.2/MODULE.bazel": "56d08309931cfad67c2b6691207bb5f761a3946830d620c630d2436630e6b499", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_tooling/1.3.1/MODULE.bazel": "4ce18de0fdfb447ba750b98febb24e12471862cbbd5d08f5f683f27886767367", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/score_tooling/1.3.1/source.json": "94e50fa631dffe1eea1a900ed0e472c479f90962faf8f2b6bc6142c506f4ff98", + "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/sphinxdocs/2.2.0/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/stardoc/0.5.0/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/stardoc/0.5.1/MODULE.bazel": "not found", "https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/modules/stardoc/0.5.3/MODULE.bazel": "not found", diff --git a/docs/features/lifecycle/architecture/chklst_arc_inspection.rst b/docs/features/lifecycle/architecture/chklst_arc_inspection.rst index 790dd1613..a25dd69b8 100644 --- a/docs/features/lifecycle/architecture/chklst_arc_inspection.rst +++ b/docs/features/lifecycle/architecture/chklst_arc_inspection.rst @@ -16,9 +16,10 @@ .. document:: Lifecycle Architecture Inspection Checklist :id: doc__lifecycle_arc_inspection :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__sw_arch_verification + :realizes: wp__sw_arch_verification[version==1] Architecture Inspection Checklist ================================= diff --git a/docs/features/lifecycle/architecture/index.rst b/docs/features/lifecycle/architecture/index.rst index 55cc80792..0b2a0c693 100644 --- a/docs/features/lifecycle/architecture/index.rst +++ b/docs/features/lifecycle/architecture/index.rst @@ -16,11 +16,12 @@ Feature Architecture ==================== .. document:: Lifecycle Architecture - :id: doc__lifecycle_architecture + :id: doc__lifecycle_architecture_feature :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__feature_arch + :realizes: wp__feature_arch[version==1] Overview -------- diff --git a/docs/features/lifecycle/safety_analysis/aou_requirements.rst b/docs/features/lifecycle/safety_analysis/aou_requirements.rst index 6a6a53dad..6265eebfa 100644 --- a/docs/features/lifecycle/safety_analysis/aou_requirements.rst +++ b/docs/features/lifecycle/safety_analysis/aou_requirements.rst @@ -18,9 +18,10 @@ AoU Feature Requirements .. document:: Lifecycle Feature AoU :id: doc__lifecycle_feat_aou :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__requirements_feat_aou + :realizes: wp__requirements_feat_aou[version==1] Feature AoU ----------- @@ -33,5 +34,6 @@ Feature AoU :security: NO :safety: ASIL_B :status: invalid + :version: 1 The Feature User shall do xyz to use the feature safely. diff --git a/docs/features/lifecycle/safety_analysis/dfa.rst b/docs/features/lifecycle/safety_analysis/dfa.rst index eeacb7e6b..e43efc623 100644 --- a/docs/features/lifecycle/safety_analysis/dfa.rst +++ b/docs/features/lifecycle/safety_analysis/dfa.rst @@ -19,9 +19,10 @@ DFA (Dependent Failure Analysis) .. document:: Lifecycle DFA :id: doc__lifecycle_dfa :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__feature_dfa + :realizes: wp__feature_dfa[version==1] .. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram. @@ -189,6 +190,7 @@ For all identified applicable failure initiators, the DFA is performed in the fo :mitigation_issue: :sufficient: :status: + :version: 1 .. note:: Argument is inside the 'content'. Therefore content is mandatory. diff --git a/docs/features/lifecycle/safety_analysis/fmea.rst b/docs/features/lifecycle/safety_analysis/fmea.rst index e40ebc35d..93071bf55 100644 --- a/docs/features/lifecycle/safety_analysis/fmea.rst +++ b/docs/features/lifecycle/safety_analysis/fmea.rst @@ -19,9 +19,10 @@ FMEA (Failure Modes and Effects Analysis) .. document:: Lifecycle FMEA :id: doc__lifecycle_fmea :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__feature_fmea + :realizes: wp__feature_fmea[version==1] .. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram. @@ -117,6 +118,7 @@ For all identified applicable failure initiators, the FMEA is performed in the f :mitigation_issue: :sufficient: :status: + :version: 1 .. note:: Argument is inside the 'content'. Therefore content is mandatory. diff --git a/docs/features/lifecycle/safety_planning/index.rst b/docs/features/lifecycle/safety_planning/index.rst index fb4e44dfe..e7da0a832 100644 --- a/docs/features/lifecycle/safety_planning/index.rst +++ b/docs/features/lifecycle/safety_planning/index.rst @@ -18,9 +18,10 @@ Feature Safety Work Products List .. document:: Lifecycle Safety WPs :id: doc__lifecycle_safety_wp :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__platform_safety_plan + :realizes: wp__platform_safety_plan[version==1] Tailoring ========= diff --git a/docs/features/lifecycle/security_planning/index.rst b/docs/features/lifecycle/security_planning/index.rst index b0bd1d004..6df898577 100644 --- a/docs/features/lifecycle/security_planning/index.rst +++ b/docs/features/lifecycle/security_planning/index.rst @@ -18,9 +18,10 @@ Feature Security Work Products List .. document:: Lifecycle Security WPs :id: doc__lifecycle_security_planning_wp :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__platform_security_plan + :realizes: wp__platform_security_plan[version==1] Tailoring ========= diff --git a/docs/manuals/safety_manual.rst b/docs/manuals/safety_manual.rst index df8c81826..e6e1ff53d 100644 --- a/docs/manuals/safety_manual.rst +++ b/docs/manuals/safety_manual.rst @@ -18,9 +18,10 @@ Safety Manual .. document:: Lifecycle Safety Manual :id: doc__lifecycle_safety_manual :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__module_safety_manual + :realizes: wp__module_safety_manual[version==1] Introduction/Scope ------------------ diff --git a/docs/manuals/security_manual.rst b/docs/manuals/security_manual.rst index 8ae5bf379..ccf5fa76a 100644 --- a/docs/manuals/security_manual.rst +++ b/docs/manuals/security_manual.rst @@ -18,9 +18,10 @@ Security Manual .. document:: Lifecycle Security Manual :id: doc__lifecycle_security_manual :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__module_security_manual + :realizes: wp__module_security_manual[version==1] Introduction/Scope diff --git a/docs/manuals/user_manual.rst b/docs/manuals/user_manual.rst index 4239eddba..2ff9467f1 100644 --- a/docs/manuals/user_manual.rst +++ b/docs/manuals/user_manual.rst @@ -23,7 +23,7 @@ User Manual :version: 1 :safety: QM :security: NO - :realizes: wp__training_path + :realizes: wp__training_path[version==1] Overview diff --git a/docs/release/release_note_v_0_2_0.rst b/docs/release/release_note_v_0_2_0.rst index ccd4197da..4f95d0ae3 100644 --- a/docs/release/release_note_v_0_2_0.rst +++ b/docs/release/release_note_v_0_2_0.rst @@ -15,9 +15,10 @@ .. document:: lifecycle Release Note v0.2.0 :id: doc__lifecycle_release_note_v0_2_0 :status: valid + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__module_sw_release_note + :realizes: wp__module_sw_release_note[version==1] :tags: diff --git a/docs/release/release_note_v_0_3_0.rst b/docs/release/release_note_v_0_3_0.rst index d33a7431f..c31182d7b 100644 --- a/docs/release/release_note_v_0_3_0.rst +++ b/docs/release/release_note_v_0_3_0.rst @@ -15,9 +15,10 @@ .. document:: lifecycle Release Note v0.3.0 :id: doc__lifecycle_release_note_v0_3_0 :status: valid + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__module_sw_release_note + :realizes: wp__module_sw_release_note[version==1] :tags: diff --git a/docs/safety_mgt/module_safety_analysis_fdr.rst b/docs/safety_mgt/module_safety_analysis_fdr.rst index bb94baa05..a05f64bcb 100644 --- a/docs/safety_mgt/module_safety_analysis_fdr.rst +++ b/docs/safety_mgt/module_safety_analysis_fdr.rst @@ -19,9 +19,10 @@ Safety Analysis Checklist .. document:: Lifecycle Safety Analysis Checklist :id: doc__lifecycle_safety_analysis_fdr :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__fdr_reports + :realizes: wp__fdr_reports[version==1] **Purpose** diff --git a/docs/safety_mgt/module_safety_package_fdr.rst b/docs/safety_mgt/module_safety_package_fdr.rst index c56023cb3..d98577efa 100644 --- a/docs/safety_mgt/module_safety_package_fdr.rst +++ b/docs/safety_mgt/module_safety_package_fdr.rst @@ -18,9 +18,10 @@ Safety Package Formal Review Report .. document:: Lifecycle Safety Package Formal Review :id: doc__lifecycle_safety_package_fdr :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__fdr_reports + :realizes: wp__fdr_reports[version==1] **Purpose** diff --git a/docs/safety_mgt/module_safety_plan.rst b/docs/safety_mgt/module_safety_plan.rst index 686865c6f..39a4a2733 100644 --- a/docs/safety_mgt/module_safety_plan.rst +++ b/docs/safety_mgt/module_safety_plan.rst @@ -18,9 +18,10 @@ Safety Plan .. document:: Lifecycle Safety Plan :id: doc__lifecycle_safety_plan :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__module_safety_plan + :realizes: wp__module_safety_plan[version==1] :note: The module safety plan shall be continuously maintained during the project. Deviations to the module safety plan should be documented :ref:`here ` diff --git a/docs/safety_mgt/module_safety_plan_fdr.rst b/docs/safety_mgt/module_safety_plan_fdr.rst index ebecc0e55..8056cc2b2 100644 --- a/docs/safety_mgt/module_safety_plan_fdr.rst +++ b/docs/safety_mgt/module_safety_plan_fdr.rst @@ -18,9 +18,10 @@ Safety Plan Formal Review Report .. document:: Lifecycle Safety Plan Formal Review :id: doc__lifecycle_safety_plan_fdr :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__fdr_reports + :realizes: wp__fdr_reports[version==1] **Purpose** diff --git a/docs/security_mgt/module_security_package_fdr.rst b/docs/security_mgt/module_security_package_fdr.rst index 2b1e8a355..78dfc4a6b 100644 --- a/docs/security_mgt/module_security_package_fdr.rst +++ b/docs/security_mgt/module_security_package_fdr.rst @@ -18,9 +18,10 @@ Security Package Formal Review Report .. document:: Lifcycle Security Package Formal Review :id: doc__lifecycle_sec_pkg_fdr :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__fdr_reports + :realizes: wp__fdr_reports[version==1] **1. Purpose** diff --git a/docs/security_mgt/module_security_plan.rst b/docs/security_mgt/module_security_plan.rst index 579a6d8ac..3ee75f00b 100644 --- a/docs/security_mgt/module_security_plan.rst +++ b/docs/security_mgt/module_security_plan.rst @@ -20,9 +20,10 @@ Security Plan .. document:: Lifecycle Security Plan :id: doc__lifecycle_security_plan :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__module_security_plan + :realizes: wp__module_security_plan[version==1] | **1. Security Management Context** diff --git a/docs/security_mgt/module_security_plan_fdr.rst b/docs/security_mgt/module_security_plan_fdr.rst index a98042837..4f657e5a9 100644 --- a/docs/security_mgt/module_security_plan_fdr.rst +++ b/docs/security_mgt/module_security_plan_fdr.rst @@ -18,9 +18,10 @@ Security Plan Formal Review Report .. document:: Lifecycle Security Plan Formal Review :id: doc__lifecycle_security_plan_fdr :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__fdr_reports + :realizes: wp__fdr_reports[version==1] **1. Purpose** diff --git a/score/health_monitor/docs/architecture/assets/hm_duration_range.puml b/score/health_monitor/docs/architecture/assets/hm_duration_range.puml index 094d6d1af..716fbe9f8 100644 --- a/score/health_monitor/docs/architecture/assets/hm_duration_range.puml +++ b/score/health_monitor/docs/architecture/assets/hm_duration_range.puml @@ -1,7 +1,6 @@ @startuml -+struct TimeRange -{ ++class TimeRange { min: Duration max: Duration } diff --git a/score/health_monitor/docs/architecture/assets/lm_state.puml b/score/health_monitor/docs/architecture/assets/lm_state.puml index ac0a8726f..1e4cd2aa3 100644 --- a/score/health_monitor/docs/architecture/assets/lm_state.puml +++ b/score/health_monitor/docs/architecture/assets/lm_state.puml @@ -4,4 +4,4 @@ +new>(name: N) -> Self } -@enduml \ No newline at end of file +@enduml diff --git a/score/health_monitor/docs/architecture/chklst_arc_inspection.rst b/score/health_monitor/docs/architecture/chklst_arc_inspection.rst index 06209acf7..bb39f9018 100644 --- a/score/health_monitor/docs/architecture/chklst_arc_inspection.rst +++ b/score/health_monitor/docs/architecture/chklst_arc_inspection.rst @@ -16,9 +16,10 @@ .. document:: Health Monitor Architecture Inspection Checklist :id: doc__health_monitor_arc_inspection :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__sw_arch_verification + :realizes: wp__sw_arch_verification[version==1] Architecture Inspection Checklist diff --git a/score/health_monitor/docs/architecture/index.rst b/score/health_monitor/docs/architecture/index.rst index f3446b549..926af3618 100644 --- a/score/health_monitor/docs/architecture/index.rst +++ b/score/health_monitor/docs/architecture/index.rst @@ -20,9 +20,10 @@ Component Architecture .. document:: HealthMonitor Architecture :id: doc__health_monitor_architecture :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__component_arch + :realizes: wp__component_arch[version==1] :tags: template .. attention:: @@ -43,6 +44,7 @@ Document describes HealthMonitor component architecture. :security: YES :safety: ASIL_B :status: valid + :version: 1 :belongs_to: feat__lifecycle Health Monitor component provides a set of functionalities to verify the health of the system and its components. It includes monitoring deadlines, logic, and heartbeats to ensure proper system functioning. @@ -72,6 +74,7 @@ Static Architecture :security: NO :safety: ASIL_B :status: valid + :version: 1 :implements: :fulfils: comp_req__health_monitor__dummy :belongs_to: comp__health_monitor @@ -84,6 +87,7 @@ Static Architecture :security: NO :safety: ASIL_B :status: valid + :version: 1 :implements: :fulfils: comp_req__health_monitor__dummy :belongs_to: comp__health_monitor @@ -96,6 +100,7 @@ Static Architecture :security: NO :safety: ASIL_B :status: valid + :version: 1 :implements: :fulfils: comp_req__health_monitor__dummy :belongs_to: comp__health_monitor @@ -111,6 +116,7 @@ Dynamic Architecture :security: NO :safety: ASIL_B :status: valid + :version: 1 :fulfils: comp_req__health_monitor__dummy :belongs_to: comp__health_monitor @@ -121,6 +127,7 @@ Dynamic Architecture :security: NO :safety: ASIL_B :status: valid + :version: 1 :fulfils: comp_req__health_monitor__dummy :belongs_to: comp__health_monitor @@ -131,6 +138,7 @@ Dynamic Architecture :security: NO :safety: ASIL_B :status: valid + :version: 1 :fulfils: comp_req__health_monitor__dummy :belongs_to: comp__health_monitor @@ -141,6 +149,7 @@ Dynamic Architecture :security: NO :safety: ASIL_B :status: valid + :version: 1 :fulfils: comp_req__health_monitor__dummy :belongs_to: comp__health_monitor @@ -151,6 +160,7 @@ Dynamic Architecture :security: NO :safety: ASIL_B :status: valid + :version: 1 :fulfils: comp_req__health_monitor__dummy :belongs_to: comp__health_monitor @@ -161,6 +171,7 @@ Dynamic Architecture :security: NO :safety: ASIL_B :status: valid + :version: 1 :fulfils: comp_req__health_monitor__dummy :belongs_to: comp__health_monitor @@ -171,6 +182,7 @@ Dynamic Architecture :security: NO :safety: ASIL_B :status: valid + :version: 1 :fulfils: comp_req__health_monitor__dummy :belongs_to: comp__health_monitor @@ -184,6 +196,7 @@ Interfaces :security: NO :safety: ASIL_B :status: valid + :version: 1 :fulfils: comp_req__health_monitor__dummy :language: rust @@ -194,6 +207,7 @@ Interfaces :security: NO :safety: ASIL_B :status: valid + :version: 1 :fulfils: comp_req__health_monitor__dummy :language: rust @@ -204,6 +218,7 @@ Interfaces :security: NO :safety: ASIL_B :status: valid + :version: 1 :fulfils: comp_req__health_monitor__dummy :language: rust @@ -214,6 +229,7 @@ Interfaces :security: NO :safety: ASIL_B :status: valid + :version: 1 :fulfils: comp_req__health_monitor__dummy :language: rust diff --git a/score/health_monitor/docs/detailed_design/assets/static_diagram.puml b/score/health_monitor/docs/detailed_design/assets/static_diagram.puml index 7156507c3..df77c1ff2 100644 --- a/score/health_monitor/docs/detailed_design/assets/static_diagram.puml +++ b/score/health_monitor/docs/detailed_design/assets/static_diagram.puml @@ -1,19 +1,22 @@ @startuml -!include ../../architecture/assets/lm_state.puml -!include ../../architecture/assets/hm_status.puml -!include ../../architecture/assets/hm_duration_range.puml -!include ../../architecture/assets/hm_deadline.puml +' Paths are relative to detailed_design/ (not this assets/ dir): a score_docs_as_code +' Sphinx extension bug resolves file-based `.. uml::` includes from the containing +' .rst file's directory instead of this file's directory. +!include ../architecture/assets/lm_state.puml +!include ../architecture/assets/hm_status.puml +!include ../architecture/assets/hm_duration_range.puml +!include ../architecture/assets/hm_deadline.puml -!include ../../architecture/assets/hmb_interface.puml -!includesub ../../architecture/assets/dmb_interface.puml!DeadlineMonitorBuilderClass -!includesub ../../architecture/assets/dmb_interface.puml!DeadlineMonitorBuilderRel -!includesub ../../architecture/assets/lmb_interface.puml!LogicMonitorBuilderClass -!includesub ../../architecture/assets/lmb_interface.puml!LogicMonitorBuilderRel +!include ../architecture/assets/hmb_interface.puml +!includesub ../architecture/assets/dmb_interface.puml!DeadlineMonitorBuilderClass +!includesub ../architecture/assets/dmb_interface.puml!DeadlineMonitorBuilderRel +!includesub ../architecture/assets/lmb_interface.puml!LogicMonitorBuilderClass +!includesub ../architecture/assets/lmb_interface.puml!LogicMonitorBuilderRel -!includesub ../../architecture/assets/lm_interface.puml!LogicMonitorRel -!includesub ../../architecture/assets/dm_interface.puml!DeadlineMonitorRel -!includesub ../../architecture/assets/hbm_interface.puml!HeartbeatMonitorRel -!includesub ../../architecture/assets/hm_interface.puml!HealthMonitorRel +!includesub ../architecture/assets/lm_interface.puml!LogicMonitorRel +!includesub ../architecture/assets/dm_interface.puml!DeadlineMonitorRel +!includesub ../architecture/assets/hbm_interface.puml!HeartbeatMonitorRel +!includesub ../architecture/assets/hm_interface.puml!HealthMonitorRel @enduml diff --git a/score/health_monitor/docs/detailed_design/chklst_impl_inspection.rst b/score/health_monitor/docs/detailed_design/chklst_impl_inspection.rst index f7195d6b8..a14f42c80 100644 --- a/score/health_monitor/docs/detailed_design/chklst_impl_inspection.rst +++ b/score/health_monitor/docs/detailed_design/chklst_impl_inspection.rst @@ -15,9 +15,10 @@ .. document:: Health Monitor Implementation Inspection Checklist :id: doc__health_monitor_impl_inspection :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__sw_implementation_inspection + :realizes: wp__sw_implementation_inspection[version==1] Implementation Inspection Checklist diff --git a/score/health_monitor/docs/detailed_design/index.rst b/score/health_monitor/docs/detailed_design/index.rst index 53b478454..5d8b5e492 100644 --- a/score/health_monitor/docs/detailed_design/index.rst +++ b/score/health_monitor/docs/detailed_design/index.rst @@ -20,9 +20,10 @@ Detailed Design .. document:: HealthMonitor Detailed Design :id: doc__health_monitor_detailed_design :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__sw_implementation + :realizes: wp__sw_implementation[version==1] :tags: template .. attention:: @@ -93,6 +94,7 @@ Dynamic Diagrams for Unit Interactions :security: :safety: :status: + :version: 1 :implements: :satisfies: diff --git a/score/health_monitor/docs/index.rst b/score/health_monitor/docs/index.rst index 6e3f22461..a75168c30 100644 --- a/score/health_monitor/docs/index.rst +++ b/score/health_monitor/docs/index.rst @@ -22,9 +22,10 @@ HealthMonitor .. document:: HealthMonitor :id: doc__health_monitor :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__cmpt_request + :realizes: wp__cmpt_request[version==1] :tags: health_monitor .. attention:: diff --git a/score/health_monitor/docs/requirements/chklst_req_inspection.rst b/score/health_monitor/docs/requirements/chklst_req_inspection.rst index e3381cd34..8913f6449 100644 --- a/score/health_monitor/docs/requirements/chklst_req_inspection.rst +++ b/score/health_monitor/docs/requirements/chklst_req_inspection.rst @@ -16,9 +16,10 @@ .. document:: Health Monitor Requirements Inspection Checklist :id: doc__health_monitor_req_inspection :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__requirements_inspect + :realizes: wp__requirements_inspect[version==1] Requirement Inspection Checklist diff --git a/score/health_monitor/docs/requirements/index.rst b/score/health_monitor/docs/requirements/index.rst index 1861ce6a8..2c56e088d 100644 --- a/score/health_monitor/docs/requirements/index.rst +++ b/score/health_monitor/docs/requirements/index.rst @@ -20,9 +20,10 @@ Requirements .. document:: HealthMonitor Requirements :id: doc__health_monitor_requirements :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__requirements_feat + :realizes: wp__requirements_feat[version==1] :tags: template .. attention:: @@ -43,6 +44,7 @@ Requirements :security: YES :rationale: Dummy :status: valid + :version: 1 :valid_from: v1.1.9999 .. note:: This is a dummy stakeholder requirement. See https://github.com/eclipse-score/lifecycle/issues/366 for more information. @@ -54,6 +56,7 @@ Requirements :security: YES :derived_from: stkh_req__requirements__dummy :status: valid + :version: 1 :valid_from: v1.1.9999 .. note:: This is a dummy feature requirement. See https://github.com/eclipse-score/lifecycle/issues/366 for more information. @@ -66,6 +69,7 @@ Requirements :derived_from: feat_req__requirements__template :belongs_to: comp__health_monitor :status: valid + :version: 1 .. note:: This is a dummy component requirement. See https://github.com/eclipse-score/lifecycle/issues/366 for more information. @@ -76,6 +80,7 @@ Requirements :security: YES :safety: ASIL_B :status: valid + :version: 1 .. note:: This is a dummy AoU requirement. See https://github.com/eclipse-score/lifecycle/issues/366 for more information. diff --git a/score/health_monitor/docs/safety_analysis/dfa.rst b/score/health_monitor/docs/safety_analysis/dfa.rst index 8f7cffac5..3f105d98c 100644 --- a/score/health_monitor/docs/safety_analysis/dfa.rst +++ b/score/health_monitor/docs/safety_analysis/dfa.rst @@ -19,9 +19,10 @@ DFA (Dependent Failure Analysis) .. document:: Health Monitor DFA :id: doc__health_monitor_dfa :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__sw_component_dfa + :realizes: wp__sw_component_dfa[version==1] :tags: template .. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram. @@ -48,6 +49,7 @@ Dependent Failure Initiators :mitigation_issue: :sufficient: :status: + :version: 1 .. note:: argument is inside the 'content'. Therefore content is mandatory diff --git a/score/health_monitor/docs/safety_analysis/fmea.rst b/score/health_monitor/docs/safety_analysis/fmea.rst index e07a6526f..40a6fb249 100644 --- a/score/health_monitor/docs/safety_analysis/fmea.rst +++ b/score/health_monitor/docs/safety_analysis/fmea.rst @@ -19,9 +19,10 @@ FMEA (Failure Modes and Effects Analysis) .. document:: Health Monitor FMEA :id: doc__health_monitor_fmea :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__sw_component_fmea + :realizes: wp__sw_component_fmea[version==1] :tags: template Failure Mode Evaluation Table @@ -152,6 +153,7 @@ Failure Mode List :mitigation_issue: :sufficient: :status: + :version: 1 .. note:: argument is inside the 'content'. Therefore content is mandatory diff --git a/score/launch_manager/docs/architecture/chklst_arc_inspection.rst b/score/launch_manager/docs/architecture/chklst_arc_inspection.rst index 8e850584d..ff5bc385a 100644 --- a/score/launch_manager/docs/architecture/chklst_arc_inspection.rst +++ b/score/launch_manager/docs/architecture/chklst_arc_inspection.rst @@ -16,9 +16,10 @@ .. document:: Launch Manager Architecture Inspection Checklist :id: doc__launch_manager_arc_inspection :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__sw_arch_verification + :realizes: wp__sw_arch_verification[version==1] Architecture Inspection Checklist diff --git a/score/launch_manager/docs/architecture/component_architecture.rst b/score/launch_manager/docs/architecture/component_architecture.rst index 814234eb1..c0a90fb44 100644 --- a/score/launch_manager/docs/architecture/component_architecture.rst +++ b/score/launch_manager/docs/architecture/component_architecture.rst @@ -18,9 +18,10 @@ Component Architecture Documentation .. document:: Launch Manager Architecture :id: doc__launch_manager_architecture :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__component_arch + :realizes: wp__component_arch[version==1] :tags: template diff --git a/score/launch_manager/docs/detailed_design/chklst_impl_inspection.rst b/score/launch_manager/docs/detailed_design/chklst_impl_inspection.rst index 8e94f08a5..f34810b94 100644 --- a/score/launch_manager/docs/detailed_design/chklst_impl_inspection.rst +++ b/score/launch_manager/docs/detailed_design/chklst_impl_inspection.rst @@ -15,9 +15,10 @@ .. document:: Launch Manager Implementation Inspection Checklist :id: doc__launch_manager_impl_inspection :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__sw_implementation_inspection + :realizes: wp__sw_implementation_inspection[version==1] Implementation Inspection Checklist diff --git a/score/launch_manager/docs/detailed_design/detailed_design.rst b/score/launch_manager/docs/detailed_design/detailed_design.rst index cf3e97dd3..f52a08d8c 100644 --- a/score/launch_manager/docs/detailed_design/detailed_design.rst +++ b/score/launch_manager/docs/detailed_design/detailed_design.rst @@ -18,9 +18,10 @@ Example: Detailed Design .. document:: Launch Manager Detailed Design :id: doc__launch_manager_detailed_design :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__sw_implementation + :realizes: wp__sw_implementation[version==1] Detailed Design for Component: Launch Manager diff --git a/score/launch_manager/docs/requirements/chklst_req_inspection.rst b/score/launch_manager/docs/requirements/chklst_req_inspection.rst index 991181592..286b94b96 100644 --- a/score/launch_manager/docs/requirements/chklst_req_inspection.rst +++ b/score/launch_manager/docs/requirements/chklst_req_inspection.rst @@ -16,9 +16,10 @@ .. document:: Launch Manager Requirements Inspection Checklist :id: doc__launch_manager_req_inspection :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__requirements_inspect + :realizes: wp__requirements_inspect[version==1] Requirement Inspection Checklist diff --git a/score/launch_manager/docs/requirements/requirements.rst b/score/launch_manager/docs/requirements/requirements.rst index 8134892db..890c1bff9 100644 --- a/score/launch_manager/docs/requirements/requirements.rst +++ b/score/launch_manager/docs/requirements/requirements.rst @@ -18,9 +18,10 @@ Component Launch Manager Requirements .. document:: Launch Manager Requirements :id: doc__launch_manager_requirements :status: draft + :version: 1 :safety: ASIL_B :security: YES - :realizes: wp__requirements_comp + :realizes: wp__requirements_comp[version==1] diff --git a/score/launch_manager/docs/safety_analysis/aou_requirements.rst b/score/launch_manager/docs/safety_analysis/aou_requirements.rst index b172ecc92..b80bad52d 100644 --- a/score/launch_manager/docs/safety_analysis/aou_requirements.rst +++ b/score/launch_manager/docs/safety_analysis/aou_requirements.rst @@ -18,9 +18,10 @@ AoU Component Requirements Template .. document:: Launch Manager Component AoU :id: doc__launch_manager_comp_aou :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__requirements_comp_aou + :realizes: wp__requirements_comp_aou[version==1] This page contains Assumption of Use requirement snippets that belong to the @@ -37,6 +38,7 @@ Component AoU :security: YES :safety: ASIL_B :status: invalid + :version: 1 The Component User shall do xyz to use the component safely/securely @@ -46,6 +48,7 @@ Component AoU :security: YES :safety: ASIL_B :status: invalid + :version: 1 :tags: environment The Component shall only be used in a xyz environment to ensure its proper functioning. diff --git a/score/launch_manager/docs/safety_analysis/dfa.rst b/score/launch_manager/docs/safety_analysis/dfa.rst index 9e2bf4dc4..50b6fafcb 100644 --- a/score/launch_manager/docs/safety_analysis/dfa.rst +++ b/score/launch_manager/docs/safety_analysis/dfa.rst @@ -19,9 +19,10 @@ DFA (Dependent Failure Analysis) .. document:: Launch Manager DFA :id: doc__launch_manager_dfa :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__sw_component_dfa + :realizes: wp__sw_component_dfa[version==1] .. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram. @@ -39,6 +40,7 @@ Dependent Failure Initiators :mitigation_issue: :sufficient: :status: + :version: 1 .. note:: Argument is inside the 'content'. Therefore content is mandatory. diff --git a/score/launch_manager/docs/safety_analysis/fmea.rst b/score/launch_manager/docs/safety_analysis/fmea.rst index 2267d9ea0..d35263d49 100644 --- a/score/launch_manager/docs/safety_analysis/fmea.rst +++ b/score/launch_manager/docs/safety_analysis/fmea.rst @@ -19,9 +19,10 @@ FMEA (Failure Modes and Effects Analysis) .. document:: Launch Manager FMEA :id: doc__launch_manager_fmea :status: draft + :version: 1 :safety: ASIL_B :security: NO - :realizes: wp__sw_component_fmea + :realizes: wp__sw_component_fmea[version==1] .. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram. @@ -113,6 +114,7 @@ For all identified applicable failure initiators, the FMEA is performed in the f :mitigation_issue: :sufficient: :status: + :version: 1 .. note:: argument is inside the 'content'. Therefore content is mandatory