docs: Update score/utils component requirement - #417
Conversation
|
The created documentation from the pull request is available at: docu-html |
|
Hi @rahulthakre29, the inspection checklist PR was merged yesterday #269. The process is the following: as part of the addressing the findings (this PR), you also mark the addressed checklist items to YES. |
696e579 to
3212c82
Compare
- Updated component requirement as per review comment on PR eclipse-score#269 - updated requirement checklist
3212c82 to
2703ad3
Compare
| :version: 1 | ||
| :satisfied_by: comp__baselibs_utils[version==1] | ||
|
|
||
| The Utils component shall ensure a singleton is created once and safely shared by multiple threads. |
There was a problem hiding this comment.
I would formulate it like this:
| The Utils component shall ensure a singleton is created once and safely shared by multiple threads. | |
| The Utils component shall provide a thread-safe singleton whose instance is created exactly once when accessed concurrently by multiple threads. |
| The Utils component shall provide functions for decoding Base64 data back to its original form. | ||
|
|
||
| .. comp_req:: Thread-Safe Singleton Instance Creation | ||
| :id: comp_req__utils__meyer_singleton_threadsafe |
There was a problem hiding this comment.
I would drop meyer as it's implementation detail.
| :id: comp_req__utils__meyer_singleton_threadsafe | |
| :id: comp_req__utils__threadsafe_singleton |
| :status: valid | ||
| :version: 1 | ||
| :satisfied_by: comp__baselibs_utils[version==1] | ||
|
|
There was a problem hiding this comment.
I suppose :tags: inspected is needed as it's part of the inspection. @aschemmel-tech, is it alighned with the process?
| :tags: inspected | |
| * :need:`comp_req__utils__scoped_operation` | ||
| * :need:`comp_req__utils__base64_encoding` | ||
| * :need:`comp_req__utils__base64_decoding` | ||
| * :need:`comp_req__utils__meyer_singleton_threadsafe` |
There was a problem hiding this comment.
| * :need:`comp_req__utils__meyer_singleton_threadsafe` | |
| * :need:`comp_req__utils__threadsafe_singleton` |
| .. comp_req:: Deterministic Behavior | ||
| :id: comp_req__utils__deterministic_behavior | ||
| :reqtype: Non-Functional | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :derived_from: feat_req__baselibs__utils_library[version==2] | ||
| :status: valid | ||
| :version: 1 | ||
| :satisfied_by: comp__baselibs_utils[version==1] | ||
| :tags: inspected | ||
|
|
||
| The Utils component shall ensure that all operations complete in a predictable manner and without dynamic memory allocation. | ||
| The Utils component shall run operations proportional to input size using only stack memory. |
There was a problem hiding this comment.
I would actually delete this requirement.
| The Utils component shall run operations proportional to input size using only stack memory. |
fbaeuerle
left a comment
There was a problem hiding this comment.
- #395 mentions moving comp_req__utils__scoped_operation, i could not locate the new location of this requirement
- architecture still lists logic_arc_int__baselibs__utils_scoped_op, how does it relate to the removal of the component requirement?
- #395 also mentiones requirements tracing in base64_test.cpp – I could not find any edits of that file
- the singleton lacks a corresponding logic_arc_int counterpart in the architecture
|
The comp_req__utils__scoped_operation should be covered with #428 |
…ils-library-component-requirements-update Addressing comment for utils component requirement(eclipse-score#417)
|
Follow up for feature and component architecture: #478 |
|
The findings are addressed in #475 |
Fix: #395