Module Template Documentation#

<Brief description of the module and the implemented feature(s).>

<Further documentation of the module and the implemented feature(s) should be added in the respective sections of the documentation (e.g., feature architecture, safety analysis, security analysis, manuals, etc.) following the provided templates and guidelines.>

Feature Documentation#

The Feature documentation covers the feature-level definition of Base Libraries, including architecture and safety planning artifacts.

Module Documentation#

The Module documentation covers the module-level view, including architecture, safety management documents, and the user manual.

Component Documentation#

The Components documentation provides detailed documentation for each individual library component, including requirements, architecture, and design decisions:

Architecture Modeling Example#

An example of modeling architecture in Sphinx Needs can be found in

Please note, that is not a template for architecture documentation, but an example of how to use Sphinx Needs for architecture modeling. The architecture documentation of the components and features of the module should follow the provided templates and guidelines.

Quick Start - Building and Testing#

Attention

This could also contain just a link to the repository’s README

To build the entire module:

bazel build //src/...

To run all tests:

bazel test //...

To run only unit tests:

bazel test //src/...

To run only component or feature integration tests:

bazel test //tests/...

Module Build Configuration#

The project_config.bzl file at the root of the module defines metadata used by Bazel macros. This file controls build behavior and project-specific settings. It should follow the S-CORE definition. See S-CORE user guide for project_config.bzl for details.

The configuration enables conditional build behavior:

  • Language-specific tools: For C++ code, tools like clang-tidy are used; for Rust code, clippy is used

  • Safety level: The ASIL level affects safety-related build settings and validation

  • Source code languages: The build system optimizes for the configured languages