Skip to content

Commit bd5ef16

Browse files
Merge pull request #1094 from eclipse-score/aschemmel-tech-safety-plan-features
docs: update platform safety plan with v0.5 features
2 parents 4dc266d + 5ea9570 commit bd5ef16

File tree

7 files changed

+162
-34
lines changed

7 files changed

+162
-34
lines changed

docs/contribute/contribution_request/index.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ How to Contribute?
2121
:id: doc__contr_guideline
2222
:status: valid
2323
:safety: QM
24-
:tags: platform_management
2524

2625
How we Work
2726
===========
@@ -91,7 +90,6 @@ What is a Pull Request (PR)?
9190
:id: doc__pull_request_guideline
9291
:status: valid
9392
:safety: QM
94-
:tags: platform_management
9593

9694
A Pull Request (**PR**) is the **ONLY** way to contribute **CODE** to the *S-CORE* project.
9795

@@ -161,7 +159,6 @@ What is a GitHub Issue?
161159
:id: doc__issue_guideline
162160
:status: valid
163161
:safety: QM
164-
:tags: platform_management
165162

166163
A *GitHub Issue* is the way to report bugs or propose improvements without knowing the solution and to request features (incl. scope changes).
167164

docs/features/communication/ipc/architecture/feature_architecture.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,6 @@ Interfaces
5353
:safety: ASIL_B
5454
:status: valid
5555
:fulfils: feat_req__ipc__interfaces
56+
57+
.. needextend:: "communication/ipc/architecture" in docname
58+
:+tags: ipc

docs/features/communication/ipc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Inter-process Communication
2929

3030
architecture/index.rst
3131
requirements/index.rst
32+
safety_planning/index.rst
3233
roadmap.rst
3334

3435

@@ -393,4 +394,3 @@ License Impact
393394

394395
How to Teach This
395396
=================
396-

docs/features/communication/ipc/requirements/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -507,3 +507,6 @@ Safety Impact
507507
:status: valid
508508

509509
The communication framework shall support safe communication up to ASIL-B.
510+
511+
.. needextend:: "communication/ipc/requirements" in docname
512+
:+tags: ipc
Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
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+
Safety Planning
16+
###############
17+
18+
Inter-process Communication Safety Work Products
19+
================================================
20+
21+
.. list-table:: Feature Inter-process Communication Workproducts
22+
:header-rows: 1
23+
24+
* - Workproduct Id
25+
- Link to process
26+
- Process status
27+
- Link to issue
28+
- Link to WP
29+
- WP status
30+
31+
* - :need:`wp__feat_request`
32+
- :need:`gd_temp__change__feature_request`
33+
- :ndf:`copy('status', need_id='gd_temp__change__feature_request')`
34+
- `#69 <https://github.com/eclipse-score/score/issues/69>`_
35+
- :need:`doc__ipc`
36+
- :ndf:`copy('status', need_id='doc__ipc')`
37+
38+
* - :need:`wp__requirements__feat`
39+
- :need:`gd_temp__req__feat_req`
40+
- :ndf:`copy('status', need_id='gd_temp__req__feat_req')`
41+
- `#69 <https://github.com/eclipse-score/score/issues/69>`_
42+
- :doc:`../requirements/index`
43+
- see below
44+
45+
* - :need:`wp__requirements__feat_aou`
46+
- :need:`gd_temp__req__aou_req`
47+
- :ndf:`copy('status', need_id='gd_temp__req__aou_req')`
48+
- <link to issue>
49+
- :doc:`../requirements/index`
50+
- see below
51+
52+
* - :need:`wp__feature_arch`
53+
- :need:`gd_temp__arch__feature`
54+
- :ndf:`copy('status', need_id='gd_temp__arch__feature')`
55+
- `#388 <https://github.com/eclipse-score/score/issues/388>`_
56+
- :doc:`../architecture/index`
57+
- see below
58+
59+
* - :need:`wp__feature_safety_analysis`
60+
- <link to process>
61+
- <automated>
62+
- <link to issue>
63+
- <Link to WP>
64+
- <automated>
65+
66+
* - :need:`wp__requirements__inspect`
67+
- :need:`gd_chklst__req__inspection`
68+
- :ndf:`copy('status', need_id='gd_chklst__req__inspection')`
69+
- <link to issue>
70+
- <Link to WP>
71+
- <automated>
72+
73+
* - :need:`wp__sw_arch_verification`
74+
- :need:`gd_chklst__arch__inspection_checklist`
75+
- :ndf:`copy('status', need_id='gd_chklst__arch__inspection_checklist')`
76+
- <link to issue>
77+
- <Link to WP>
78+
- <automated>
79+
80+
* - :need:`wp__verification__feat_int_test`
81+
- :need:`gd_guidl__verification_guide`
82+
- :ndf:`copy('status', need_id='gd_guidl__verification_guide')`
83+
- <link to issue>
84+
- <Link to WP>
85+
- <automated>
86+
87+
Feature Requirements Status
88+
---------------------------
89+
90+
.. needtable::
91+
:style: table
92+
:types: feat_req
93+
:tags: ipc
94+
:columns: id;status
95+
:colwidths: 25,25
96+
:sort: title
97+
98+
Feature AoU Status
99+
------------------
100+
101+
.. needtable::
102+
:style: table
103+
:types: aou_req
104+
:tags: ipc
105+
:columns: id;status
106+
:colwidths: 25,25
107+
:sort: title
108+
109+
Feature Architecture Status
110+
---------------------------
111+
112+
.. needtable::
113+
:style: table
114+
:types: feat_arc_sta; feat_arc_dyn
115+
:tags: ipc
116+
:columns: id;status
117+
:colwidths: 25,25
118+
:sort: title

