Skip to content

README.md

Latest commit

 

History

History
69 lines (50 loc) · 1.98 KB

README.md

File metadata and controls

69 lines (50 loc) · 1.98 KB
Raw

Cppcheck Configuration for VoidLight-Framework

This directory contains the cppcheck configuration and scripts used by the repository's static-analysis workflow.

Quick Start

Linux/macOS

cd tests/cppcheck
./cppcheck_focused.sh

Windows

cd tests\cppcheck
cppcheck_focused.bat

Configuration

cppcheck_lib.cfg

Project-specific library definitions that keep cppcheck aligned with the codebase's macros and helper APIs.

cppcheck_suppressions.txt

Focused-analysis suppressions for known cppcheck false positives and irrelevant warnings.

The focused scripts use both cppcheck_lib.cfg and cppcheck_suppressions.txt. The full scripts intentionally remain unsuppressed so they can expose the complete analyzer surface when a broader manual pass is requested.

Scripts

  • run_cppcheck.sh - Full analysis for Linux/macOS
  • run_cppcheck.bat - Full analysis for Windows
  • cppcheck_focused.sh - Focused analysis for Linux/macOS
  • cppcheck_focused.bat - Focused analysis for Windows

Output

Full scripts write timestamped XML and text summaries to ../../test_results/. Focused scripts print a terminal summary and do not persist reports.

Usage Examples

cd tests/cppcheck
./run_cppcheck.sh
./cppcheck_focused.sh

Build Integration

find_program(CPPCHECK cppcheck)
if(CPPCHECK)
    add_custom_target(cppcheck
        COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/cppcheck/run_cppcheck.sh
        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tests/cppcheck
        COMMENT "Running cppcheck analysis"
    )
endif()

Maintenance

When project-specific macros or helper functions change:

  1. Update cppcheck_lib.cfg
  2. Re-run the focused analysis
  3. Extend the library config only with targeted entries

If cppcheck starts reporting false positives, prefer a focused library-config update when the issue is macro/API modeling. Add suppressions only for confirmed analyzer noise that should stay filtered from the focused quality gate.