Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
141bc62
change to latest main
RolandJentschETAS Apr 9, 2026
ddadfe0
Merge branch 'main' into improvement_independend_repositories_sphinx
RolandJentschETAS Apr 9, 2026
b4a7b2f
fix format
RolandJentschETAS Apr 9, 2026
5fe4acd
fix bazel lock
RolandJentschETAS Apr 9, 2026
97788b4
udpdate lockfile
RolandJentschETAS Apr 14, 2026
ea9d107
update docs as code
RolandJentschETAS Apr 14, 2026
30725af
increase dac to 4.0.1
RolandJentschETAS Apr 16, 2026
c3aef4e
latest score main
RolandJentschETAS Apr 16, 2026
0b0ac6c
add documentation for the two components
RolandJentschETAS Apr 17, 2026
42e69c7
add copyrigths
RolandJentschETAS Apr 17, 2026
5edb9a8
add empty lines
RolandJentschETAS Apr 17, 2026
9b1b278
remove docs build from code build
RolandJentschETAS Apr 17, 2026
df9c7bf
another remove
RolandJentschETAS Apr 17, 2026
22d8059
remove docs build also from code coverage build
RolandJentschETAS Apr 17, 2026
bd4c817
use process vsion 1.5.3 instead of override
RolandJentschETAS Apr 17, 2026
cf4090a
go back because of bazel lock issues
RolandJentschETAS Apr 17, 2026
5a1e693
add comment on exclude statement on build workflows
RolandJentschETAS Apr 21, 2026
9998d7f
Update score/datarouter/docs/index.rst
RolandJentschETAS Apr 21, 2026
7d3e162
Update score/mw/docs/index.rst
RolandJentschETAS Apr 21, 2026
2ce339c
move docs one folder down
RolandJentschETAS Apr 21, 2026
cbbaf2f
move comments up
RolandJentschETAS Apr 21, 2026
a154296
Update docs/features/logging/architecture/index.rst
RolandJentschETAS Apr 21, 2026
88a30c9
try to go to old tooling
RolandJentschETAS Apr 22, 2026
63b7c9d
bazel lock
RolandJentschETAS Apr 22, 2026
a3fefbb
lock again
RolandJentschETAS Apr 22, 2026
eba7406
Rollback
RolandJentschETAS Apr 22, 2026
62b6741
Merge branch 'main' into improvement_independend_repositories_sphinx
Copilot Apr 28, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,8 @@ jobs:

- name: Build with Bazel
run: |
bazel build --lockfile_mode=error --config x86_64-linux //...
# Exclude targets that are not expected to build the source code, e.g. documentation, format check, live preview, product integration tests.
# Please execute "bazel query 'kind(rule, //:*)'" to find the list of all excluded targets by this option.
bazel build --lockfile_mode=error --config x86_64-linux -- \
//... \
-//:*
4 changes: 3 additions & 1 deletion .github/workflows/coverage_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,7 @@ jobs:
coverage-report:
uses: eclipse-score/cicd-workflows/.github/workflows/cpp-coverage.yml@main
with:
bazel-target: "//..."
# The option -//:* exclude targets that are not expected to build the source code, e.g. documentation, format check, live preview, product integration tests.
Comment thread
RolandJentschETAS marked this conversation as resolved.
# Please execute "bazel query 'kind(rule, //:*)'" to find the list of all excluded targets by this option.
bazel-target: "//... -//:*"
extra-bazel-flags: "--lockfile_mode=error"
2 changes: 1 addition & 1 deletion BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,5 @@ docs(
"@score_platform//:needs_json",
"@score_process//:needs_json",
],
source_dir = "docs",
source_dir = ".",
)
61 changes: 61 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# *******************************************************************************
# 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
# *******************************************************************************

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html


# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "Logging"
project_url = "https://eclipse-score.github.io/logging/"
project_prefix = "LOG_"
author = "S-CORE"
version = "0.1"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

