diff --git a/docs/score_tools/index.rst b/docs/score_tools/index.rst index f0c91cacf03..695ccd867af 100644 --- a/docs/score_tools/index.rst +++ b/docs/score_tools/index.rst @@ -17,21 +17,23 @@ S-CORE Tools Overview ===================== -.. needtable:: Tools List - :tags: tool_management - :filter: "tool_management" in tags and type == "doc_tool" and is_external == False - :style: table - :sort: status - :columns: id as "UID";title as "TITLE";version as "VERSION";status as "STATUS";tcl as "TCL";safety_affected as "SAFETY AFFECTED";security_affected as "SECURITY AFFECTED" - :colwidths: 30,30,30,30,30,30,30 +.. .. needtable:: Tools List +.. :tags: tool_management +.. :filter: "tool_management" in tags and type == "doc_tool" and is_external == False +.. :style: table +.. :sort: status +.. :columns: id as "UID";title as "TITLE";version as "VERSION";status as "STATUS";tcl as "TCL";safety_affected as "SAFETY AFFECTED";security_affected as "SECURITY AFFECTED" +.. :colwidths: 30,30,30,30,30,30,30 .. toctree:: :hidden: :maxdepth: 2 - doc_as_code - gtest - bazel - rustfmt - itf - clippy + score_tools_evaluation_list + tools_documentation/index + tools_static_analysis_code_quality/index + tools_testing_frameworks/index + tools_build_development/index + tools_compiler/index + tools_vc_cicd/index + tools_license_security/index diff --git a/docs/score_tools/score_tools_evaluation_list.rst b/docs/score_tools/score_tools_evaluation_list.rst new file mode 100644 index 00000000000..240ea466dc8 --- /dev/null +++ b/docs/score_tools/score_tools_evaluation_list.rst @@ -0,0 +1,653 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +.. document:: Tool Evaluation List + :id: doc__tool_evaluation_list + :status: draft + :safety: ASIL_B + :security: YES + :realizes: wp__tool_verification_report + :tags: tool_management + + +.. contents:: Table of Contents + :depth: 3 + :local: + + +S-CORE - Complete Tool List for Tool Evaluation +=============================================== + +Overview +-------- + +This document provides a comprehensive initial inventory of all tools used across the Eclipse +S-CORE project. + +The list is categorized by tool type, e.g. documentation tools, static analysis tools, testing +frameworks, build tools, etc. + +The list is intended to be used for the evaluation of tools for safety and security impact, as part +of the tool management process defined in the S-CORE Tool Management Plan. + +In future iterations, the list will be completed and updated, and delivered with every platform +release, as part of the Tool Verification Report. + + +1 Documentation Tools +--------------------- + +.. list-table:: Documentation Tools + :header-rows: 1 + :widths: 5 15 15 10 10 10 40 40 + + * - ID + - Tool Name + - Description + - Version + - Relevant [YES|NO] + - Tool ownership + - Link to Verification Report (if relevant) + - Confirmation of Use [YES|NO] (if relevant) + * - 1-1 + - Doc-as-Code + - Documentation generation tool + - 3.0.0 (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - :need:`doc_tool__doc_as_code` + - YES + * - 1-2 + - Sphinx + - Python documentation generator (underlying Doc-as-Code) + - Latest (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 1-3 + - sphinx-needs + - Requirements tracking extension for Sphinx + - T.B.D. (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 1-4 + - PlantUML + - UML diagram generation + - T.B.D. (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 1-5 + - Graphviz + - Graph visualization software + - T.B.D. (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 1-6 + - sphinxcontrib.plantuml + - PlantUML integration for Sphinx + - T.B.D. (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 1-7 + - TRLC + - BMW Requirements Traceability Language and Compiler + - 2.0.2 (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 1-8 + - LOBSTER + - BMW Requirements traceability and documentation tool + - T.B.D. (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + + +2 Static Analysis & Code Quality +-------------------------------- + + +2a C++ +++++++ + +.. list-table:: C++ Static Analysis & Code Quality + :header-rows: 1 + :widths: 5 15 15 10 10 10 40 40 + + * - ID + - Tool Name + - Description + - Version + - Relevant [YES|NO] + - Tool ownership + - Link to Verification Report (if relevant) + - Confirmation of Use [YES|NO] (if relevant) + * - 2a-1 + - clang-tidy + - Static analysis for C++, used with Clang compiler + - 19.x (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 2a-2 + - clang-analyzer + - Static analyzer from LLVM project + - 19.x (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 2a-3 + - CodeQL + - CodeQL is a semantic code analysis engine used for security and code quality analysis. + - T.B.D. (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 2a-4 + - gcovr + - Code coverage tool (uses gcov from GCC), part of GNU compiler collection + - T.B.D. (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + + +2b Rust ++++++++ + +.. list-table:: Rust Static Analysis & Code Quality + :header-rows: 1 + :widths: 5 15 15 10 10 10 40 40 + + * - ID + - Tool Name + - Description + - Version + - Relevant [YES|NO] + - Tool ownership + - Link to Verification Report (if relevant) + - Confirmation of Use [YES|NO] (if relevant) + * - 2b-1 + - clippy + - Rust linter for static code analysis + - 1.90.0 (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - :need:`doc_tool__clippy` + - YES + * - 2b-2 + - rustfmt + - Rust code formatter + - 1.8.0 (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - :need:`doc_tool__rustfmt` + - YES + * - 2b-3 + - rust-analyzer + - Rust language server for IDE support + - 1.8.0 (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + + +2c Python ++++++++++ + +.. list-table:: Python Static Analysis & Code Quality + :header-rows: 1 + :widths: 5 15 15 10 10 10 40 40 + + * - ID + - Tool Name + - Description + - Version + - Relevant [YES|NO] + - Tool ownership + - Link to Verification Report (if relevant) + - Confirmation of Use [YES|NO] (if relevant) + * - 2c-1 + - ruff + - Fast Python formatter and linter, replaces multiple tools + - T.B.D. (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 2c-2 + - pyright + - Python static type checker + - T.B.D. (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 2c-3 + - pylint + - Python code quality analysis + - T.B.D. (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 2c-4 + - pytest-cov + - Python test coverage reporting + - T.B.D. (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 2c-5 + - basedpyright + - Alternative Python type checker + - T.B.D. (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + + +2d Other +++++++++ + +.. list-table:: Other Static Analysis & Code Quality + :header-rows: 1 + :widths: 5 15 15 10 10 10 40 40 + + * - ID + - Tool Name + - Description + - Version + - Relevant [YES|NO] + - Tool ownership + - Link to Verification Report (if relevant) + - Confirmation of Use [YES|NO] (if relevant) + * - 2d-1 + - yamlfmt + - YAML file formatter + - T.B.D. (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 2d-2 + - actionlint + - GitHub Actions workflow linter + - T.B.D. (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 2d-3 + - starpls + - Starlark (Bazel) language server + - T.B.D. (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 2d-4 + - score_tooling + - Copyright checker, CLI helper, license checker + - 1.0.4 (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 2d-5 + - bazel-tools-cc + - Clang-tidy based static code checker for Bazel + - T.B.D. (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 2d-6 + - gitlint + - Commit message linting + - 0.19.1 (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + + +3 Testing Frameworks +-------------------- + +.. list-table:: Testing Frameworks + :header-rows: 1 + :widths: 5 15 15 10 10 10 40 40 + + * - ID + - Tool Name + - Description + - Version + - Relevant [YES|NO] + - Tool ownership + - Link to Verification Report (if relevant) + - Confirmation of Use [YES|NO] (if relevant) + * - 3-1 + - gtest (GoogleTest) + - C++ testing framework + - 1.15.0 (see [1]_) + - YES + - :need:`rl__testing_community` + - :need:`doc_tool__gtest` + - YES + * - 3-2 + - ITF + - Integration Testing Framework, pytest-based + - 0.1.0 (see [1]_) + - YES + - :need:`rl__testing_community` + - :need:`doc_tool__itf` + - YES + * - 3-3 + - pytest + - Python testing framework + - T.B.D. (see [1]_) + - YES + - :need:`rl__testing_community` + - N/A + - YES + + + +4 Build & Development Tools +--------------------------- + +.. list-table:: Build & Development Tools + :header-rows: 1 + :widths: 5 15 15 10 10 10 40 40 + + * - ID + - Tool Name + - Description + - Version + - Relevant [YES|NO] + - Tool ownership + - Link to Verification Report (if relevant) + - Confirmation of Use [YES|NO] (if relevant) + * - 4-1 + - Bazel + - Main build system + - 8.3.0 (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - :need:`doc_tool__bazel` + - YES + * - 4-2 + - buildifier + - Bazel file formatter and linter + - 8.2.0.2 (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 4-3 + - rules_python + - Bazel Python build rules + - 1.4.1 (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 4-4 + - aspect_rules_py + - Enhanced Python rules (provides py_venv) + - 1.6.3 (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 4-5 + - aspect_rules_lint + - Generic linting and formatting rules + - 1.5.3 (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 4-6 + - rules_pkg + - Packaging dependencies + - 1.1.0 (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 4-7 + - rules_java + - Java build rules + - 8.15.1 (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 4-8 + - rules_cc + - C/C++ build rules + - 0.2.1 (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 4-9 + - rules_rust + - Rust build rules for Bazel + - 0.63.0 (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 4-10 + - score_toolchains_qnx + - QNX SDP toolchain including compiler, linker, image creation tools + - 0.5 (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 4-11 + - score_toolchains_gcc + - GCC toolchain packages for various targets + - 0.5 (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 4-11 + - score_toolchains_rust + - Rust toolchains for SCORE project + - T.B.D. (see [1]_) + - NO + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + +5 Compiler +---------- + +5a C++ Compiler ++++++++++++++++ + +.. list-table:: C++ Compiler + :header-rows: 1 + :widths: 5 15 15 10 10 10 40 40 + + * - ID + - Tool Name + - Description + - Version + - Relevant [YES|NO] + - Tool ownership + - Link to Verification Report (if relevant) + - Confirmation of Use [YES|NO] (if relevant) + * - 5a-1 + - GCC + - Host C++ compiler with linker, generates compiler warnings, builds unit tests and binaries for SW integration testing + - 12+ (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 5a-2 + - QNX 8.x SDP + - Qualifiable compiler/linker from BlackBerry for QNX, used for target compilation + - 12+ (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - :need:`doc_tool__bazel` + - N/A + * - 5a-3 + - LLVM/Clang + - Alternative C++ compiler toolchain + - 19.1.0 (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - :need:`doc_tool__bazel` + - N/A + * - 5a-4 + - toolchains_llvm + - LLVM toolchain rules for Bazel (host configuration, C++17 standard) + - 1.4.0 (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - :need:`doc_tool__bazel` + - N/A + + +5b Rust Compiler +++++++++++++++++ + +.. list-table:: Rust Compiler + :header-rows: 1 + :widths: 5 15 15 10 10 10 40 40 + + * - ID + - Tool Name + - Description + - Version + - Relevant [YES|NO] + - Tool ownership + - Link to Verification Report (if relevant) + - Confirmation of Use [YES|NO] (if relevant) + * - 5b-1 + - Ferrocene + - Qualified Rust compiler (planned for target, safety-critical use), see https://github.com/ferrocene + - 1.90.0 (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 5b-2 + - Rust (standard) + - For host development, no current selection for S-CORE host compiler + - 1.90.0 (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - NO + + +6 Version Control & CI/CD +------------------------- + +.. list-table:: Version Control and CI/CD Tools + :header-rows: 1 + :widths: 5 15 15 10 10 10 40 40 + + * - ID + - Tool Name + - Description + - Version + - Relevant [YES|NO] + - Tool ownership + - Link to Verification Report (if relevant) + - Confirmation of Use [YES|NO] (if relevant) + * - 6-1 + - Git + - Version control system + - 2.x (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 6-2 + - GitHub + - Code hosting and collaboration platform + - T.B.D. (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + * - 6-3 + - GitHub Actions + - CI/CD automation platform + - T.B.D. (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + + +7 License & Security +-------------------- + +.. list-table:: License & Security + :header-rows: 1 + :widths: 5 15 15 10 10 10 40 40 + + * - ID + - Tool Name + - Description + - Version + - Relevant [YES|NO] + - Tool ownership + - Link to Verification Report (if relevant) + - Confirmation of Use [YES|NO] (if relevant) + * - 7-1 + - Eclipse Dash + - License analysis tool + - T.B.D. (see [1]_) + - YES + - :need:`rl__infrastructure_tooling_community` + - N/A + - YES + + + + +.. [1] The tool version mentioned in this document is preliminary. + Exact version must be derived before every platform release. diff --git a/docs/score_tools/_assets/bazel.drawio.svg b/docs/score_tools/tools_build_development/_assets/bazel.drawio.svg similarity index 100% rename from docs/score_tools/_assets/bazel.drawio.svg rename to docs/score_tools/tools_build_development/_assets/bazel.drawio.svg diff --git a/docs/score_tools/bazel.rst b/docs/score_tools/tools_build_development/bazel.rst similarity index 99% rename from docs/score_tools/bazel.rst rename to docs/score_tools/tools_build_development/bazel.rst index 60aeaf398f2..2b9a07c7dfd 100644 --- a/docs/score_tools/bazel.rst +++ b/docs/score_tools/tools_build_development/bazel.rst @@ -20,7 +20,7 @@ :safety_affected: YES :security_affected: YES :realizes: wp__tool_verification_report - :tags: tool_management + :tags: tool_management, tools_build_development Bazel Verification Report diff --git a/docs/score_tools/tools_build_development/index.rst b/docs/score_tools/tools_build_development/index.rst new file mode 100644 index 00000000000..804e5894982 --- /dev/null +++ b/docs/score_tools/tools_build_development/index.rst @@ -0,0 +1,32 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +.. _tools_build_development: + +Build & Development Tools Overview +================================== + +.. needtable:: Testing Frameworks List + :tags: tool_management, tools_build_development + :filter: "tool_management" in tags and "tools_build_development" in tags and type == "doc_tool" and is_external == False + :style: table + :sort: status + :columns: id as "UID";title as "TITLE";version as "VERSION";status as "STATUS";tcl as "TCL";safety_affected as "SAFETY AFFECTED";security_affected as "SECURITY AFFECTED" + :colwidths: 30,30,30,30,30,30,30 + +.. toctree:: + :hidden: + :maxdepth: 2 + + bazel diff --git a/docs/score_tools/tools_compiler/index.rst b/docs/score_tools/tools_compiler/index.rst new file mode 100644 index 00000000000..c8f24869249 --- /dev/null +++ b/docs/score_tools/tools_compiler/index.rst @@ -0,0 +1,30 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +.. _tools_compiler: + +Compiler Tools Overview +======================= + +.. needtable:: Compiler Tools List + :tags: tool_management, tools_compiler + :filter: "tool_management" in tags and "tools_compiler" in tags and type == "doc_tool" and is_external == False + :style: table + :sort: status + :columns: id as "UID";title as "TITLE";version as "VERSION";status as "STATUS";tcl as "TCL";safety_affected as "SAFETY AFFECTED";security_affected as "SECURITY AFFECTED" + :colwidths: 30,30,30,30,30,30,30 + +.. toctree:: + :hidden: + :maxdepth: 2 diff --git a/docs/score_tools/_assets/doc_as_code.drawio.svg b/docs/score_tools/tools_documentation/_assets/doc_as_code.drawio.svg similarity index 100% rename from docs/score_tools/_assets/doc_as_code.drawio.svg rename to docs/score_tools/tools_documentation/_assets/doc_as_code.drawio.svg diff --git a/docs/score_tools/doc_as_code.rst b/docs/score_tools/tools_documentation/doc_as_code.rst similarity index 99% rename from docs/score_tools/doc_as_code.rst rename to docs/score_tools/tools_documentation/doc_as_code.rst index 3c3faa6db37..ae15e46b866 100644 --- a/docs/score_tools/doc_as_code.rst +++ b/docs/score_tools/tools_documentation/doc_as_code.rst @@ -20,7 +20,7 @@ :safety_affected: YES :security_affected: YES :realizes: wp__tool_verification_report - :tags: tool_management + :tags: tool_management, tools_documentation Doc-as-Code Verification Report diff --git a/docs/score_tools/tools_documentation/index.rst b/docs/score_tools/tools_documentation/index.rst new file mode 100644 index 00000000000..dd768e6447f --- /dev/null +++ b/docs/score_tools/tools_documentation/index.rst @@ -0,0 +1,32 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +.. _tools_documentation: + +Documentation Tools Overview +============================ + +.. needtable:: Documentation Tools List + :tags: tool_management, tools_documentation + :filter: "tool_management" in tags and "tools_documentation" in tags and type == "doc_tool" and is_external == False + :style: table + :sort: status + :columns: id as "UID";title as "TITLE";version as "VERSION";status as "STATUS";tcl as "TCL";safety_affected as "SAFETY AFFECTED";security_affected as "SECURITY AFFECTED" + :colwidths: 30,30,30,30,30,30,30 + +.. toctree:: + :hidden: + :maxdepth: 2 + + doc_as_code diff --git a/docs/score_tools/tools_license_security/index.rst b/docs/score_tools/tools_license_security/index.rst new file mode 100644 index 00000000000..df0fb48f087 --- /dev/null +++ b/docs/score_tools/tools_license_security/index.rst @@ -0,0 +1,30 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +.. _tools_license_security: + +License & Security +================== + +.. needtable:: Compiler Tools List + :tags: tool_management, tools_license_security + :filter: "tool_management" in tags and "tools_license_security" in tags and type == "doc_tool" and is_external == False + :style: table + :sort: status + :columns: id as "UID";title as "TITLE";version as "VERSION";status as "STATUS";tcl as "TCL";safety_affected as "SAFETY AFFECTED";security_affected as "SECURITY AFFECTED" + :colwidths: 30,30,30,30,30,30,30 + +.. toctree:: + :hidden: + :maxdepth: 2 diff --git a/docs/score_tools/_assets/clippy.drawio.svg b/docs/score_tools/tools_static_analysis_code_quality/_assets/clippy.drawio.svg similarity index 100% rename from docs/score_tools/_assets/clippy.drawio.svg rename to docs/score_tools/tools_static_analysis_code_quality/_assets/clippy.drawio.svg diff --git a/docs/score_tools/_assets/rustfmt.drawio.svg b/docs/score_tools/tools_static_analysis_code_quality/_assets/rustfmt.drawio.svg similarity index 100% rename from docs/score_tools/_assets/rustfmt.drawio.svg rename to docs/score_tools/tools_static_analysis_code_quality/_assets/rustfmt.drawio.svg diff --git a/docs/score_tools/clippy.rst b/docs/score_tools/tools_static_analysis_code_quality/clippy.rst similarity index 98% rename from docs/score_tools/clippy.rst rename to docs/score_tools/tools_static_analysis_code_quality/clippy.rst index ac82b557af7..478b9fa1341 100644 --- a/docs/score_tools/clippy.rst +++ b/docs/score_tools/tools_static_analysis_code_quality/clippy.rst @@ -20,7 +20,7 @@ :safety_affected: YES :security_affected: YES :realizes: wp__tool_verification_report - :tags: tool_management + :tags: tool_management, tools_static_analysis_code_quality Clippy Verification Report =========================== diff --git a/docs/score_tools/tools_static_analysis_code_quality/index.rst b/docs/score_tools/tools_static_analysis_code_quality/index.rst new file mode 100644 index 00000000000..a924110be96 --- /dev/null +++ b/docs/score_tools/tools_static_analysis_code_quality/index.rst @@ -0,0 +1,33 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +.. _tools_static_analysis_code_quality: + +Static Analysis & Code Quality Tools Overview +============================================= + +.. needtable:: Static Analysis & Code Quality List + :tags: tool_management, tools_static_analysis_code_quality + :filter: "tool_management" in tags and "tools_static_analysis_code_quality" in tags and type == "doc_tool" and is_external == False + :style: table + :sort: status + :columns: id as "UID";title as "TITLE";version as "VERSION";status as "STATUS";tcl as "TCL";safety_affected as "SAFETY AFFECTED";security_affected as "SECURITY AFFECTED" + :colwidths: 30,30,30,30,30,30,30 + +.. toctree:: + :hidden: + :maxdepth: 2 + + clippy + rustfmt diff --git a/docs/score_tools/rustfmt.rst b/docs/score_tools/tools_static_analysis_code_quality/rustfmt.rst similarity index 98% rename from docs/score_tools/rustfmt.rst rename to docs/score_tools/tools_static_analysis_code_quality/rustfmt.rst index 881d01f4773..a76eadbac86 100644 --- a/docs/score_tools/rustfmt.rst +++ b/docs/score_tools/tools_static_analysis_code_quality/rustfmt.rst @@ -20,7 +20,7 @@ :safety_affected: YES :security_affected: YES :realizes: wp__tool_verification_report - :tags: tool_management + :tags: tool_management, tools_static_analysis_code_quality Rustfmt Verification Report =========================== diff --git a/docs/score_tools/_assets/gtest.drawio.svg b/docs/score_tools/tools_testing_frameworks/_assets/gtest.drawio.svg similarity index 100% rename from docs/score_tools/_assets/gtest.drawio.svg rename to docs/score_tools/tools_testing_frameworks/_assets/gtest.drawio.svg diff --git a/docs/score_tools/_assets/itf.drawio.svg b/docs/score_tools/tools_testing_frameworks/_assets/itf.drawio.svg similarity index 100% rename from docs/score_tools/_assets/itf.drawio.svg rename to docs/score_tools/tools_testing_frameworks/_assets/itf.drawio.svg diff --git a/docs/score_tools/gtest.rst b/docs/score_tools/tools_testing_frameworks/gtest.rst similarity index 99% rename from docs/score_tools/gtest.rst rename to docs/score_tools/tools_testing_frameworks/gtest.rst index 43e8671808b..fa0169da1a0 100644 --- a/docs/score_tools/gtest.rst +++ b/docs/score_tools/tools_testing_frameworks/gtest.rst @@ -20,7 +20,7 @@ :safety_affected: YES :security_affected: YES :realizes: wp__tool_verification_report - :tags: tool_management + :tags: tool_management, tools_testing_frameworks GoogleTest (GTest) Verification Report ====================================== diff --git a/docs/score_tools/tools_testing_frameworks/index.rst b/docs/score_tools/tools_testing_frameworks/index.rst new file mode 100644 index 00000000000..34845e3b4f0 --- /dev/null +++ b/docs/score_tools/tools_testing_frameworks/index.rst @@ -0,0 +1,33 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +.. _tools_testing_frameworks: + +Testing Frameworks Tools Overview +================================= + +.. needtable:: Testing Frameworks List + :tags: tool_management, tools_testing_frameworks + :filter: "tool_management" in tags and "tools_testing_frameworks" in tags and type == "doc_tool" and is_external == False + :style: table + :sort: status + :columns: id as "UID";title as "TITLE";version as "VERSION";status as "STATUS";tcl as "TCL";safety_affected as "SAFETY AFFECTED";security_affected as "SECURITY AFFECTED" + :colwidths: 30,30,30,30,30,30,30 + +.. toctree:: + :hidden: + :maxdepth: 2 + + gtest + itf diff --git a/docs/score_tools/itf.rst b/docs/score_tools/tools_testing_frameworks/itf.rst similarity index 99% rename from docs/score_tools/itf.rst rename to docs/score_tools/tools_testing_frameworks/itf.rst index aa906f1da93..e06bbb2cf30 100644 --- a/docs/score_tools/itf.rst +++ b/docs/score_tools/tools_testing_frameworks/itf.rst @@ -20,7 +20,7 @@ :safety_affected: YES :security_affected: YES :realizes: wp__tool_verification_report - :tags: tool_management + :tags: tool_management, tools_testing_frameworks ITF (Integration Testing Framework) Verification Report ======================================================= diff --git a/docs/score_tools/tools_vc_cicd/index.rst b/docs/score_tools/tools_vc_cicd/index.rst new file mode 100644 index 00000000000..3b219d9e6de --- /dev/null +++ b/docs/score_tools/tools_vc_cicd/index.rst @@ -0,0 +1,30 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +.. _tools_vc_cicd: + +Version Control & CI/CD Tools Overview +====================================== + +.. needtable:: Compiler Tools List + :tags: tool_management, tools_vc_cicd + :filter: "tool_management" in tags and "tools_vc_cicd" in tags and type == "doc_tool" and is_external == False + :style: table + :sort: status + :columns: id as "UID";title as "TITLE";version as "VERSION";status as "STATUS";tcl as "TCL";safety_affected as "SAFETY AFFECTED";security_affected as "SECURITY AFFECTED" + :colwidths: 30,30,30,30,30,30,30 + +.. toctree:: + :hidden: + :maxdepth: 2