Packaging requirements

  • Git (> 1.9.1)
  • Thrift compiler (> 0.9.2) required to generate python and javascript files

  • Build logging

    • It is possible to build package without the ld-logger. In that case no automatic compilation database generation is done. To build ld-logger 32 and 64 bit versions automatically, gcc multilib and make is required.
    • Compilation command database can be generated with CMake during the build (run cmake with the CMAKE_EXPORT_COMPILE_COMMANDS option). CodeChecker can process the generated compilation database at runtime.

  • Other external dependencies are automatically downloaded and copied to the necessary directories in the package.

Runtime requirements

Basic

Javascript dependencies are automatically downloaded based on the ext_source_deps_config.json file during package build.

  • Clang Static analyzer (latest stable or trunk)
  • Clang Tidy (available in the clang tools extra repository trunk)
  • Python3 (> 3.6)
  • Alembic (>= 0.8.2) database migration support is available only for PostgreSQL database
  • SQLAlchemy (>= 1.0.9) Python SQL toolkit and Object Relational Mapper, for supporting multiple database backends
  • Thrift python modules. Cross-language service building framework to handle data transfer for report storage and result viewer clients
  • Codemirror (MIT) - view source code in the browser
  • Jsplumb (community edition, MIT) - draw bug paths
  • Marked (BSD) - view documentation for checkers written in markdown (generated dynamically)
  • Dojotoolkit (BSD) - main framework for the web UI
  • Highlightjs (BSD) - required for highlighting the source code

Install newer clang versions (Ubuntu 18.04 Bionic)

If clang-7 or clang-tidy-7 package is not available for your Debian or Ubuntu distribution yet you can use the official llvm packages.

apt-get update && apt-get install -y software-properties-common wget && \
    wget -qO - https://apt.llvm.org/llvm-snapshot.gpg.key| apt-key add - && \
    add-apt-repository "deb http://apt.llvm.org/bionic/ llvm-toolchain-bionic-7 main"

sudo apt-get install clang-7 clang-tidy-7

# Set clang and clang-tidy to point to clang-7 and clang-tidy-7
update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-7 100 && \
update-alternatives --install /usr/bin/clang clang /usr/bin/clang-7 100 && \
update-alternatives --install /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-7 100

PostgreSQL

For the additional PostgreSQL dependencies see the PostgreSQL setup documentation.