root_doc = "index"

html_context = {
"doc_path": "",
}

extensions = [
"sphinx_design",
"sphinx_needs",
"sphinxcontrib.plantuml",
"score_plantuml",
"score_metamodel",
"score_draw_uml_funcs",
"score_source_code_linker",
"score_layout",
]

exclude_patterns = [
# The following entries are not required when building the documentation via 'bazel
# build //docs:docs', as that command runs in a sandboxed environment. However, when
# building the documentation via 'bazel run //docs:incremental' or esbonio, these
# entries are required to prevent the build from failing.
"bazel-*",
".venv_docs",
]

templates_path = ["templates"]

# Enable numref
numfig = True
43 changes: 43 additions & 0 deletions docs/features/logging/architecture/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Logging Module View
###################


.. mod:: Logging
:id: mod__logging_repo
:status: valid
:safety: ASIL_B
:security: YES
:includes: comp__data_router, comp__mw_logging

The logging module provides a standardized logging framework for C++ and Rust projects using Bazel build system. It includes components for log routing allowing for flexible log management and integration with various logging backends. The module is designed to be extensible and configurable to meet the needs of different applications and environments.

.. mod_view_sta:: Logging module view
:id: mod_view_sta__logging__logging_view
:includes: comp__data_router, comp__mw_logging
:belongs_to: mod__logging

.. needarch::
:scale: 50
:align: center

{{ draw_module(need(), needs) }}



Logging Feature Architecture
############################

.. feat_arc_sta:: Feature Architecture Logging
:id: feat_arc_sta__logging__static_view
:security: YES
:safety: ASIL_B
:status: valid
:includes: logic_arc_int__logging__logging
:fulfils: feat_req__logging__log_sources_user_app
:belongs_to: feat__logging

.. needarch::
:scale: 50
:align: center

{{ draw_component(need(), needs) }}
10 changes: 4 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,13 +81,11 @@ Example:
This enables conditional behavior (e.g., choosing ``clang-tidy`` for C++ or ``clippy`` for Rust).

Decision records
----------------

.. TODO: move decision records to proper location once docs are made.
Additional documentation
------------------------

.. toctree::
:maxdepth: 1
:glob:

design_decisions/explicit_init.rst
/docs/features/logging/architecture/index
/docs/design_decisions/explicit_init
35 changes: 35 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
..
# *******************************************************************************
# 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
# *******************************************************************************

Logging Module
##############

Module Documents
================

.. toctree::
:titlesonly:
:maxdepth: 2

./docs/index

Components
==========

.. toctree::
:titlesonly:
:maxdepth: 1
:glob:

./score/**/docs/index
29 changes: 29 additions & 0 deletions score/datarouter/docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
..
# *******************************************************************************
# Copyright (c) 2026 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
# *******************************************************************************


Data Router Documentation
=========================

This section is reserved for data router-specific documentation.

.. comp:: Data Router
:id: comp__data_router
:security: YES
:safety: ASIL_B
:status: valid
:implements: logic_arc_int__logging__logging
:belongs_to: feat__logging

This is the datarouter component responsible for routing log messages to remote Diagnostics Log and Trace (DLT) backend.
28 changes: 28 additions & 0 deletions score/mw/log/docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
..
Comment thread
rmaddikery marked this conversation as resolved.
# *******************************************************************************
# Copyright (c) 2026 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
# *******************************************************************************

Logging Documentation
========================

This section is reserved for middleware-specific documentation.

.. comp:: Logging Component
:id: comp__mw_logging
:security: YES
:safety: ASIL_B
:status: valid
:implements: logic_arc_int__logging__logging
:belongs_to: feat__logging

This is the logging component library responsible for selecting the appropriate log sinks based on configuration at runtime. It can perform tasks such as log formatting, filtering, and composite backend selection based on runtime context and configuration. The logging component is designed to be extensible, allowing for custom logging backend to be added as needed.
Loading