diff --git a/docs/conf.py b/docs/conf.py index f2057673436..6312f3ae246 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,6 +25,14 @@ "score_sphinx_bundle", ] +# Exclude external release notes that are now maintained locally in docs/score_releases/ +exclude_patterns = [ + "_collections/score_platform/docs/score_releases/score_releases/**", +] + +# Suppress toc.excluded warnings from external modules referencing excluded docs +suppress_warnings = ["toc.excluded"] + # Enable markdown rendering source_suffix = { ".rst": "restructuredtext", diff --git a/docs/index.rst b/docs/index.rst index bbc08312fe4..325467e0885 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,11 +15,6 @@ Reference Integration Documentation =================================== -Newest Release Notes --------------------- - -:doc:`score_releases/release_note_score_07` - Current Integration Status Overview ----------------------------------- @@ -27,6 +22,14 @@ Current Integration Status Overview Explore the documentation ------------------------- + +.. toctree:: + :glob: + :caption: S-CORE Releases + :maxdepth: 2 + + score_releases/index + .. toctree:: :caption: Software Components :titlesonly: @@ -55,9 +58,3 @@ Explore the documentation verification_report/platform_verification_report -.. toctree:: - :hidden: - :glob: - - score_releases/* - verification_report/* diff --git a/docs/score_releases/_assets/architecture.drawio.svg b/docs/score_releases/_assets/architecture.drawio.svg new file mode 100644 index 00000000000..bba9e385726 --- /dev/null +++ b/docs/score_releases/_assets/architecture.drawio.svg @@ -0,0 +1,2223 @@ + + + + + + + + + + + + + + + + + + + + +
+
+
+ C++ Base Libraries +
+
+
+ + + C++ Base Libraries + + + + + + + + + + + +
+
+
+ Development Environment +
+
+
+ + + Development Environment + + + + + + + + + + + +
+
+
+ Platform API (native APIs for Rust and C++) +
+
+
+ + + Platform API (native APIs for Rust and C++) + + + + + + + + + + + +
+
+
+ System Services +
+
+
+ + + System Services + + + + + + + + + + + +
+
+
+ Communication +
+
+
+ + + Communication + + + + + + + + + + + +
+
+
+ Operating System +
+
+
+ + + Operating System + + + + + + + + + + + +
+
+
+ Hypervisor / Hardware +
+
+
+ + + Hypervisor / Hardware + + + + + + + + + + + +
+
+
+ Rust Base Libraries +
+
+
+ + + Rust Base Libraries + + + + + + + + + + + +
+
+
+ Filesystem +
+
+
+ + + Filesystem + + + + + + + + + + + +
+
+
+ FutureCpp +
+
+
+ + + FutureCpp + + + + + + + + + + + +
+
+
+ SafeCpp +
+
+
+ + + SafeCpp + + + + + + + + + + + +
+
+
+ Static Reflection with Serialization +
+
+
+ + + Static Reflectio... + + + + + + + + + + + +
+
+
+ Utils +
+
+
+ + + Utils + + + + + + + + + + + +
+
+
+ Logging Frontend +
+
+
+ + + Logging Fro... + + + + + + + + + + + +
+
+
+ S-CORE Architecture +
+
+
+ + + S-CORE Architecture + + + + + + + + + + + +
+
+
+ ADAS +
+
+
+ + + ADAS + + + + + + + + + + + +
+
+
+ ADASApplications / Functions +
+
+
+ + + ADASApplications / Functions + + + + + + + + + + + +
+
+
+ Fixed Execution Order (FEO) Framework +
+
+
+ + + Fixed Execution Order (FEO) F... + + + + + + + + + + + +
+
+
+ Telematics and Connectivity +
+
+
+ + + Telematics and Connectivity + + + + + + + + + + + +
+
+
+ Telematics & Connectivity Applications / Functions +
+
+
+ + + Telematics & Connectivity App... + + + + + + + + + + + +
+
+
+ TCU Framework +
+
+
+ + + TCU Framework + + + + + + + + + + + +
+
+
+ ... +
+
+
+ + + ... + + + + + + + + + + + +
+
+
+ Domain-Specific Applications / Functions +
+
+
+ + + Domain-Specific Applications... + + + + + + + + + + + +
+
+
+ Domain-Specific Framework +
+
+
+ + + Domain-Specific Framework + + + + + + + + + + + +
+
+
+ S-CORE v1.0 (proposal) +
+
+
+ + + S-CORE v1.0 (pro... + + + + + + + + + + + +
+
+
+ S-CORE v0.5 +
+
+
+ + + S-CORE v0.5 + + + + + + + + + + + +
+
+
+ Part of OS or HW specific implementation +
+
+
+ + + Part of OS or HW speci... + + + + + + + + + + + +
+
+
+ to be discussed for future releases +
+
+
+ + + to be discussed for... + + + + + + + + + + + +
+
+
+ Video API +
+
+
+ + + Video API + + + + + + + + + + + +
+
+
+ Crypto API +
+
+
+ + + Crypto API + + + + + + + + + + + +
+
+
+ HW Acceleration API +
+
+
+ + + HW Acceleration... + + + + + + + + + + + +
+
+
+ Persistency API +
+
+
+ + + Persistency API + + + + + + + + + + + +
+
+
+ Communication API +
+
+
+ + + Communication API + + + + + + + + + + + +
+
+
+ Lifecycle & Health API +
+
+
+ + + Lifecycle & Heal... + + + + + + + + + + + +
+
+
+ Configuration API +
+
+
+ + + Configuration API + + + + + + + + + + + +
+
+
+ Time API +
+
+
+ + + Time API + + + + + + + + + + + +
+
+
+ Logging API +
+
+
+ + + Logging API + + + + + + + + + + + +
+
+
+ Fault API +
+
+
+ + + Fault API + + + + + + + + + + + +
+
+
+ Runtime orchestrator API +
+
+
+ + + Runtime orchestr... + + + + + + + + + + + +
+
+
+ User / Capability management +
+
+
+ + + User / Capabilit... + + + + + + + + + + + +
+
+
+ Mandatory Access Control +
+
+
+ + + Mandatory Access... + + + + + + + + + + + +
+
+
+ Key / Certificate Mgmt +
+
+
+ + + Key / Certificat... + + + + + + + + + + + +
+
+
+ Intrusion Detection System +
+
+
+ + + Intrusion Detect... + + + + + + + + + + + +
+
+
+ Config Mgmt +
+
+
+ + + Config Mgmt + + + + + + + + + + + +
+
+
+ Storage Mgmt +
+
+
+ + + Storage Mgmt + + + + + + + + + + + +
+
+
+ Video Frame-server +
+
+
+ + + Video Frame-serv... + + + + + + + + + + + +
+
+
+ Fault Mgmt. +
+
+
+ + + Fault Mgmt. + + + + + + + + + + + +
+
+
+ Lifecycle & Health Mgmt +
+
+
+ + + Lifecycle & Heal... + + + + + + + + + + + +
+
+
+ HW Health Mgmt +
+
+
+ + + HW Health Mgmt + + + + + + + + + + + +
+
+
+ Logging / Data Collection +
+
+
+ + + Logging / Data C... + + + + + + + + + + + +
+
+
+ Software Update +
+
+
+ + + Software Update + + + + + + + + + + + +
+
+
+ Firewall +
+
+
+ + + Firewall + + + + + + + + + + + +
+
+
+ Tunneling +
+
+
+ + + Tunneling + + + + + + + + + + + +
+
+
+ zero-copy communication +
+
+
+ + + zero-copy commun... + + + + + + + + + + + +
+
+
+ SOME/IP Gateway +
+
+
+ + + SOME/IP Gateway + + + + + + + + + + + +
+
+
+ Any other Gateway +
+
+
+ + + Any other Gateway + + + + + + + + + + + +
+
+
+ Kernel +
+
+
+ + + Kernel + + + + + + + + + + + +
+
+
+ Time Sync +
+
+
+ + + Time Sync + + + + + + + + + + + +
+
+
+ Hardware Supervision +
+
+
+ + + Hardware Supervi... + + + + + + + + + + + +
+
+
+ Container Support +
+
+
+ + + Container Support + + + + + + + + + + + +
+
+
+ Video / Camera Support +
+
+
+ + + Video / Camera S... + + + + + + + + + + + +
+
+
+ Audio Support +
+
+
+ + + Audio Support + + + + + + + + + + + +
+
+
+ Peripheral Support +
+
+
+ + + Peripheral Suppo... + + + + + + + + + + + +
+
+
+ Ethernet (TCP/IP) +
+
+
+ + + Ethernet (TCP/IP) + + + + + + + + + + + +
+
+
+ AVB +
+
+
+ + + AVB + + + + + + + + + + + +
+
+
+ Board Support Package +
+
+
+ + + Board Support Pa... + + + + + + + + + + + +
+
+
+ Secure Boot +
+
+
+ + + Secure Boot + + + + + + + + + + + +
+
+
+ Hardware Acceleration Support +
+
+
+ + + Hardware Acceleration... + + + + + + + + + + + +
+
+
+ Hardware Security Support +
+
+
+ + + Hardware Securit... + + + + + + + + + + + +
+
+
+ Startup +
+
+
+ + + Startup + + + + + + + + + + + +
+
+
+ Inter-Partition Communication +
+
+
+ + + Inter-Partition... + + + + + + + + + + + +
+
+
+ Hardware Virtualization Support +
+
+
+ + + Hardware Virtualizatio... + + + + + + + + + + + +
+
+
+ Compiler +
+ (gcc, clang, rustc) +
+
+
+ + + Compiler... + + + + + + + + + + + +
+
+
+ Debugg & Trace +
+ (gdb, lldb, lttng ..) +
+
+
+ + + Debugg & Trace... + + + + + + + + + + + +
+
+
+ Testing +
+ (Unit, Integration, ...) +
+
+
+ + + Testing... + + + + + + + + + + + +
+
+
+ Analysis +
+ (Perf, SCAS, ...) +
+
+
+ + + Analysis... + + + + + + + + + + + +
+
+
+ Tools +
+ (IDE, Networking, …) +
+
+
+ + + Tools... + + + + + + + + + + + +
+
+
+ Collaboration +
+ (GitHub, …) +
+
+
+ + + Collaboration... + + + + + + + + + + + +
+
+
+ Simulation +
+ (OpenDUT, scenario, xIL) +
+
+
+ + + Simulation... + + + + + + + + + + + +
+
+
+ Automation +
+ (GitHub, …) +
+
+
+ + + Automation... + + + + + + + + + + + +
+
+
+ Non-converged system, e.g. IVI with Android +
+
+
+ + + Non-converged system,... + + + + + + + + + + + +
+
+
+ Apps +
+
+
+ + + Apps + + + + + + + + + + + +
+
+
+ API +
+
+
+ + + API + + + + + + + + + + + +
+
+
+ Platform +
+
+
+ + + Platform + + + + + + + + + + + +
+
+
+ OS +
+
+
+ + + OS + + + + + + + + + + + +
+
+
+ API with vendor specific dependency +
+
+
+ + + API with vendor spe... + + + + + + + + + + + +
+
+
+ Diagnostic Handler (SOVD, UDS) +
+
+
+ + + Diagnostic Handle... + + + + + + + + + + + +
+
+
+ Concurrency +
+
+
+ + + Concurrency + + + + + + + + + + + +
+
+
+ Memory +
+
+
+ + + Memory + + + + + + + + + + + +
+
+
+ Bit Manipulation +
+
+
+ + + Bit Manipulation + + + + + + + + + + + +
+
+
+ Containers +
+
+
+ + + Containers + + + + + + + + + + + +
+
+
+ JSON +
+
+
+ + + JSON + + + + + + + + + + + +
+
+
+ OS Abstraction +
+
+
+ + + OS Abstraction + + + + + + + + + + + +
+
+
+ Result +
+
+
+ + + Result + + + + + + + + + + + +
+
+
+ Binary compatible datatypes +
+
+
+ + + Binary compatible... + + + + + + + + + + + +
+
+
+ JSON +
+
+
+ + + JSON + + + + + + + + + + + +
+
+
+ Serialization +
+
+
+ + + Serialization + + + + + + + + + + + +
+
+
+ Hash +
+
+
+ + + Hash + + + + + + + + + + + +
+
+
+ Binary compatible datatypes +
+
+
+ + + Binary compatible... + + + + + + + + + + + +
+
+
+ OS Abstraction +
+
+
+ + + OS Abstraction + + + + + + + + + + + +
+
+
+ Artificial Intelligence +
+
+
+ + + Artificial Intelligence + + + + + + + + + + + +
+
+
+ AI based Functionalities +
+
+
+ + + AI based Functionalities + + + + + + + + + + + +
+
+
+ AI Framework +
+
+
+ + + AI Framework + + + + + + + + + + + +
+
+
+ System launch and monitor +
+
+
+ + + System launch an... + + + + + + + + + + Text is not SVG - cannot display + + + + diff --git a/docs/score_releases/_assets/architecture_0_6.drawio.svg b/docs/score_releases/_assets/architecture_0_6.drawio.svg new file mode 100644 index 00000000000..331c1f2cca2 --- /dev/null +++ b/docs/score_releases/_assets/architecture_0_6.drawio.svg @@ -0,0 +1,2307 @@ + + + + + + + + + + + + + + + + + + + + +
+
+
+ C++ Base Libraries +
+
+
+ + + C++ Base Libraries + + + + + + + + + + + +
+
+
+ Development Environment +
+
+
+ + + Development Environment + + + + + + + + + + + +
+
+
+ Platform API (native APIs for Rust and C++) +
+
+
+ + + Platform API (native APIs for Rust and C++) + + + + + + + + + + + +
+
+
+ System Services +
+
+
+ + + System Services + + + + + + + + + + + +
+
+
+ Communication +
+
+
+ + + Communication + + + + + + + + + + + +
+
+
+ Operating System +
+
+
+ + + Operating System + + + + + + + + + + + +
+
+
+ Hypervisor / Hardware +
+
+
+ + + Hypervisor / Hardware + + + + + + + + + + + +
+
+
+ Rust Base Libraries +
+
+
+ + + Rust Base Libraries + + + + + + + + + + + +
+
+
+ Filesystem +
+
+
+ + + Filesystem + + + + + + + + + + + +
+
+
+ FutureCpp +
+
+
+ + + FutureCpp + + + + + + + + + + + +
+
+
+ SafeCpp +
+
+
+ + + SafeCpp + + + + + + + + + + + +
+
+
+ Static Reflection with Serialization +
+
+
+ + + Static Reflectio... + + + + + + + + + + + +
+
+
+ Utils +
+
+
+ + + Utils + + + + + + + + + + + +
+
+
+ Logging Frontend +
+
+
+ + + Logging Fro... + + + + + + + + + + + +
+
+
+ Logging Frontend +
+
+
+ + + Logging Fro... + + + + + + + + + + + +
+
+
+ Containers +
+
+
+ + + Containers + + + + + + + + + + + +
+
+
+ Rust async runtime +
+
+
+ + + Rust async runti... + + + + + + + + + + + +
+
+
+ Network +
+
+
+ + + Network + + + + + + + + + + + +
+
+
+ S-CORE Architecture +
+
+
+ + + S-CORE Architecture + + + + + + + + + + + +
+
+
+ ADAS +
+
+
+ + + ADAS + + + + + + + + + + + +
+
+
+ ADASApplications / Functions +
+
+
+ + + ADASApplications / Functions + + + + + + + + + + + +
+
+
+ Fixed Execution Order (FEO) Framework +
+
+
+ + + Fixed Execution Order (FEO) F... + + + + + + + + + + + +
+
+
+ Telematics and Connectivity +
+
+
+ + + Telematics and Connectivity + + + + + + + + + + + +
+
+
+ Telematics & Connectivity Applications / Functions +
+
+
+ + + Telematics & Connectivity App... + + + + + + + + + + + +
+
+
+ TCU Framework +
+
+
+ + + TCU Framework + + + + + + + + + + + +
+
+
+ ... +
+
+
+ + + ... + + + + + + + + + + + +
+
+
+ Domain-Specific Applications / Functions +
+
+
+ + + Domain-Specific Applications... + + + + + + + + + + + +
+
+
+ Domain-Specific Framework +
+
+
+ + + Domain-Specific Framework + + + + + + + + + + + +
+
+
+ S-CORE v1.0 (proposal) +
+
+
+ + + S-CORE v1.0 (pro... + + + + + + + + + + + +
+
+
+ S-CORE v0.6 +
+
+
+ + + S-CORE v0.6 + + + + + + + + + + + +
+
+
+ Part of OS or HW specific implementation +
+
+
+ + + Part of OS or HW speci... + + + + + + + + + + + +
+
+
+ to be discussed for future releases +
+
+
+ + + to be discussed for... + + + + + + + + + + + +
+
+
+ Video API +
+
+
+ + + Video API + + + + + + + + + + + +
+
+
+ Crypto API +
+
+
+ + + Crypto API + + + + + + + + + + + +
+
+
+ HW Acceleration API +
+
+
+ + + HW Acceleration... + + + + + + + + + + + +
+
+
+ Persistency API +
+
+
+ + + Persistency API + + + + + + + + + + + +
+
+
+ Communication API +
+
+
+ + + Communication API + + + + + + + + + + + +
+
+
+ Lifecycle & Health API +
+
+
+ + + Lifecycle & Heal... + + + + + + + + + + + +
+
+
+ Configuration API +
+
+
+ + + Configuration API + + + + + + + + + + + +
+
+
+ Time API +
+
+
+ + + Time API + + + + + + + + + + + +
+
+
+ Logging API +
+
+
+ + + Logging API + + + + + + + + + + + +
+
+
+ Fault API +
+
+
+ + + Fault API + + + + + + + + + + + +
+
+
+ Runtime orchestrator API +
+
+
+ + + Runtime orchestr... + + + + + + + + + + + +
+
+
+ User / Capability management +
+
+
+ + + User / Capabilit... + + + + + + + + + + + +
+
+
+ Mandatory Access Control +
+
+
+ + + Mandatory Access... + + + + + + + + + + + +
+
+
+ Key / Certificate Mgmt +
+
+
+ + + Key / Certificat... + + + + + + + + + + + +
+
+
+ Intrusion Detection System +
+
+
+ + + Intrusion Detect... + + + + + + + + + + + +
+
+
+ Config Mgmt +
+
+
+ + + Config Mgmt + + + + + + + + + + + +
+
+
+ Storage Mgmt +
+
+
+ + + Storage Mgmt + + + + + + + + + + + +
+
+
+ Video Frame-server +
+
+
+ + + Video Frame-serv... + + + + + + + + + + + +
+
+
+ Fault Mgmt. +
+
+
+ + + Fault Mgmt. + + + + + + + + + + + +
+
+
+ Lifecycle & Health Mgmt +
+
+
+ + + Lifecycle & Heal... + + + + + + + + + + + +
+
+
+ HW Health Mgmt +
+
+
+ + + HW Health Mgmt + + + + + + + + + + + +
+
+
+ Logging / Data Collection +
+
+
+ + + Logging / Data C... + + + + + + + + + + + +
+
+
+ Software Update +
+
+
+ + + Software Update + + + + + + + + + + + +
+
+
+ Firewall +
+
+
+ + + Firewall + + + + + + + + + + + +
+
+
+ Tunneling +
+
+
+ + + Tunneling + + + + + + + + + + + +
+
+
+ zero-copy communication +
+
+
+ + + zero-copy commun... + + + + + + + + + + + +
+
+
+ SOME/IP Gateway +
+
+
+ + + SOME/IP Gateway + + + + + + + + + + + +
+
+
+ Any other Gateway +
+
+
+ + + Any other Gateway + + + + + + + + + + + +
+
+
+ Kernel +
+
+
+ + + Kernel + + + + + + + + + + + +
+
+
+ Time Sync +
+
+
+ + + Time Sync + + + + + + + + + + + +
+
+
+ Hardware Supervision +
+
+
+ + + Hardware Supervi... + + + + + + + + + + + +
+
+
+ Container Support +
+
+
+ + + Container Support + + + + + + + + + + + +
+
+
+ Video / Camera Support +
+
+
+ + + Video / Camera S... + + + + + + + + + + + +
+
+
+ Audio Support +
+
+
+ + + Audio Support + + + + + + + + + + + +
+
+
+ Peripheral Support +
+
+
+ + + Peripheral Suppo... + + + + + + + + + + + +
+
+
+ Ethernet (TCP/IP) +
+
+
+ + + Ethernet (TCP/IP) + + + + + + + + + + + +
+
+
+ AVB +
+
+
+ + + AVB + + + + + + + + + + + +
+
+
+ Board Support Package +
+
+
+ + + Board Support Pa... + + + + + + + + + + + +
+
+
+ Secure Boot +
+
+
+ + + Secure Boot + + + + + + + + + + + +
+
+
+ Hardware Acceleration Support +
+
+
+ + + Hardware Acceleration... + + + + + + + + + + + +
+
+
+ Hardware Security Support +
+
+
+ + + Hardware Securit... + + + + + + + + + + + +
+
+
+ Startup +
+
+
+ + + Startup + + + + + + + + + + + +
+
+
+ Inter-Partition Communication +
+
+
+ + + Inter-Partition... + + + + + + + + + + + +
+
+
+ Hardware Virtualization Support +
+
+
+ + + Hardware Virtualizatio... + + + + + + + + + + + +
+
+
+ Compiler +
+ (gcc, clang, rustc) +
+
+
+ + + Compiler... + + + + + + + + + + + +
+
+
+ Debugg & Trace +
+ (gdb, lldb, lttng ..) +
+
+
+ + + Debugg & Trace... + + + + + + + + + + + +
+
+
+ Testing +
+ (Unit, Integration, ...) +
+
+
+ + + Testing... + + + + + + + + + + + +
+
+
+ Analysis +
+ (Perf, SCAS, ...) +
+
+
+ + + Analysis... + + + + + + + + + + + +
+
+
+ Tools +
+ (IDE, Networking, …) +
+
+
+ + + Tools... + + + + + + + + + + + +
+
+
+ Collaboration +
+ (GitHub, …) +
+
+
+ + + Collaboration... + + + + + + + + + + + +
+
+
+ Simulation +
+ (OpenDUT, scenario, xIL) +
+
+
+ + + Simulation... + + + + + + + + + + + +
+
+
+ Automation +
+ (GitHub, …) +
+
+
+ + + Automation... + + + + + + + + + + + +
+
+
+ Non-converged system, e.g. IVI with Android +
+
+
+ + + Non-converged system,... + + + + + + + + + + + +
+
+
+ Apps +
+
+
+ + + Apps + + + + + + + + + + + +
+
+
+ API +
+
+
+ + + API + + + + + + + + + + + +
+
+
+ Platform +
+
+
+ + + Platform + + + + + + + + + + + +
+
+
+ OS +
+
+
+ + + OS + + + + + + + + + + + +
+
+
+ API with vendor specific dependency +
+
+
+ + + API with vendor spe... + + + + + + + + + + + +
+
+
+ Diagnostic Handler (SOVD, UDS) +
+
+
+ + + Diagnostic Handle... + + + + + + + + + + + +
+
+
+ Concurrency +
+
+
+ + + Concurrency + + + + + + + + + + + +
+
+
+ Memory +
+
+
+ + + Memory + + + + + + + + + + + +
+
+
+ Bit Manipulation +
+
+
+ + + Bit Manipulation + + + + + + + + + + + +
+
+
+ Containers +
+
+
+ + + Containers + + + + + + + + + + + +
+
+
+ JSON +
+
+
+ + + JSON + + + + + + + + + + + +
+
+
+ OS Abstraction +
+
+
+ + + OS Abstraction + + + + + + + + + + + +
+
+
+ Result +
+
+
+ + + Result + + + + + + + + + + + +
+
+
+ Binary compatible datatypes +
+
+
+ + + Binary compatible... + + + + + + + + + + + +
+
+
+ JSON +
+
+
+ + + JSON + + + + + + + + + + + +
+
+
+ Serialization +
+
+
+ + + Serialization + + + + + + + + + + + +
+
+
+ Hash +
+
+
+ + + Hash + + + + + + + + + + + +
+
+
+ Binary compatible datatypes +
+
+
+ + + Binary compatible... + + + + + + + + + + + +
+
+
+ OS Abstraction +
+
+
+ + + OS Abstraction + + + + + + + + + + + +
+
+
+ Artificial Intelligence +
+
+
+ + + Artificial Intelligence + + + + + + + + + + + +
+
+
+ AI based Functionalities +
+
+
+ + + AI based Functionalities + + + + + + + + + + + +
+
+
+ AI Framework +
+
+
+ + + AI Framework + + + + + + + + + + + +
+
+
+ System launch and monitor +
+
+
+ + + System launch an... + + + + + + + + + + Text is not SVG - cannot display + + + + diff --git a/docs/score_releases/_assets/score_process_area_overview.drawio.svg b/docs/score_releases/_assets/score_process_area_overview.drawio.svg new file mode 100644 index 00000000000..6bfc2a76b5f --- /dev/null +++ b/docs/score_releases/_assets/score_process_area_overview.drawio.svg @@ -0,0 +1,4 @@ + + + +







Process Areas - Support










 
Process Areas - Support...




Process Areas - Development










 
Process Areas - Development...
Introduction
Introduction









Process Areas - Management












 
Process Areas - Management...
Requirements
Engineering
Requirements...
Safety
Management
Safety...
Change Management
Change Managem...
Documentation
Management
Documentation...
General Concepts
General Concepts
Standards
Standards
Roles
Roles


Architecture



Architecture...

Imple-mentation
(Detailed Design,
Coding)
Imple-mentatio...
Problem Resolution
Problem Resolu...
ML 4
ML 4
ML 2
ML 2
ML 1
ML 1
Verification

Verification...
Configuration
Management
Configuration...
Tool
Management
Tool...
Quality
Management
Quality...
Platform
Management
Platform...
Maturity Level
Maturity Level
ML 0
ML 0

Safety
Analysis

Safety...
Work Products
Work Products
Workflows
Workflows
ML 3
ML 3
Plan - 
Process definition planned
Documents not available or most empty
Plan -...
Initial - 
Process definition in place, but not yet compliant, consistency across S-CORE platform, modules and repeatability of processes may not be possible.
Documents are mostly available, main parts done, principles clear, all top level questions addressed, well structured.
Initial -...
Managed -
Process definition in place but not yet deployed in S-CORE, but execution would allow consistency across S-CORE platform and modules, repeatability of processes possible
Documents are complete, documented on a comprehensible systematic approach, verified, only minor questions open, Process requirements (of highest priority) enforced by implemented Tool Requirements (or a feasible manual work around is defined).
Managed -...
Defined/Practiced - 
Deployed (at least once) in S-CORE platform or one Module, The processes have been practiced, and evidence exists to demonstrate that this has occurred. 
Documents are complete, verified and released, Process Requirements (of high/ medium priority) enforced by implemented Tool Requirements, Tool evaluation performed
 Initial Safety Audit passed.
Defined/Practiced -...
Improving - 
Deployed on S-CORE platform and various S-CORE Modules and constantly improving, using suitable process metrics, S-CORE commiter control the effectiveness and performance of the platform and modules and demonstrate continuous improvement in these areas. Tool qualification available.
Improving -...
Release
Management
Release...
Trustable
Trustable
Folder Templates
Folder Templates
Security
Management
Security...
Security
Analysis
Security...Text is not SVG - cannot display diff --git a/docs/score_releases/index.rst b/docs/score_releases/index.rst new file mode 100644 index 00000000000..80a4c325cbf --- /dev/null +++ b/docs/score_releases/index.rst @@ -0,0 +1,11 @@ +S-CORE Release Notes +==================== + + +.. toctree:: + :maxdepth: 1 + + release_note_score_v0_7.rst + release_note_score_v0_6.rst + release_note_score_v0_5_beta.rst + release_note_score_v0_5_alpha.rst diff --git a/docs/score_releases/release_note_score_v0_5_alpha.rst b/docs/score_releases/release_note_score_v0_5_alpha.rst new file mode 100644 index 00000000000..1cf9ea78919 --- /dev/null +++ b/docs/score_releases/release_note_score_v0_5_alpha.rst @@ -0,0 +1,271 @@ +.. + # ******************************************************************************* + # Copyright (c) 2025 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 + # ******************************************************************************* + +S-CORE Platform v0.5-alpha release note +======================================= + +.. document:: S-Core v0.5-alpha release note + :id: doc__score_v05_alpha_release_note + :status: valid + :safety: ASIL_B + :security: YES + :realizes: wp__platform_sw_release_note + +| **Platform Name**: S-CORE +| **Release Tag**: v0.5.0-alpha +| **Origin Release Tag**: none - first published release +| **Release Date**: 2025-11-17 + +Overview +^^^^^^^^^ +This is the first published release of the **Eclipse S-CORE platform** (v0.5.0-alpha). It brings +together the initial set of core modules, reference integrations, and supporting infrastructure needed to +build and run example applications such as the `scrample `_ +demo on multiple target images. The software architecture and implemented modules are illustrated in the diagram below. + +This release of Eclipse S-CORE is an early alpha version intended solely for experimentation, test driving project processes, gaining experience in release creation and soliciting feedback. +Please be aware, that features may be incomplete, the software may exhibit instability or unexpected behavior, and breaking changes and alterations in scope are likely as development progresses. + + +.. image:: _assets/architecture.drawio.svg + :width: 1000 + :alt: Architecture overview + :align: center + +| + +Highlights +----------- +- First public alpha of the Eclipse S-CORE platform. +- Reference integration including the *scrample* demo application. +- Initial set of communication, persistency, orchestration, and base utility modules. +- Experimental reference images for QNX, Red Hat AutoSD Linux, and EB corbos Linux for Safety Applications. + +Eclipse S-CORE book +------------------- +The first version of the `Eclipse S-CORE book `_ +is a “how-to” guide for users getting started with the project. +It introduces the core concepts of Eclipse S-CORE and walks through building +the ``scrample`` application step by step on top of the platform modules. + +Improvements +^^^^^^^^^^^^^ +This release introduces the initial integrated platform with the modules listed below. +For module-specific improvements, refer to the release notes in each module repository. + +Bug Fixes +^^^^^^^^^^^^ +Bug fixes are tracked and documented per module. Please see the corresponding module +release notes for details on fixed issues in this release. + +Integrated Software Modules +----------------------------- + +Communication +~~~~~~~~~~~~~ +Zero-copy, shared-memory based inter-process communication for minimal-latency intra-ECU messaging. + +- **Version:** ``communication v0.1.1`` +- **Source / tag:** `Communication GitHub release `_ +- **Release notes:** :need:`doc__communication_release_note` + +Fixed Execution Order Framework(FEO) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Application Framework which is intended to support data-driven or time-driven applications. + +- **Link to release**: ``feo v1.0.2`` +- **Source / tag:** `FEO GitHub release `_ +- **Release notes**: + - A framework for applications (not for platform services) + - For data-driven and time-driven applications (mainly in the ADAS domain) + - Support fixed execution order + - Supporting reprocessing + + - `Read more on scope. `__ + - `Check out the examples. `__ + +Baselibs +~~~~~~~~~~~~~ +Selection of basic C++ utility libraries for common use in the S-CORE project + +- **Version:** ``baselibs v0.1.3`` +- **Source / tag:** `Baselibs GitHub release `_ +- **Release notes**: `Baselibs release notes `_ + + +Persistency +~~~~~~~~~~~~~ +Ensures long-term storage and retrieval of data and provides a reliable mechanism for +preserving application state and data integrity over time. + +- **Version:** ``persistency v0.2.1`` +- **Source / tag:** `Persistency GitHub release `_ +- **Notes**: + + - `The feature requirements and architecture `_ and + `component requirements and architecture `_ documents are partially out of date + and will be updated in the next release. + - See the full `persistency release notes `_ for details + + +Orchestrator (Kyron and orchestration framework) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Provides: + +- **Kyron** – an async runtime for Rust, designed for high-performance async/await execution + with functional safety in mind. It offers fine-grained control over scheduling, thread management, + and workload isolation via configurable execution engines. +- **Orchestrator** – a framework to build task chains with deterministic execution flow. + It lets developers describe cause–effect chains, timing constraints, and error handling in a + platform-independent way while keeping application logic separate from deployment and + resource management. + +- **Version:** ``orchestrator v0.0.3`` +- **Source / tag:** `Orchestrator GitHub release `_ +- **Further reading**: + + - `Kyron scope and design `__ + - `Kyron examples `__ + - `Orchestrator scope and design `__ + - `Orchestrator examples `__ + + +Reference integration +~~~~~~~~~~~~~~~~~~~~~~ +Central integration of Eclipse S-CORE modules + +- **Version:** ``reference integration v0.5.0-alpha`` +- **Source / tag:** `Reference Integration GitHub release `_ + +Common ++++++++ +- Integrates all v0.5 modules, including the ``scrample`` demo application. +- Provides CI/CD workflows to ensure stability of the reference integration: + + - `Build and test on every PR `_ + - `Test integration `_ + build all functional modules of Eclipse S-Core v0.5 and execute multiple tests to ensure stability of the reference integration for every pr and on every release creation. + - Offers `complete documentation `_ of all modules. + +Reference QNX image ++++++++++++++++++++++ +- Provides a QNX `x86_64` QEMU image; see `reference integration README `_ + for usage instructions. +- `Release verification workflow `_ runs multiple integration tests + on the QNX image during release creation. +- Provides `basic ITF tests `_. + see the documented `build commands `_ for running ITF tests locally. + +Reference Red Hat AutoSD Linux image (Experimental) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +- Provides a Linux-based AutoSD image usable with QEMU for both `x86_64` and `aarch64`; for usage see `AutoSD README `_ +- Integrates IPC tests (equivalent functionality to the ``scrample`` example) using the QM environment. +- A dedicated `build_and_test_autosd `_ execute these tests. +- **Note**: The AutoSD Linux integration is experimental and does not yet follow the full S-CORE process. Bazel integration is still missing and will be + addressed in upcoming releases. + +Reference Elektrobit corbos Linux for Safety Applications Linux image (Experimental) +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +- Demonstrates Eclipse S-CORE running on Elektrobit corbos Linux for Safety Applications (EBcLfSA). +- Integrates the ``scrample`` demo application into the "fast-dev" EBcLfSA image (aarch64). +- In the `related CI workflow `_, + all these steps are performed, and the resulting log files are stored and made available for download. +- Integration can be executed via QEMU; see the `EBcLfSA README `_ for details. +- **Note**: The EBcLfSA integration is experimental. Bazel integration exists, but parts of the integration code will be reworked in future releases. + +Associated Infrastructure Modules +----------------------------------- + +process_description +~~~~~~~~~~~~~~~~~~~~~~~ +Provides a process model establishing organisational rules for developing open source software +in the automotive domain, suitable for safety and security contexts. + +- **Version:** ``process description v0.1.3`` +- **Standards alignment:** + + - ASPICE 4.0 + - ISO 26262 + - ISO 21434 + - ISO PAS 8926 + +- **Release notes**: `process_description release notes `_ + +docs-as-code +~~~~~~~~~~~~~~ +Tooling for linking and generation of documentation. + +- **Version:** ``docs-as-code v2.0.2`` +- **Source / tag:** `docs-as-code GitHub release `_ + +tooling +~~~~~~~~~~~~~~ +Tooling for S-CORE development. + +- **Version:** ``tooling v1.0.2`` +- **Source / tag:** `tooling GitHub release `_ + +ITF (Integration Testing Framework) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Framework for executing feature integration tests on the reference image. + +- **Version:** ``itf v0.1.0`` +- **Source / tag:** `ITF GitHub release `_ +- **Capabilities:** + - Bazel macro *py_itf_test* + - Pinging target + - SSH and SPTP module + - DLT module + - Starting Qemu from the `reference_integration `_ repository + - **Documentation:** + - `ITF README `_ + - `reference_integration README `_ + +Test Scenarios +~~~~~~~~~~~~~~~ +Testing framework providing a backend for parametrizable scenarios in Rust and C++, usable in +common test case implementations and parallel implementations. + +- **Version:** ``test_scenarios v0.3.0`` +- **Source / tag:** `Test Scenarios `_ +- **Components:** + - ``test_scenarios_cpp`` – C++ framework for defining, running, and managing test scenarios. + - ``test_scenarios_rust``– equivalent implementation in Rust. +- Both frameworks share the same concepts and support automated testing, scenario grouping, + and integration with CLI tools. + +Performed Verification +---------------------- +The following tests were executed as part of this release: + +- All C++ modules built successfully with GCC and QCC toolchains. +- All Rust modules built successfully with the Rust toolchain. +- Each module executed its unit tests. +- Basic integration tests were executed on the reference QNX image in QEMU via the + `release verification `_ workflow +- for **persistency** and **orchestration** modules, component and feature integration tests were executed using the ``score-test-scenarios`` framework; see + `feature_showcase `_ and + `feature_integration_tests `_ for more details. + +Known Issues +---------------------- +- see release notes of every module seperately + +Upgrade Instructions +---------------------- +- none, first published release. + +Contact Information +---------------------- +For any questions or support, please contact the *Project lead* or raise an issue/discussion. diff --git a/docs/score_releases/release_note_score_v0_5_beta.rst b/docs/score_releases/release_note_score_v0_5_beta.rst new file mode 100644 index 00000000000..f9b51026a32 --- /dev/null +++ b/docs/score_releases/release_note_score_v0_5_beta.rst @@ -0,0 +1,330 @@ +.. + # ******************************************************************************* + # Copyright (c) 2025 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 + # ******************************************************************************* + +S-CORE Platform v0.5-beta release note +====================================== + +.. document:: S-Core v0.5-beta release note + :id: doc__score_v0_5_beta_release_note + :status: draft + :safety: ASIL_B + :security: YES + :realizes: wp__platform_sw_release_note + +| **Platform Name**: S-CORE +| **Release Tag**: v0.5.0-beta +| **Origin Release Tag**: v0.5.0-alpha +| **Release Date**: 2025-12-19 + +Overview +^^^^^^^^^ +This is the second milestone build of the **Eclipse S-CORE platform** (v0.5.0-beta). It brings +together the initial set of core modules, reference integrations, and supporting infrastructure needed to +build and run example applications such as the `scrample `_ +demo on multiple target images. The software architecture and implemented modules are illustrated in the diagram below. + +This release of Eclipse S-CORE is an early beta version intended solely for experimentation, test driving project processes, gaining experience in release creation and soliciting feedback. +Please be aware, that features may be incomplete, the software may exhibit instability or unexpected behavior, and breaking changes and alterations in scope are likely as development progresses. + + +.. image:: _assets/architecture.drawio.svg + :width: 1000 + :alt: Architecture overview + :align: center + + +| + +Highlights +----------- + +Eclipse S-CORE book +------------------- +The `Eclipse S-CORE book `_ +is a “how-to” guide for users getting started with the project or who want to contribute new modules. +It introduces the core concepts of Eclipse S-CORE and walks through building +the ``scrample`` application step by step on top of the platform modules. +It also includes a tutorial for the first application on top of the existing modules. + + +Improvements +^^^^^^^^^^^^^ +Main focus of this release is to improve the overall stability and performance of the platform, as well as to enhance the usability. +This does include + +- Static code analysis with CodeQL MISRA C++ 2023: `release link `. +- Execution of Unit tests as part of the Reference Integration `test_integration workflow `_. +- Unit-test coverage measurement results are now automatically part of Release Assests for every component: **//TODO:** link to an example. +- A new combined build toolchain of qcc and gcc, see `bazel-cpp-toolchain `_. +- Improved doc-as-code and process description +- `bazel_tools_cc `_ introduces a clang-tidy integration into S-CORE bazel infrasturture: + + - Check exhaustive `bazel_tools_cc README `_ and an + `example project `_ for instructions how to set-up + clang-tidy checks for your module + - In the upcoming releases clang-tidy will be extended with custom S-CORE checks to meet necessary process requirements. +- Platform functionality was extended with `logging daemon `_. + + +S-CORE Platform +^^^^^^^^^^^^^^^^^^ + +- **Version:** ``score v0.5.2`` +- **Source / tag:** `S-CORE Platform GitHub release `_ +- **Release notes**: `S-CORE Platform release notes `_ + + + +Integrated Software Modules +----------------------------- + +Baselibs +~~~~~~~~~~~~~ +Selection of basic C++ utility libraries for common use in the S-CORE project + +- **Version:** ``baselibs v0.2.2`` +- **Source / tag:** `Baselibs GitHub release `_ +- **Release notes**: `Baselibs release notes `_ + + +Communication +~~~~~~~~~~~~~ +Zero-copy, shared-memory based inter-process communication for minimal-latency intra-ECU messaging. + +- **Version:** ``communication v0.1.2`` +- **Source / tag:** `Communication GitHub release `_ +- **Release notes:** :need:`doc__communication_release_note` + +**Improvements** + +- Enabled various code quality tools +- Extension of the Rust API (expect further extensive work on this API) +- Support explicit setting of application id in configuration (with fallback to PID) + +Fixed Execution Order Framework(FEO) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +- **Version:** ``feo v0.1.2`` +- **Source / tag:** `Communication GitHub release `_ +- **Stays at v0.5-alpha** + + +Persistency +~~~~~~~~~~~~~ +Ensures long-term storage and retrieval of data and provides a reliable mechanism for +preserving application state and data integrity over time. + +- **Version:** ``persistency v0.2.2`` +- **Source / tag:** `Persistency GitHub release `_ + +.. _logging_daemon_v0_5_beta: + +Logging Daemon +~~~~~~~~~~~~~~~~~~ + +**Improvements** + +The Eclipse SCORE Logging module provides a comprehensive logging framework for automotive embedded systems, +featuring remote DLT (Diagnostic Log and Trace) capabilities with +lock-free communication between applications and the datarouter daemon. + +This is the initial open-source release of the logging framework, +consolidating the complete project structure with build system, dependencies, +and tooling for integration into Eclipse SCORE projects. + +The module is designed for Bazel-based builds and provides both the middleware logging +library (score/mw/log) that includes all supported recorders with respective backends and +the datarouter daemon (score/datarouter). The shared memory implementation between the middleware +library and datarouter daemon guarantees Freedom From Interference (FFI), +enabling safe logging from real-time and safety-critical contexts. + +- **Version:** ``logging v0.0.3`` +- **VSource / tag:** `logging release `__ +- **Further reading:**: See below + + - `Logging release notes `__ + - `Logging ReadMe `__ + + +Orchestrator +~~~~~~~~~~~~~ + +**Improvements** + +- Support `log` frontend exchange to: `log`, `tracing` or `score-log` (not yet implemented in this release) +- Increased CIT coverage and stability improvements +- Split of kyron into separate repositories: `orchestrator` and `kyron` + +:Version: ``orchestrator v0.0.4`` +:Source / tag: `Orchestrator GitHub release `__ +:Further reading: See below + + - `Orchestrator scope and design `__ + - `Orchestrator examples `__ + + +Kyron +~~~~~~~~~~~~~~ + +**Improvements** + +- Support `log` frontend exchange to: `log`, `tracing` or `score-log` (not yet implemented in this release) +- Increased CIT coverage and stability improvements +- Split of kyron into separate repositories: `orchestrator` and `kyron` + +:Version: ``kyron v0.0.3`` +:Source / tag: `Kyron GitHub release `__ +:Further reading: See below + + - `Kyron scope and design `__ + - `Kyron examples `__ + + +Reference integration +~~~~~~~~~~~~~~~~~~~~~~ +Central integration of Eclipse S-CORE modules + +- **Version:** ``reference integration v0.5.0-beta`` +- **Source / tag:** `Reference Integration GitHub release `_ + + +Reference QNX image ++++++++++++++++++++++ +- No changes compared to the previous software version. + +Reference Red Hat AutoSD Linux image (Experimental) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +- Uses AutoSD's toolchain to build and generate Lola RPMs +- Deploy RPMs into an AutoSD Image + +Pull requests: + +https://github.com/eclipse-score/reference_integration/pull/56 +https://github.com/eclipse-score/inc_os_autosd/pull/16 + + +Reference Elektrobit corbos Linux for Safety Applications Linux image (Experimental) +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +**Improvements** + +- New ``fastdev`` base image snapshot and corresponding toolchain which include latest security patches and updates. +- Updated packages avoid misleading errors during image start and shutdown, which could be confusing for users. + +Associated Infrastructure Modules +----------------------------------- + +process_description +~~~~~~~~~~~~~~~~~~~ +Provides a process model establishing organizational rules for developing open source software +in the automotive domain, suitable for safety and security contexts. + +- **Version:** ``process description v1.4.0`` +- **Standards alignment:** + + - ASPICE 4.0 + - ISO 26262 + - ISO 21434 + - ISO PAS 8926 + +- **Release notes**: `process_description release notes `_ +- **Process maturity overview**: + +.. figure:: _assets/score_process_area_overview.drawio.svg + :width: 100% + :align: center + :alt: Process area overview for the **Project** + +For more details please refer to +`Documentation Management Plan `_, that +provides process workproduct level overview for every software module and process area. + + +docs-as-code +~~~~~~~~~~~~~~ +Tooling for linking and generation of documentation. + +- **Version:** ``docs-as-code v2.2.0`` +- **Source / tag:** `docs-as-code GitHub release `_ + +tooling +~~~~~~~~~~~~~~ +Tooling for S-CORE development. + +- **Version:** ``tooling v1.0.4`` +- **Source / tag:** `tooling GitHub release `_ + + +ITF (Integration Testing Framework) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +- **Improvements** + + - Improved ITF `user documentation `_ + +- **Version:** ``itf v0.1.0`` +- **Source / tag:** `ITF GitHub release `_ + +Test Scenarios +~~~~~~~~~~~~~~~ +- **Improvements** + + - Refactor tracing subscriber by externalizing it's initialization + - Remove baselibs dependency from C++ scenarios in JSON parsing + +- **Version:** ``Test Scenarios v0.3.1`` +- **Source / tag:** `Test Scenarios GitHub release `_ + +.. _bazel_cpp_toolchain_v0_5_beta: + +Bazel CPP Toolchain +~~~~~~~~~~~~~~~~~~~~ +- **What is in** + + - support for following platform configurations: *x86_64_linux*, *x86_64_qnx*, *arm64_qnx* + - complete feature flag set for the host toolchain (*x86_64_linux*): *minimal*, *strict*, *all_warnings* + +- **What is not in** + + - feature flag set for the target toolchain (infrastructure is already set-up) + - arm64_linux configuration is missing + +- **Version:** ``bazel_cpp_toolchains v0.1.0`` +- **Source / tag:** `Bazel CPP Toolchain release `_ +- **Release notes**: `Bazel CPP Toolchain release notes `_ + +Performed Verification +---------------------- +The following tests were executed as part of this release: + +- All C++ modules built successfully with GCC and QCC toolchains. +- All Rust modules built successfully with the Rust toolchain. +- Each module executed its unit tests. +- Basic integration tests were executed on the reference QNX image in QEMU via the + `release verification `_ workflow +- for **persistency** and **orchestration** modules, component and feature integration tests were executed using the ``score-test-scenarios`` framework; see + `feature_showcase `_ and + `feature_integration_tests `_ for more details. +- Static code analysis of all dependencies with CodeQL MISRA C++2023 package. The results you can find here: https://github.com/eclipse-score/reference_integration/actions/workflows/codeql-multiple-repo-scan.yml + +Known Issues +---------------------- +- see release notes of every module separately + +Upgrade Instructions +---------------------- +- Increase to newest bazel registry versions: https://github.com/eclipse-score/bazel_registry/tree/main/modules + + +Contact Information +---------------------- +For any questions or support, please contact the *Project lead* or raise an issue/discussion. diff --git a/docs/score_releases/release_note_score_v0_6.rst b/docs/score_releases/release_note_score_v0_6.rst new file mode 100644 index 00000000000..fd35ae90df1 --- /dev/null +++ b/docs/score_releases/release_note_score_v0_6.rst @@ -0,0 +1,321 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +S-CORE Platform v0.6 release note +================================= + +.. document:: S-CORE v0.6 release note + :id: doc__score_v0_6_release_note + :status: draft + :safety: QM + :security: YES + :realizes: wp__platform_sw_release_note + +| **Platform Name**: S-CORE +| **Release Tag**: v0.6.0 +| **Origin Release Tag**: v0.5.0-beta +| **Release Date**: 2026-02-23 + +Overview +^^^^^^^^^ +This is the third milestone build of the **Eclipse S-CORE platform** (v0.6.0). It brings +together the initial set of core modules, reference integrations, and supporting infrastructure needed to +build and run example applications such as the `scrample `_ +demo on multiple target images. The software architecture and implemented modules are illustrated in the diagram below. + +This release of Eclipse S-CORE is an early beta version intended solely for experimentation, test driving project processes, gaining experience in release creation and soliciting feedback. +Please be aware, that features may be incomplete, the software may exhibit instability or unexpected behavior, and breaking changes and alterations in scope are likely as development progresses. + + +.. image:: _assets/architecture_0_6.drawio.svg + :width: 1000 + :alt: Architecture overview + :align: center + + +Highlights +----------- + +Eclipse S-CORE book +------------------- +The `Eclipse S-CORE book `_ +is a “how-to” guide for users getting started with the project or who want to contribute new modules. + + +Improvements +^^^^^^^^^^^^^ + + +S-CORE Platform +^^^^^^^^^^^^^^^^^^ + +- **Version:** ``score v0.5.4`` +- **Release notes**: `S-CORE Platform release notes `_ + + + +Integrated Software Modules +----------------------------- + +Baselibs +~~~~~~~~~~~~~ +Selection of basic C++ utility libraries for common use in the S-CORE project + +- **Version:** ``baselibs v0.2.4`` +- **Release notes**: `Baselibs release notes `_ + +Baselibs Rust +~~~~~~~~~~~~~ + +Selection of basic Rust utility libraries for common use in the S-CORE project + +- **Version:** ``baselibs_rust v0.1.0`` +- **Release notes**: `Baselibs Rust release notes `_ + + +**Improvements** + +- `score_log` - logging frontend for S-CORE +- `containers`- common containers with different allocation and layout techniques including ABI compatible versions for inter-process communication +- `sync` - `std::sync` extensions utilities + +Communication +~~~~~~~~~~~~~ +Zero-copy, shared-memory based inter-process communication for minimal-latency intra-ECU messaging. + +- **Version:** ``communication v0.1.3`` +- **Release notes**: `Communication release notes `_ + +**Improvements** + +- Enabled various code quality tools +- Extension of the Rust API (expect further extensive work on this API) +- Support explicit setting of application id in configuration (with fallback to PID) + + +Persistency +~~~~~~~~~~~ +Ensures long-term storage and retrieval of data and provides a reliable mechanism for +preserving application state and data integrity over time. + +- **Version:** ``persistency v0.3.0`` +- **Release notes**: `Persistency release notes `_ + +**Improvements** + +- New backend API for Rust +- Testing improvements, including: + - Additional C++ CIT tests, code quality improvements, tests logging. +- Tooling improvements, including: + - Improved formatting, Rust linting. +- Aligned snapshot count behavior between C++ and Rust implementations. +- Adapted Ferrocene toolchain for Rust. +- Updated utilized toolchains, updated S-CORE dependencies. + +Logging +~~~~~~~ + +**Improvements** + +The Eclipse S-CORE Logging module provides a logging framework for automotive embedded systems, +featuring remote DLT (Diagnostic Log and Trace) capabilities with +lock-free communication between applications and the datarouter daemon. + +- **Version:** ``logging v0.1.0`` +- **Release notes**: `Logging release notes `_ + +Orchestrator +~~~~~~~~~~~~~ +Orchestrator module provides a framework for defining and executing complex workflows and task sequences in a coordinated manner. + +- **Version:** ``orchestrator v0.1.0`` +- **Release notes**: `Orchestrator release notes `_ + +**Improvements** + +- Adapted toolchain to ferrocene for Rust +- Support qnx-x86_64 +- Examples now run in reference integration repository images + +:Further reading: See below + + - `Orchestrator scope and design `__ + - `Orchestrator examples `__ + + +Kyron +~~~~~~~~~~~~~~ +Kyron is a customizable, high-performance async/await runtime designed for advanced concurrent programming with focus on functional safety. +It allows fine-grained control over scheduling, thread management, and workload isolation through configurable execution engines. + +- **Version:** ``kyron v0.1.1`` +- **Release notes**: `Kyron release notes `_ + +**Improvements** + +- Adapted toolchain to ferrocene for Rust +- Support qnx-x86_64 +- Integrated rust coverage reporting +- Improved up to 8% runtime time with task scheduler fixes +- Examples now run in reference integration repository images + +**Bugfix** + +- Minor bugfixes listed in github + +**Known issues** + +- Ongoing fixing of safety wakes `here `_ + +:Further reading: See below + + - `Kyron scope and design `__ + - `Kyron examples `__ + + +Lifecycle & Health Management +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Lifecycle module provides a Launch Manager for process lifecycle management as well as a Health Monitoring library to support supervision of process behavior. + +- **Version:** ``lifecycle v0.1.0`` +- **Release notes**: `Lifecycle release notes `_ + +**Improvements** + +- Health Monitoring library for applications with Rust and C++ API + - Deadline Monitoring support +- Initial version of Launch Manager with mw::lifecycle API + - The previously separate daemon processes launch_manager and health_monitor are now merged into a single launch_manager daemon process +- Working integration of Launch Manager and Health Monitoring library + + +Reference integration +~~~~~~~~~~~~~~~~~~~~~~ +Central integration of Eclipse S-CORE modules + +- **Version:** ``reference integration v0.6.0`` +- **Source / tag:** `Reference Integration GitHub release `_ + +**Improvements** +- Unify handling of images in repository +- Execute all images build and tests in CI +- Execute UT, Coverage in CI and produce documentation with results +- Provide `./score_starter` helper program to allow easily run given image without hassle +- Provide interactive example selection menu on target image so user can choose examples to run and see the results +- Remove separate bazel modules and use single bazel module with always aligned dependencies + +Reference QNX image ++++++++++++++++++++++ +- No changes compared to the previous software version. + +Reference Red Hat AutoSD Linux image (Experimental) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +**Improvements** + +- Remove unused packages to reduce image size +- Move AutoSD images to use Bootc (image mode) +- Integrate AutoSD's Bazel toolchain to build reference integration showcases + + +Reference Elektrobit corbos Linux for Safety Applications Linux image (Experimental) +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +- Updates to follow the latest integration structure and dependencies. +- No functional changes compared to the previous software version. + +Associated Infrastructure Modules +----------------------------------- + +process_description +~~~~~~~~~~~~~~~~~~~ +Provides a process model establishing organizational rules for developing open source software +in the automotive domain, suitable for safety and security contexts. + +- **Standards alignment:** + + - ASPICE 4.0 + - ISO 26262 + - ISO 21434 + - ISO PAS 8926 + +- **Version:** ``process description v1.4.3`` +- **Release notes**: `process_description release notes v1.4.x `_ +- **Process maturity overview**: + +.. figure:: _assets/score_process_area_overview.drawio.svg + :width: 100% + :align: center + :alt: Process area overview for the **Project** + +For more details please refer to +`Documentation Management Plan `_, that +provides process workproduct level overview for every software module and process area. + + +docs-as-code +~~~~~~~~~~~~~~ +Tooling for linking and generation of documentation. + +- **Version:** ``docs-as-code v3.0.1`` +- **Source / tag:** `docs-as-code GitHub release `_ + +tooling +~~~~~~~~~~~~~~ +Tooling for S-CORE development. + +- **Version:** ``tooling v1.1.2`` +- **Source / tag:** `tooling GitHub release `_ + + +ITF (Integration Testing Framework) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +- **Improvements** + + - Improved ITF `user documentation `_ + +- **Version:** ``itf v0.1.0`` +- **Source / tag:** `ITF GitHub release `_ + +Test Scenarios +~~~~~~~~~~~~~~~ +Test scenarios provide a backend for defining C++ and Rust implemented test scenarios that allow parametrized execution of built scenario applications which are the input for test cases. + +- **Improvements** + - Adapted new toolchains for C++ and Rust + +- **Version:** ``Test Scenarios v0.4.0`` +- **Source / tag:** `Test Scenarios GitHub release `_ + + + +Bazel CPP Toolchain +~~~~~~~~~~~~~~~~~~~~ +- **Version:** ``bazel_cpp_toolchains v0.2.2`` +- **Release notes**: `Bazel CPP Toolchain release notes `_ + + +Known Issues +---------------------- +- see release notes of every module separately + +Upgrade Instructions +---------------------- +- Increase to newest bazel registry versions: https://eclipse-score.github.io/bazel_registry_ui +- Versions can be found under: https://github.com/eclipse-score/reference_integration/blob/main/known_good.json + +Contact Information +---------------------- +For any questions or support, please contact the *Project leads* or raise an issue/discussion. +https://projects.eclipse.org/projects/automotive.score diff --git a/docs/score_releases/release_note_score_07.rst b/docs/score_releases/release_note_score_v0_7.rst similarity index 97% rename from docs/score_releases/release_note_score_07.rst rename to docs/score_releases/release_note_score_v0_7.rst index f3070f983a0..455b0ba4d30 100644 --- a/docs/score_releases/release_note_score_07.rst +++ b/docs/score_releases/release_note_score_v0_7.rst @@ -12,7 +12,7 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -S-CORE Platform v0.7-release note +S-CORE Platform v0.7 release note ================================= .. document:: S-CORE v0.7 release note @@ -120,7 +120,7 @@ Logging Orchestrator -~~~~~~~~~~~~~ +~~~~~~~~~~~~ Orchestrator module provides a framework for defining and executing complex workflows and task sequences in a coordinated manner. @@ -157,18 +157,18 @@ Central integration of Eclipse S-CORE modules Reference QNX image -+++++++++++++++++++++ ++++++++++++++++++++ - No changes compared to the previous software version. Reference Red Hat AutoSD Linux image (Experimental) -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++++++++++++++++ - No changes compared to the previous software version. Reference Elektrobit corbos Linux for Safety Applications Linux image (Experimental) -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - No changes compared to the previous software version. @@ -235,10 +235,12 @@ Compatibility Performed Verification ^^^^^^^^^^^^^^^^^^^^^^ +- See latest verification: :need:`doc__platform_verification_report_latest`. + Known Issues/Vulnerabilities and Bug Fixes ------------------------------------------ -- see release notes of every module separately +- See release notes of every module separately Upgrade Instructions -------------------- diff --git a/docs/verification_report/platform_verification_report.rst b/docs/verification_report/platform_verification_report.rst index dedb242ad19..63822f371e3 100644 --- a/docs/verification_report/platform_verification_report.rst +++ b/docs/verification_report/platform_verification_report.rst @@ -16,7 +16,7 @@ Platform Verification Report ============================ .. document:: Platform Verification Report - :id: doc__platform_verification_report_v07 + :id: doc__platform_verification_report_latest :status: valid :safety: QM :security: YES