iox-#1295 Add platform library to component diagram

Signed-off-by: Dietrich Krönke <[email protected]>
eclipse-iceoryx · Sep 13, 2022 · 824b102 · 824b102
1 parent 9d6df8c
commit 824b102
Show file tree

Hide file tree

Showing 4 changed files with 95 additions and 378 deletions.
diff --git a/doc/design/diagrams/iceoryx_components_diagram_v3_0_0.puml b/doc/design/diagrams/iceoryx_components_diagram_v3_0_0.puml
@@ -28,6 +28,13 @@ skinparam frame {
 
 header Eclipse iceoryx component overview
 
+' Platform Library containing platform abstraction with quality level 1
+package iceoryx_platform  {
+   frame "platform library" {
+      component "Platform abstraction" <<module>>
+   }
+}
+
 ' HOOFS: Helpful Objects Optimised For Safety
 ' Library containing modern C++ STL constructs with quality level 1+
 package iceoryx_hoofs  {
@@ -47,7 +54,6 @@ package iceoryx_hoofs  {
       component Time <<module>>
       component "Queues & communication" <<module>>
       component "Threads & Sychronisation" <<module>>
-      component "Platform abstraction" <<module>>
    }
 }
 
@@ -122,6 +128,8 @@ package iceoryx_introspection  {
    }
 }
 
+iceoryx_hoofs  ..>  iceoryx_platform  : use
+iceoryx_dust  ..>  iceoryx_platform  : use
 iceoryx_posh  ..>  iceoryx_hoofs  : use
 iceoryx_dust  ..>  iceoryx_hoofs : use
 iceoryx_posh  ..>  iceoryx_dust : use

diff --git a/doc/design/diagrams/iceoryx_software_layers_v3_0_0.puml b/doc/design/diagrams/iceoryx_software_layers_v3_0_0.puml
@@ -17,18 +17,22 @@ skinparam frame {
    backgroundColor chocolate
 }
 
+[iceoryx_platform]
 [iceoryx_dust]
 [iceoryx_hoofs]
 [iceoryx_posh]
 [iceoryx_binding_c]
 [C user app]
 [C++ user app]
 
-note right of iceoryx_hoofs : Basic building block library with quality level 1+
-note right of iceoryx_dust : Basic building block library with quality level 2
-note right of iceoryx_posh : Shared memory transport (POsix SHared memory)
-note left of iceoryx_binding_c : C API for iceoryx_posh
+note right of iceoryx_platform : Basic platform support library with quality level 1+
+note top of iceoryx_hoofs : Basic building block library with quality level 1+
+note top of iceoryx_dust : Basic building block library with quality level 2
+note top of iceoryx_posh : Shared memory transport (POsix SHared memory)
+note right of iceoryx_binding_c : C API for iceoryx_posh
 
+[iceoryx_hoofs]  ..>  [iceoryx_platform]
+[iceoryx_dust]  ..>  [iceoryx_platform]
 [iceoryx_posh]  ..>  [iceoryx_hoofs]
 [iceoryx_dust]  ..>  [iceoryx_hoofs]
 [iceoryx_posh]  ..>  [iceoryx_dust]