CMake Modules

This repository contains common CMake modules. To use it, create a .gitexternals in your project:

# -*- mode: cmake -*-
# CMake/common https://github.com/Eyescale/CMake.git master

Copy GitExternal from this repository to CMake/, and use it in your top-level CMakeLists.txt:

list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/CMake
                              ${PROJECT_SOURCE_DIR}/CMake/common)
include(GitExternal)
include(Common)

Documentation

• Common does a common CMake setup, including:

  • CommonLibrary common_library function to build a shared library using a standard recipe.
  • CommonApplication common_application function to build an application using a standard recipe.
  • CommonCode generates standard header files for the project (api.h, defines.h, version.h).
  • GNUModules: module target to create a GNUModules module and snapshot targets to create GNU modules.
  • GitTargets branch, cut, tag, erase, retag, tarball targets.
  • Compiler: Default compiler flags, useful default warnings and 'safe' C++11 features.
  • GitInfo sets variables with information about the git source tree.

• CommonCTest does a common CTest setup, including

  • Automatically adding all .cpp files as tests
  • Coverage Create code coverage report as html, if ENABLE_COVERAGE is set. Buildyard has 'make Coverage' target to enable this in a separate build, since coverage flags may break downstream projects.
  • CppcheckTargets: cppcheck target for static code analysis. Also adds all cppcheck targets to tests.
  • clangcheckTargets: clangcheck target for clang-check code analysis. Adds all cppcheck targets to tests if ENABLE_CLANGCHECK_TESTS is set.

• DoxygenRule: doxygen target to build documentation into PROJECT_BINARY_DIR/doc. Optional doxygit target to copy result to ../GITHUB_ORGANIZATION/Project-M.m/. Must be included after all targets.

• SubProject: Using a top level simple CMake superproject, several CMake subprojects (which typically depend on each other) can be build. Each subproject is added to the parent superproject with an add_subdirectory( subproject ) directive. To use the SubProject feature, the sub projects should modify their CMake scripts. In the scripts most CMAKE_BINARY_DIR should be changed to PROJECT_BINARY_DIR and CMAKE_SOURCE_DIR should be changed to PROJECT_SOURCE_DIR. A simple sample project can be found at https://github.com/Eyescale/Collage.git, and a complex one at https://github.com/BlueBrain/Livre.git. Users can use "cmake -DINSTALL_PACKAGES=1" during the initial configuration to install known system packages (Ubuntu and OS X only).

• Find scripts for non-CMake projects.