docs/platform_management_plan/safety_management.rst

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -414,8 +414,8 @@ Functional Safety Management SW Platform Work Products
414414
- <automated>
415415

416416
* - :need:`wp__platform_sw_release_note`
417-
- :doc:`release_management`
418-
- not started
417+
- :need:`gd_temp__rel__plat_rel_note`
418+
- :ndf:`copy('status', need_id='gd_temp__rel__plat_rel_note')`
419419
- <Link to issue>
420420
- <Link to WP>
421421
- <automated>
@@ -437,20 +437,20 @@ Functional Safety Management SW Platform Work Products
437437
* - :need:`wp__sw_development_plan`
438438
- :need:`wf__platform__cr_mt_platform_mgmt_plan`
439439
- :ndf:`copy('status', need_id='wf__platform__cr_mt_platform_mgmt_plan')`
440-
- <Link to issue>
441-
- :doc:`software_development`
442-
- not started
440+
- `#583 <https://github.com/eclipse-score/score/issues/583>`_
441+
- :need:`doc__software_development_plan`
442+
- :ndf:`copy('status', need_id='doc__software_development_plan')`
443443

444444
* - :need:`wp__verification__plan`
445445
- :need:`wf__platform__cr_mt_platform_mgmt_plan`
446446
- :ndf:`copy('status', need_id='wf__platform__cr_mt_platform_mgmt_plan')`
447-
- <Link to issue>
448-
- :doc:`software_verification`
449-
- not started
447+
- `#611 <https://github.com/eclipse-score/score/issues/611>`_
448+
- :need:`doc__verification_plan`
449+
- :ndf:`copy('status', need_id='doc__verification_plan')`
450450

451451
* - :need:`wp__tool_verification_report`
452-
- :doc:`tool_management`
453-
- not started
452+
- :need:`doc__platform_tool_management_plan`
453+
- :ndf:`copy('status', need_id='doc__platform_tool_management_plan')`
454454
- <Link to issue>
455455
- <Link to WP>
456456
- <automated>
@@ -467,10 +467,17 @@ Functional Safety Management Feature Specific Work Products
467467

468468
See feature tree documents (created by using :need:`gd_temp__feature_safety_wp`):
469469

470-
<link to document for every feature>
470+
- Inter-process Communication: :doc:`/features/communication/ipc/safety_planning/index`
471+
- Common Libraries: <link>
472+
- Logging: <link>
473+
- Persistency: <link>
474+
- Fixed Execution Order (Framework): <link>
475+
476+
Note: list of features for v0.5 according to `S-CORE Roadmap <https://github.com/orgs/eclipse-score/projects/17>`_
477+
and :ref:`releases`
471478

472-
Functional Safety Work Products Status Charts
473-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
479+
Platform Management Plan - Documents Status Chart
480+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
474481

475482
.. needtable::
476483
:style: table

docs/process/process_areas/safety_management/guidance/template_feature_safety_wp.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -32,29 +32,29 @@ Feature Safety Work Products Template
3232
- WP status
3333

3434
* - :need:`wp__feat_request`
35-
- :ref:`Feature Request Template <chm_feature_templates>`
36-
- <automated>
35+
- :need:`gd_temp__change__feature_request`
36+
- :ndf:`copy('status', need_id='gd_temp__change__feature_request')`
3737
- <link to issue>
38-
- <link to WP>
38+
- <Link to WP>
3939
- <automated>
4040

4141
* - :need:`wp__requirements__feat`
42-
- <link to process>
43-
- <automated>
42+
- :need:`gd_temp__req__feat_req`
43+
- :ndf:`copy('status', need_id='gd_temp__req__feat_req')`
4444
- <link to issue>
4545
- <Link to WP>
4646
- <automated>
4747

4848
* - :need:`wp__requirements__feat_aou`
49-
- <link to process>
50-
- <automated>
49+
- :need:`gd_temp__req__aou_req`
50+
- :ndf:`copy('status', need_id='gd_temp__req__aou_req')`
5151
- <link to issue>
52-
- <link to WP>
52+
- <Link to WP>
5353
- <automated>
5454

5555
* - :need:`wf__cr_mt_featarch`
56-
- <link to process>
57-
- <automated>
56+
- :need:`gd_temp__arch__feature`
57+
- :ndf:`copy('status', need_id='gd_temp__arch__feature')`
5858
- <link to issue>
5959
- <Link to WP>
6060
- <automated>
@@ -67,22 +67,22 @@ Feature Safety Work Products Template
6767
- <automated>
6868

6969
* - :need:`wp__requirements__inspect`
70-
- <link to process>
71-
- <automated>
70+
- :need:`gd_chklst__req__inspection`
71+
- :ndf:`copy('status', need_id='gd_chklst__req__inspection')`
7272
- <link to issue>
73-
- Checklist used in Pull Request Review
73+
- <Link to WP>
7474
- <automated>
7575

7676
* - :need:`wp__sw_arch_verification`
77-
- <link to process>
78-
- <automated>
77+
- :need:`gd_chklst__arch__inspection_checklist`
78+
- :ndf:`copy('status', need_id='gd_chklst__arch__inspection_checklist')`
7979
- <link to issue>
8080
- <Link to WP>
8181
- <automated>
8282

8383
* - :need:`wp__verification__feat_int_test`
84-
- <link to process>
85-
- <automated>
84+
- :need:`gd_guidl__verification_guide`
85+
- :ndf:`copy('status', need_id='gd_guidl__verification_guide')`
8686
- <link to issue>
8787
- <Link to WP>
8888
- <automated>

0 commit comments

Comments
 (0)