Requirements and specs for containers component#19
Requirements and specs for containers component#19pawelrutkaq merged 1 commit intoeclipse-score:mainfrom
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run //:license-checkStatus: Click to expand output |
8c4ebd4 to
5ba60ca
Compare
|
The created documentation from the pull request is available at: docu-html |
5ba60ca to
b7a827a
Compare
pawelrutkaq
left a comment
There was a problem hiding this comment.
Also, once we fix points, we need a Safety and Security member to review afaik.
There was a problem hiding this comment.
why we change structore ? We are in baselib rust so second folder (baselib_rust) does not seems to be neeeded
There was a problem hiding this comment.
OVerall structure is not according to https://eclipse-score.github.io/process_description/main/folder_templates/modules/module_name/component_name/docs/index.html or ?
| :satisfies: feat_req__baselibs_rust__containers_library, feat_req__baselibs_rust__abi_containers | ||
| :status: valid | ||
|
|
||
| The Rust Containers library shall provide an inline-storage vector container with compile-time capacity specification. |
There was a problem hiding this comment.
inline-storage may be not clear in this req imho. So maybe we shall first heave a req for InlineStorage?
There was a problem hiding this comment.
There is also a need to write somewhere what has to realize ABI compatibility (even though is linked in non-functional maybe it's cleaner when its explicit there and not hidden after N links?)
| :satisfies: stkh_req__functional_req__base_libraries | ||
| :status: valid | ||
|
|
||
| The Rust base libraries shall provide a library of containers that can serve as the basis for ABI-compatible container data structures. |
There was a problem hiding this comment.
Should that satisfy also ABI req ?
| Interfaces | ||
| ---------- | ||
|
|
||
| .. logic_arc_int:: Fixed-Capacity Vector |
There was a problem hiding this comment.
does thta need to be done, and also manually ? maybe @4og knows ?
b7a827a to
dd20f05
Compare
dd20f05 to
2a63096
Compare
2a63096 to
f75f9b7
Compare
pawelrutkaq
left a comment
There was a problem hiding this comment.
LGTM as a starting point. Currently topic of modules documentation is bit open and a lot of things are not clear. We will fix it in #10
Requirements for Rust containers in general, and for vector and queue in particular.
I had to change the directory structure under
docs/to comply with the hierarchy checks of score_metamodel.Pre-Review Checklist for the PR Author
Checklist for the PR Reviewer
Post-review Checklist for the PR Author
References
Closes #20