Skip to content

Commit f8a7453

Browse files
masc2023masc2023
committed
proces: add initial tool management
Resolves: #858
1 parent 8b57416 commit f8a7453

13 files changed

+687
-14
lines changed

‎docs/platform_management_plan/tool_management.rst

+127-3
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,138 @@
1212
# SPDX-License-Identifier: Apache-2.0
1313
# *******************************************************************************
1414
15-
Tool Management
16-
------------------------
15+
.. document:: Tool Management Plan
16+
:id: doc__platform_tool_management_plan
17+
:status: draft
18+
:safety: ASIL_B
19+
:tags: platform_management
20+
:realizes: wp__tlm_plan
21+
22+
23+
Tool Management/ Tool Management Plan
24+
-------------------------------------
25+
26+
This document implements parts of the :need:`wp__platform_mgmt`.
1727

1828
Purpose
1929
+++++++
30+
The purpose of the Tool Management Plan is to guide the identification, evaluation and qualification of
31+
project tools.
32+
33+
S-CORE objectives is to use OSS tools for the generation of all required work products. Thus all
34+
tools which will be used as part of the tool chain for the work product generation must be identified,
35+
documented and evaluated and if applicable, qualified.
36+
2037

21-
Objectives and scope
38+
Objectives and Scope
2239
++++++++++++++++++++
2340

41+
Tool Management Goals
42+
^^^^^^^^^^^^^^^^^^^^^
43+
44+
* Tools are identified and documented
45+
* Tools are evaluated
46+
* Tools are qualified, if applicable
47+
2448
Approach
2549
++++++++
50+
51+
52+
Identification
53+
^^^^^^^^^^^^^^
54+
55+
Each tool is identified by its name or UID and version.
56+
The tools are stored in one GitHub repository, `tooling repository <https://GitHub.com/eclipse-score/tooling/>`_.
57+
58+
For each tool the :need:`gd_temp__tool_management__verif_rpt_template` shall be used to document
59+
the relevant information.
60+
61+
:need:`gd_chklst__tool__cr_review` may used to check that all relevant information is considered.
62+
63+
The configuration of tools is part of the :need:`doc__config_mgt_plan`.
64+
65+
66+
Evaluation
67+
^^^^^^^^^^
68+
69+
The tool confidence level (TCL) must be determined as outlined in the
70+
:need:`doc_concept__tool__process`.
71+
72+
Step-by-Step guide:
73+
74+
1. Determine the tool impact
75+
2. Determine the tool error detection
76+
3. Determine the tool confidence level
77+
78+
**To Step 1**
79+
80+
Based on the found malfunctions or threats judge, if any safety or security requirements may violated.
81+
If this is the case, determine tool impact to "YES" otherwise to "NO".
82+
83+
If tool impact is "NO", continue with 3, otherwise 2.
84+
85+
**To Step 2**
86+
87+
Based on the found malfunctions or threats judge, if these can be all detected or prevented?
88+
Consider also potential safety measures and security controls to increase the detection and
89+
prevention of these, if applicable.
90+
If there is no guarantee to either detect or prevent these, judge tool error detection to "NO",
91+
otherwise to "YES".
92+
93+
**To Step 3**
94+
95+
If tool impact is judged to "YES" and tool error detection judged to "YES", the tool confidence
96+
level is determined to "LOW", otherwise "HIGH".
97+
98+
In case the tool confidence level is "LOW", tool qualification is required,
99+
100+
101+
Qualification
102+
^^^^^^^^^^^^^
103+
104+
As method validation of software tool is applied.
105+
106+
Specify requirements for the tools purpose and usage in the S-CORE context.
107+
Analyze the malfunctions and threats and specify safety measures and security controls to increase
108+
the prevention and detection of them.
109+
Specify test cases and tests to verify the requirements and generate a test report.
110+
Update the Tool Verification Report accordingly to document the outcomes.
111+
112+
For the generation of requirements, verification and analyses the processes defined in the
113+
:need:`wp__platform_mgmt` shall be used (Requirements Engineering, Verification,
114+
Safety/Security Analyzes).
115+
116+
Tailoring
117+
^^^^^^^^^
118+
Tailoring of safety activities for confidence in the use of software tools:
119+
120+
The following ISO 26262 defined safety requirements are not relevant for the S-CORE SW platform
121+
development, as they are not used:
122+
123+
:need:`std_req__iso26262__support_11471`, :need:`std_req__iso26262__support_11472`,
124+
:need:`std_req__iso26262__support_11473`, :need:`std_req__iso26262__support_11474`,
125+
:need:`std_req__iso26262__support_11481`, :need:`std_req__iso26262__support_11482`,
126+
:need:`std_req__iso26262__support_11483`
127+
128+
129+
Tool List
130+
^^^^^^^^^
131+
132+
.. list-table:: SW Platform tool overview
133+
:header-rows: 1
134+
135+
* - tool Id
136+
- tool name
137+
- tool status
138+
- tool TCL
139+
- Link to evaluation issue
140+
- Link to qualification issue
141+
- Link to verification report
142+
143+
* - #
144+
- sphinx-needs
145+
- draft <automated>
146+
- not evaluated yet
147+
- <Link to issue>
148+
- <Link to issue>
149+
- <Link to tool verification report>

