diff --git a/.doorstop.yml b/.doorstop.yml index fecac25..47d1600 100644 --- a/.doorstop.yml +++ b/.doorstop.yml @@ -1,10 +1,10 @@ -# Doorstop-Konfiguration fuer demo-epb +# Doorstop configuration for demo-epb # -# Bidirektionale Traceability: -# SYS-XXX -> SA-XXX (System-Anforderung wird durch System-Arch abgedeckt) -# SA-XXX -> SWE-XXX (System-Arch verfeinert auf Software-Anforderung) -# SWE-XXX -> SWA-XXX (Software-Anforderung wird durch Software-Arch abgedeckt) -# SWA-XXX -> Code (via @arch Tag im Quellcode) +# Bidirectional traceability: +# SYS-XXX -> SA-XXX (system requirement covered by system arch) +# SA-XXX -> SWE-XXX (system arch refined to software requirement) +# SWE-XXX -> SWA-XXX (software requirement covered by software arch) +# SWA-XXX -> Code (via @arch tag in source code) settings: digits: 3 diff --git a/.gitea/workflows/release.yml b/.gitea/workflows/release.yml index 827c0e1..4ca6bff 100644 --- a/.gitea/workflows/release.yml +++ b/.gitea/workflows/release.yml @@ -130,11 +130,11 @@ jobs: - All 46 unit tests green (Linux runner required) - Coverage measured with gcov/lcov - - Statische Analyse mit Cppcheck (0 Findings) + - Static analysis with Cppcheck (0 findings) - MISRA C:2012 compliance confirmed (1 Advisory deviation) - - Traceability verified bidirectionally (50 Items) + - Traceability verified bidirectionally (50 items) - ## Referenzen + ## References - Methodology: https://gitea.slohmaier.com/slohmaier/dev-process - Commit: ${{ github.sha }} @@ -177,7 +177,7 @@ jobs: run: | DEPLOY=/var/www/pages/demo-epb if [ ! -d "$DEPLOY" ]; then - echo "Mount $DEPLOY nicht da — Runner-Config pruefen. Skip." + echo "Mount $DEPLOY missing - check runner config. Skip." exit 0 fi BUNDLE="release/demo-epb-${TAG}" diff --git a/Doxyfile b/Doxyfile index 6fd3363..32f528c 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,4 +1,4 @@ -# Minimal Doxygen-Konfiguration fuer demo-epb +# Minimal Doxygen configuration for demo-epb # Generiert HTML-API-Dokumentation aus src/ PROJECT_NAME = "demo-epb" diff --git a/src/stubs/diag_manager.h b/src/stubs/diag_manager.h index ed9a8a1..14b78df 100644 --- a/src/stubs/diag_manager.h +++ b/src/stubs/diag_manager.h @@ -1,6 +1,6 @@ /** * @file diag_manager.h - * @brief UDS-Diagnose nach ISO 14229. + * @brief UDS diagnostics per ISO 14229. * * @arch SWA-008 * @reqs SWE-018 SWE-019 diff --git a/src/stubs/display_manager.h b/src/stubs/display_manager.h index b75ceea..2199cbc 100644 --- a/src/stubs/display_manager.h +++ b/src/stubs/display_manager.h @@ -1,6 +1,6 @@ /** * @file display_manager.h - * @brief LED + CAN-Status-Frame Steuerung. + * @brief LED + CAN status frame control. * * @arch SWA-007 * @reqs SWE-020 SWE-021 diff --git a/src/stubs/inclinometer.h b/src/stubs/inclinometer.h index 63c2945..044d2e6 100644 --- a/src/stubs/inclinometer.h +++ b/src/stubs/inclinometer.h @@ -1,6 +1,6 @@ /** * @file inclinometer.h - * @brief Inclinometer-Tiefpass-Filter. + * @brief Inclinometer low-pass filter. * * @arch SWA-005 * @reqs SWE-024 diff --git a/src/stubs/logger.h b/src/stubs/logger.h index 3e1a5e1..f340889 100644 --- a/src/stubs/logger.h +++ b/src/stubs/logger.h @@ -1,6 +1,6 @@ /** * @file logger.h - * @brief Logger — Ringpuffer + EEPROM-Persistenz. + * @brief Logger - ring buffer + EEPROM persistence. * * @arch SWA-010 * diff --git a/src/stubs/service_mode.h b/src/stubs/service_mode.h index 4ae7d10..a84c5cf 100644 --- a/src/stubs/service_mode.h +++ b/src/stubs/service_mode.h @@ -1,6 +1,6 @@ /** * @file service_mode.h - * @brief Service-Modus fuer Werkstatt (Bremsbelag-Wechsel). + * @brief Service mode for workshop (brake-pad change). * * @arch SWA-009 * @reqs SWE-016 SWE-017 diff --git a/src/stubs/wheel_speed_plausi.h b/src/stubs/wheel_speed_plausi.h index c448206..6110569 100644 --- a/src/stubs/wheel_speed_plausi.h +++ b/src/stubs/wheel_speed_plausi.h @@ -1,6 +1,6 @@ /** * @file wheel_speed_plausi.h - * @brief Wheel-Speed-Plausibilisierung + Stillstands-Erkennung. + * @brief Wheel-speed plausibility + standstill detection. * * @arch SWA-004 * @reqs SWE-022 SWE-023 diff --git a/tests/unit/test_safety_manager.c b/tests/unit/test_safety_manager.c index 9b6d6e5..c6e7a33 100644 --- a/tests/unit/test_safety_manager.c +++ b/tests/unit/test_safety_manager.c @@ -205,7 +205,7 @@ static void test_hillhold_armed_to_idle_if_grade_drops(void) TEST_END(); } -/* ---- Mutually exclusive: nicht in beiden Modi gleichzeitig ---- */ +/* ---- Mutually exclusive: never in both modes at once ---- */ /* ---- Drive-Away-Assist (SWE-011 + SWE-012) ---- */ diff --git a/tests/unit_test_framework.h b/tests/unit_test_framework.h index d66b836..ffc07de 100644 --- a/tests/unit_test_framework.h +++ b/tests/unit_test_framework.h @@ -1,10 +1,10 @@ /** * @file unit_test_framework.h - * @brief Minimaler Test-Runner fuer demo-epb. + * @brief Minimal test runner for demo-epb. * - * In Produktion wuerde hier CppUTest oder Google Test stehen - * (siehe docs/SWE-Plan.docx, Abschnitt 7). Fuer die Demo - * bleibt das Framework klein, damit es ohne externe Abhaengigkeiten baut. + * In production CppUTest or Google Test would go here + * (see docs/SWE-Plan.docx, section 7). For the demo, the framework + * stays small so it builds without external dependencies. */ #ifndef UNIT_TEST_FRAMEWORK_H #define UNIT_TEST_FRAMEWORK_H diff --git a/tools/generate_test_report.py b/tools/generate_test_report.py index eca8f98..e3963de 100644 --- a/tools/generate_test_report.py +++ b/tools/generate_test_report.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 """ -Erzeugt einen Test-Summary-Report aus dem Output unserer Unit-Tests. +Generate a test-summary report from the output of our unit tests. Reads the test-output file (build/test-output.txt) and produces: - build/test-report.md diff --git a/tools/render_plantuml.py b/tools/render_plantuml.py index 2601254..e4071d1 100644 --- a/tools/render_plantuml.py +++ b/tools/render_plantuml.py @@ -1,9 +1,9 @@ #!/usr/bin/env python3 """ -Rendert alle @startuml ... @enduml Bloecke aus arch/**/*.md als SVG. +Render all @startuml ... @enduml blocks from arch/**/*.md as SVG. -Verwendet einen erreichbaren PlantUML-HTTP-Server (Default: www.plantuml.com). -In CI kann die Server-URL ueber PLANTUML_SERVER ueberschrieben werden. +Uses a reachable PlantUML HTTP server (default: www.plantuml.com). +In CI the server URL can be overridden via PLANTUML_SERVER. Output: docs/diagrams/-.svg