Skip to content

Commit 160d47b

Browse files
authored
communictaion+feo: move modules to the rigth folder (#1438)
1 parent 6cfbc0b commit 160d47b

File tree

50 files changed

+611
-118
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+611
-118
lines changed

docs/features/communication/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ Communication
3030

3131
docs/**/index
3232
ipc/index
33-
modules/index
3433

3534
Feature flag
3635
============

docs/features/frameworks/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,3 @@ Frameworks
1919
.. toctree::
2020

2121
feo/index.rst
22-
feo/modules/index

docs/features/orchestration/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Orchestration
2121
:id: doc__orchestration
2222
:status: valid
2323
:safety: ASIL_B
24-
:realizes: wp__feat_request
24+
:realizes:
2525
:tags: feature_request, change_management, orchestration
2626

2727

docs/features/orchestration/requirements.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ Program Definition
188188
:id: feat_req__orchestration__orch_static_graphs
189189
:reqtype: Functional
190190
:security: NO
191-
:safety: QM
191+
:safety: ASIL_B
192192
:satisfies: stkh_req__execution_model__processes, stkh_req__app_architectures__support_time
193193
:status: valid
194194

@@ -198,7 +198,7 @@ Program Definition
198198
:id: feat_req__orchestration__orch_ctrl_flows
199199
:reqtype: Functional
200200
:security: NO
201-
:safety: QM
201+
:safety: ASIL_B
202202
:satisfies: stkh_req__execution_model__processes, stkh_req__app_architectures__support_time
203203
:status: valid
204204

@@ -208,7 +208,7 @@ Program Definition
208208
:id: feat_req__orchestration__orch_event_sync
209209
:reqtype: Functional
210210
:security: NO
211-
:safety: QM
211+
:safety: ASIL_B
212212
:satisfies: stkh_req__execution_model__processes, stkh_req__app_architectures__support_time
213213
:status: valid
214214

@@ -218,7 +218,7 @@ Program Definition
218218
:id: feat_req__orchestration__orch_fault_mon
219219
:reqtype: Functional
220220
:security: NO
221-
:safety: QM
221+
:safety: ASIL_B
222222
:satisfies: stkh_req__execution_model__processes, stkh_req__app_architectures__support_time
223223
:status: valid
224224

@@ -231,7 +231,7 @@ API Design
231231
:id: feat_req__orchestration__orch_code_api
232232
:reqtype: Functional
233233
:security: NO
234-
:safety: QM
234+
:safety: ASIL_B
235235
:satisfies: stkh_req__execution_model__processes, stkh_req__app_architectures__support_time
236236
:status: valid
237237

@@ -244,7 +244,7 @@ Execution Model
244244
:id: feat_req__orchestration__orch_single_deploy
245245
:reqtype: Functional
246246
:security: NO
247-
:safety: QM
247+
:safety: ASIL_B
248248
:satisfies: stkh_req__execution_model__processes, stkh_req__app_architectures__support_time
249249
:status: valid
250250

@@ -254,7 +254,7 @@ Execution Model
254254
:id: feat_req__orchestration__orch_multi_prog
255255
:reqtype: Functional
256256
:security: NO
257-
:safety: QM
257+
:safety: ASIL_B
258258
:satisfies: stkh_req__execution_model__processes, stkh_req__app_architectures__support_time
259259
:status: valid
260260

@@ -264,7 +264,7 @@ Execution Model
264264
:id: feat_req__orchestration__orch_event_comm
265265
:reqtype: Functional
266266
:security: NO
267-
:safety: QM
267+
:safety: ASIL_B
268268
:satisfies: stkh_req__execution_model__processes, stkh_req__app_architectures__support_time
269269
:status: valid
270270

docs/features/communication/modules/baselibs/index.rst renamed to docs/modules/baselibs/docs/index.rst

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,6 @@
1212
# SPDX-License-Identifier: Apache-2.0
1313
# *******************************************************************************
1414
15-
Baselibs Module
16-
###############
17-
1815
.. mod_view_sta:: Baselibs
1916
:id: mod_view_sta__baselibs__baselibs
2017
:includes: comp_arc_sta__baselibs__json, comp_arc_sta__baselibs__message_passing, comp_arc_sta__baselibs__memory_shared
@@ -25,12 +22,9 @@ Baselibs Module
2522

2623
{{ draw_module(need(), needs) }}
2724

28-
Components
29-
==========
25+
Module Documents
26+
================
3027

3128
.. toctree::
29+
:maxdepth: 2
3230
:titlesonly:
33-
34-
json_component_architecture
35-
memory_shared_component_architecture
36-
message_passing_component_architecture

docs/features/frameworks/feo/modules/feo/docs/index.rst renamed to docs/modules/baselibs/index.rst

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,21 @@
1212
# SPDX-License-Identifier: Apache-2.0
1313
# *******************************************************************************
1414
15+
Baselibs Module
16+
###############
1517

16-
Module Documentation: feo
17-
#########################
18+
.. toctree::
19+
:titlesonly:
20+
:maxdepth: 2
21+
22+
./docs/index
23+
24+
Components
25+
==========
1826

1927
.. toctree::
28+
:titlesonly:
2029
:maxdepth: 1
30+
:glob:
2131

22-
manual/safety_manual
23-
../feo/docs/index
24-
../feo_com/docs/index
25-
../feo_log/docs/index
26-
../feo_time/docs/index
27-
../feo_tracing/docs/index
32+
./*/docs/index

docs/features/communication/modules/baselibs/json_component_architecture.rst renamed to docs/modules/baselibs/json/docs/architecture/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
# *******************************************************************************
1414
1515
JSON Component Architecture
16-
===========================
16+
***************************
1717

1818
.. comp_arc_sta:: JSON
1919
:id: comp_arc_sta__baselibs__json

docs/features/communication/modules/index.rst renamed to docs/modules/baselibs/json/docs/index.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,12 @@
1212
# SPDX-License-Identifier: Apache-2.0
1313
# *******************************************************************************
1414
15-
Modules
16-
========
15+
.. _comp_doc_json:
16+
17+
json
18+
####
1719

1820
.. toctree::
19-
:maxdepth: 1
20-
:glob:
21+
:hidden:
2122

22-
*/index
23+
architecture/index
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
# *******************************************************************************
1414
1515
Memory Shared Component Architecture
16-
====================================
16+
************************************
1717

1818
.. comp_arc_sta:: Memory Shared
1919
:id: comp_arc_sta__baselibs__memory_shared
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2025 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
.. _comp_doc_memory_shared:
16+
17+
memory_shared
18+
#############
19+
20+
.. toctree::
21+
:hidden:
22+
23+
architecture/index

0 commit comments

Comments
 (0)