Index

A few things to know when in a hurry and you already know the tooling:

• git submodule update --init

• Use init.py to setup the project name, registry address, etc.

• Note the version of the template so updates with a diff are possible later.

Table of Contents

• CMake build system
  • check
  • clang_tidy
  • code
  • coverage
  • doc
    • doxygen
    • sphinx-based
  • flawfinder
  • format
  • line_limit
  • regex_check
  • sanitise
  • test
  • werror
• Deploy
  • GitLab Pages
  • Per-branch documentation review
• Documentation
  • Breathe
  • PlantUML
  • Version
• Docker
  • Managing docker images
    • Helper script
    • Docker targets
    • General advice
      • Version management
      • Using a different repository for images
• Package
  • GNU/Linux AppImage
    • Cross-compiling
  • macOS OSXCross
    • Other architectures
  • Windows Mingw-W64
    • Other architectures

Besides the above, the coverage report generated by lcov gives insight in source code and test code coverage. It is not in the index above because it is built out-of-tree, sphinx isn’t aware of its existence.