‎docs/process/_assets/score_process_area_overview.drawio.svg

+1-1
Loading

‎docs/process/process_areas/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,5 @@ Process Areas
2828
problem_resolution/index.rst
2929
requirements_engineering/index.rst
3030
safety_management/index.rst
31+
tool_management/index.rst
3132
verification/index.rst

‎docs/process/process_areas/tool_management/guidance/index.rst

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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+
Guidance
16+
########
17+
18+
.. toctree::
19+
:maxdepth: 1
20+
21+
tool_management_checklist
22+
tool_management_template

‎docs/process/process_areas/tool_management/guidance/tool_management_checklist.rst

+118
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+
.. _tlm_checklist:
16+
17+
Tool Management Checklist
18+
#########################
19+
20+
.. gd_chklst:: Tool Verification Report Review Checklist
21+
:id: gd_chklst__tool__cr_review
22+
:status: valid
23+
:tags: tool_management
24+
:complies: std_req__iso26262__support_1141, std_req__iso26262__support_1142, std_req__iso26262__support_1143, std_req__iso26262__support_11441, std_req__iso26262__support_11442, std_req__iso26262__support_11451, std_req__iso26262__support_11452, std_req__iso26262__support_11453, std_req__iso26262__support_11454, std_req__iso26262__support_11461, std_req__iso26262__support_11462
25+
26+
| **1. Purpose**
27+
| The purpose of this checklist is to collect the topics to be checked during a tool verification..
28+
| It will not be filled out but considered during the review and monitoring to complete of the Tool Verification Report.
29+
|
30+
| **2. Checklist**
31+
|
32+
33+
.. list-table:: Tool Verification Report Review Checklist
34+
:header-rows: 1
35+
:widths: 10,30,6
36+
37+
* - Id
38+
- Topic
39+
- Status [FAIL|PASS]
40+
* - 1
41+
- Is the tool uniquely by name and/or UID defined?
42+
-
43+
44+
* - 2
45+
- Is the tool version defined?
46+
-
47+
48+
* - 3
49+
- Is the tool verification status (draft, evaluated, qualified) defined?
50+
-
51+
52+
* - 4
53+
- Are the purposes of the tool (e.g. use cases) defined?
54+
-
55+
56+
* - 5
57+
- Are the inputs of the tool defined?
58+
-
59+
60+
* - 6
61+
- Are the outputs of the tool defined?
62+
-
63+
64+
* - 7
65+
- Are the configurations of the tool defined?
66+
-
67+
68+
* - 8
69+
- Are the environmental constraints/limitations defined?
70+
-
71+
72+
* - 9
73+
- Are the links to the tool documentations available?
74+
-
75+
76+
* - 10
77+
- Are the tool usage constraints/limitations available?
78+
-
79+
80+
* - 11
81+
- Are the possible malfunctions of the tool described?
82+
-
83+
84+
* - 12
85+
- Are the threats of the tool described?
86+
-
87+
88+
* - 13
89+
- Is the tool impact based on malfunctions/threats defined?
90+
-
91+
92+
* - 14
93+
- Are safety measures/security controls against the tool malfunctions/threats defined?
94+
-
95+
96+
* - 15
97+
- Is the tool error detection based on confidence on the defined safety measures/security controls defined?
98+
-
99+
100+
* - 16
101+
- Is the tool confidence level based on tool impact and tool error detection defined?
102+
-
103+
104+
* - 17
105+
- If applicable, are the requirements for software tool qualification defined?
106+
-
107+
108+
* - 18
109+
- If applicable, are the test cases and tests for software tool qualification defined?
110+
-
111+
112+
* - 19
113+
- If applicable, are the test reports for software tool qualification defined?
114+
-
115+
116+
* - 20
117+
- If applicable, are the analyses for software tool qualification defined?
118+
-

0 commit comments

Comments
 (0)