Skip to content

Add OS library component requirements in baselibs#2743

Open
4og wants to merge 1 commit intomainfrom
baselibg_osal_reqs
Open

Add OS library component requirements in baselibs#2743
4og wants to merge 1 commit intomainfrom
baselibg_osal_reqs

Conversation

@4og
Copy link
Copy Markdown
Member

@4og 4og commented Mar 30, 2026

Fixes #2742

@github-actions
Copy link
Copy Markdown

⚠️ Docs-as-Code version mismatch detected
Please check the CI build logs for details and align the documentation version with the Bazel dependency.

@4og 4og force-pushed the baselibg_osal_reqs branch from 8c6bbef to ebca3b4 Compare March 30, 2026 16:01
@github-actions
Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html
⚠️ The gh-pages branch is approximately '955'MB. Published docs might look incorrect.

Copy link
Copy Markdown
Contributor

@aschemmel-tech aschemmel-tech left a comment

Choose a reason for hiding this comment

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

see inline comments

:satisfies: stkh_req__functional_req__base_libraries
:status: valid

The base libraries shall provide an operating system abstraction library that offers idiomatic interfaces for operating system functionality across supported platforms.
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.

how do you want to verify that the interfaces are "idiomatic"?

:satisfies: stkh_req__functional_req__base_libraries
:status: valid

The base libraries shall provide an operating system abstraction library that offers idiomatic interfaces for operating system functionality across supported platforms.
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.

what is a "supported platform"? I think we agreed to only use "platform" term for the "S-CORE SW platform"

:status: valid
:belongs_to: comp__baselibs_os

The OS library shall provide a C++ abstraction layer that wraps operating system interfaces using type-safe, idiomatic C++ constructs.
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.

again idiomatic

:status: valid
:belongs_to: comp__baselibs_os

The OS library shall provide platform-specific abstractions for Linux operating system APIs, including Linux-specific system calls and services not available in the POSIX standard.
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.

what is "platform-specific"?

:status: valid
:belongs_to: comp__baselibs_os

The OS library shall provide platform-specific abstractions for QNX operating system APIs, including QNX-specific system calls and services not available in the POSIX standard.
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.

what is "platform-specific"?

Static Architecture
-------------------

.. comp:: OS Library
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.

why not call OS Abstraction Library?

:satisfies: stkh_req__functional_req__base_libraries
:status: valid

The base libraries shall provide an operating system abstraction library that offers idiomatic interfaces for operating system functionality across supported platforms.
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.

Missing addition of component to the feature architecture

:status: valid
:belongs_to: comp__baselibs_os

The OS library wrappers shall not add application-level logic beyond parameter type conversion and error translation.
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.

"error translation" is required in comp_req__os__error_propagation. But where is the parameter type conversion required?

:scale: 50
:align: center

{{ draw_component(need(), needs) }}
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.

missing interface definition (maybe three: standard, Linux-specific, QNX -specific ?)

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

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

Define component requirements for os library

2 participants