Merge pull request #2663 from qorix-group/vohae_sdp_audit_fix

Add critiera for prog. design language to SDP

Author: masc2023

docs/contribute/development/cpp/coding_guidelines.rst

@@ -12,8 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Writing C++ Code
-################
+Writing C++ Code incl. Coding Guidelines
+########################################
 
 .. document:: Coding Guidelines C++
    :id: doc__cpp_coding_guidelines

docs/contribute/development/rust/coding_guidelines.rst

@@ -12,8 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Writing Rust Code
-#################
+Writing Rust Code incl. Coding Guidelines
+#########################################
 
 .. document:: Coding Guidelines Rust
    :id: doc__rust_coding_guidelines
@@ -40,6 +40,8 @@ reporting and code metrics generators, are still unavailable, and the
 consortium is evaluating what further tooling and support are necessary to
 enable certification and safe use of Rust in automotive applications.
 
+`Safety-Critical Coding Guidelines <https://github.com/rustfoundation/safety-critical-rust-coding-guidelines>`_
+
 `Safety-Critical Rust Consortium <https://rustfoundation.org/safety-critical-rust-consortium>`_
 
 `Safety-Critical Rust Consortium Guidelines <https://github.com/rustfoundation/safety-critical-rust-consortium/tree/main/subcommittee/coding-guidelines/>`_

docs/platform_management_plan/software_development.rst

@@ -44,14 +44,40 @@ Scope is the complete SW platform and the development parts of the process.
 Approach
 ++++++++
 
-Design and programming language
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-For specifying **Detailed Design** (like for the Architecture) a mixture of UML diagrams and natural language is used.
-Additionally for the Detailed Design linking to code, Doxygen style comments are used.
-This is described in :need:`doc_concept__imp_concept` and guided by :need:`gd_temp__detailed_design`
-
-As required in :need:`stkh_req__dev_experience__prog_languages`, S-CORE allows the use of two programming languages:
+Selection of design and programming language
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+For the selection of design and programming language a stakeholder requirement is defined in :need:`stkh_req__dev_experience__prog_languages`,
+which is based on experience. The criteria for selection are based on the following aspects:
+
+* Unambiguous definition of syntax and semantics
+* Suitability for specifying and managing for safety related requirements and design
+* Support of modularity, abstraction and encapsulation
+* Support of the use of structured constructs
+
+The selected languages form the stakeholder requirements were analysed in the following table:
+
+.. list-table:: Selection of design and programming language
+   :header-rows: 1
+   :widths: 33,33,33
+
+   * - Criteria
+     - C++
+     - Rust
+   * - Unambiguous definition of syntax and semantics
+     - Standardized, strict syntax, strong tooling
+     - Strict syntax, single compiler, strong tooling
+   * - Suitability for safety related programming
+     - Certified tools, MISRA, static analysis, traceability
+     - Compiler-enforced safety, strong type system, documentation, emerging safety support, certified tools
+   * - Support of modularity, abstraction and encapsulation
+     - Classes, templates, modules, access control
+     - Modules, crates, traits, strong visibility control
+   * - Support of the use of structured constructs
+     - Full support for structured programming
+     - Full support, enforced by language design
+
+S-CORE allows the use of two programming languages:
 
 **C++ with the language set of C++17** - in case additional elements from C++20 are needed this will be considered by
 :need:`rl__safety_manager`, :need:`rl__security_manager` and :need:`rl__quality_manager`
@@ -62,6 +88,10 @@ For the Rust code of ASIL rated units the "safe subset" shall be used (which is
 
 C language is allowed in incubation phase, as long it is compilable be the selected compiler, but not for a S-CORE release.
 
+For specifying **Detailed Design** (like for the Architecture) a mixture of UML diagrams and natural language is used.
+Additionally for the Detailed Design linking to code, Doxygen style comments are used.
+This is described in :need:`doc_concept__imp_concept` and guided by :need:`gd_temp__detailed_design`
+
 Design guideline
 ^^^^^^^^^^^^^^^^