Skip to content

docs: Update score/utils component requirement - #417

Open
rahulthakre29 wants to merge 2 commits into
eclipse-score:mainfrom
rahulthakre29:docs/utils-library-component-requirements-update
Open

docs: Update score/utils component requirement#417
rahulthakre29 wants to merge 2 commits into
eclipse-score:mainfrom
rahulthakre29:docs/utils-library-component-requirements-update

Conversation

@rahulthakre29

@rahulthakre29 rahulthakre29 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Fix: #395

@github-actions

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@4og 4og added documentation Improvements or additions to documentation comp-utils Related to score/utils labels Jul 28, 2026
@rahulthakre29
rahulthakre29 temporarily deployed to workflow-approval July 28, 2026 11:08 — with GitHub Actions Inactive
@rahulthakre29
rahulthakre29 temporarily deployed to workflow-approval July 28, 2026 11:08 — with GitHub Actions Inactive

@Rutik7 Rutik7 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@4og

4og commented Jul 30, 2026

Copy link
Copy Markdown
Member

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.

@rahulthakre29
rahulthakre29 temporarily deployed to workflow-approval July 30, 2026 11:26 — with GitHub Actions Inactive
@rahulthakre29
rahulthakre29 temporarily deployed to workflow-approval July 30, 2026 11:26 — with GitHub Actions Inactive
@rahulthakre29
rahulthakre29 force-pushed the docs/utils-library-component-requirements-update branch from 696e579 to 3212c82 Compare July 30, 2026 11:46
@github-actions github-actions Bot removed the comp-utils Related to score/utils label Jul 30, 2026
- Updated component requirement as per review comment on
  PR eclipse-score#269
- updated requirement checklist
@rahulthakre29
rahulthakre29 force-pushed the docs/utils-library-component-requirements-update branch from 3212c82 to 2703ad3 Compare July 30, 2026 11:56
@rahulthakre29
rahulthakre29 temporarily deployed to workflow-approval July 30, 2026 11:56 — with GitHub Actions Inactive
@rahulthakre29
rahulthakre29 temporarily deployed to workflow-approval July 30, 2026 11:56 — with GitHub Actions Inactive
: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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would formulate it like this:

Suggested change
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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would drop meyer as it's implementation detail.

Suggested change
:id: comp_req__utils__meyer_singleton_threadsafe
:id: comp_req__utils__threadsafe_singleton

:status: valid
:version: 1
:satisfied_by: comp__baselibs_utils[version==1]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose :tags: inspected is needed as it's part of the inspection. @aschemmel-tech, is it alighned with the process?

Suggested change
: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`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* :need:`comp_req__utils__meyer_singleton_threadsafe`
* :need:`comp_req__utils__threadsafe_singleton`

Comment on lines 71 to +82
.. 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would actually delete this requirement.

Suggested change
The Utils component shall run operations proportional to input size using only stack memory.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

Utils: Address inspection findings from component requirements review

3 participants