-
Notifications
You must be signed in to change notification settings - Fork 36
Initial docs #40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Initial docs #40
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -42,3 +42,8 @@ build:bl-x86_64-qnx --config=bl_toolchain_common | |
| build:bl-x86_64-qnx --platforms=@score_bazel_platforms//:x86_64-qnx | ||
| build:bl-x86_64-qnx --extra_toolchains=@toolchains_qnx_qcc//:qcc_x86_64 | ||
| test:bl-x86_64-qnx --config=bl_common | ||
|
|
||
| build --java_language_version=17 | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Default build settings won't be hardcoded to one version. If you want to use JAVA 17 please provide proper configuration settings for it.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. My understanding is that Bazel requires us to hardcode it like this. We just want to use plantuml in our documentation. Do you know any better solution? |
||
| build --tool_java_language_version=17 | ||
| build --java_runtime_version=remotejdk_17 | ||
| build --tool_java_runtime_version=remotejdk_17 | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,3 +2,5 @@ bazel-* | |
| user.bazelrc | ||
| .cache | ||
| compile_commands.json | ||
| _build | ||
| .vscode | ||
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| Architecture | ||
| ============ | ||
|
|
||
| Logical Interfaces | ||
| ------------------ | ||
|
|
||
| .. logic_arc_int:: Read JSON | ||
| :id: logic_arc_int__baselibs__read_json | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :fulfils: feat_req__baselibs__json_library | ||
| :status: invalid | ||
|
|
||
| * FromFile | ||
|
|
||
| .. logic_arc_int:: Write JSON | ||
| :id: logic_arc_int__baselibs__write_json | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :fulfils: feat_req__baselibs__json_library | ||
| :status: invalid | ||
|
|
||
| * FromAny | ||
| * ToJsonAny | ||
|
|
||
| Components | ||
| ---------- | ||
|
|
||
| .. comp_arc_sta:: C++ Baselibs | ||
| :id: comp_arc_sta__baselibs__cpp_baselibs | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :fulfils: comp_req__baselibs__cpp_json | ||
| :implements: | ||
| :status: invalid | ||
| :includes: comp_arc_sta__baselibs__cpp_json | ||
|
|
||
| C++ Baselibs Module | ||
|
|
||
| .. comp_arc_sta:: C++ JSON lib | ||
| :id: comp_arc_sta__baselibs__cpp_json | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :fulfils: comp_req__baselibs__cpp_json | ||
| :implements: logic_arc_int__baselibs__read_json, logic_arc_int__baselibs__write_json | ||
| :status: invalid | ||
|
|
||
| JSON library |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| Requirements | ||
| ============ | ||
|
|
||
| Component requirements for Baselibs. | ||
|
|
||
| .. comp_req:: Provide JSON serialization and deserialization | ||
| :id: comp_req__baselibs__cpp_json | ||
| :reqtype: Functional | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: invalid | ||
| :satisfies: feat_req__baselibs__core_utilities | ||
|
|
||
| Baselibs shall provide functions to serialize and deserialize data structures to and from JSON format. | ||
|
|
||
| .. comp_req:: Provide bit manipulation functions | ||
| :id: comp_req__baselibs__cpp_bitmanipulation | ||
| :reqtype: Functional | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: invalid | ||
| :satisfies: feat_req__baselibs__core_utilities | ||
|
|
||
| Baselibs shall provide functions for common bit manipulation operations, such as setting, clearing, and toggling bits in integers. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2025 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| # Configuration file for the Sphinx documentation builder. | ||
|
|
||
| project = "S-CORE" | ||
| project_url = "https://eclipse-score.github.io/score-baselibs" | ||
| project_prefix = "S-CORE_" | ||
| version = "0.1" | ||
|
|
||
| extensions = ["score_sphinx_bundle"] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| Implementation | ||
| ============== |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2024 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| S-CORE Baselibs Documentation | ||
| ============================= | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
||
| baselibs_requirements | ||
| baselibs_architecture | ||
| safety | ||
| implementation | ||
| verification |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| Safety | ||
| ====== |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| Verification | ||
| ============ |
Uh oh!
There was an error while loading. Please reload this page.