Book Image

CMake Best Practices

By : Dominik Berner, Mustafa Kemal Gilor
5 (2)
Book Image

CMake Best Practices

5 (2)
By: Dominik Berner, Mustafa Kemal Gilor

Overview of this book

CMake is a powerful tool used to perform a wide variety of tasks, so finding a good starting point for learning CMake is difficult. This book cuts to the core and covers the most common tasks that can be accomplished with CMake without taking an academic approach. While the CMake documentation is comprehensive, it is often hard to find good examples of how things fit together, especially since there are lots of dirty hacks and obsolete solutions available on the internet. This book focuses on helping you to tie things together and create clean and maintainable projects with CMake. You'll not only get to grips with the basics but also work through real-world examples of structuring large and complex maintainable projects and creating builds that run in any programming environment. You'll understand the steps to integrate and automate various tools for improving the overall software quality, such as testing frameworks, fuzzers, and automatic generation of documentation. And since writing code is only half of the work, the book also guides you in creating installers and packaging and distributing your software. All this is tailored to modern development workflows that make heavy use of CI/CD infrastructure. By the end of this CMake book, you'll be able to set up and maintain complex software projects using CMake in the best way possible.
Table of Contents (22 chapters)
1
Part 1: The Basics
5
Part 2: Practical CMake – Getting Your Hands Dirty with CMake
14
Part 3: Mastering the Details

Technical requirements

As with the previous chapters, the examples are tested with CMake 3.21 and run on any of the following compilers:

  • GCC9 or newer
  • Clang 12 or newer
  • MSVC 19 or newer

Some of the examples for code coverage, sanitizers, and static code analysis require GCC or Clang to run and will not work with MSVC. For running Clang on Windows, have a look at Chapter 8, Executing Custom Tasks with CMake, where toolchain files are introduced. Some examples need the Catch2 unit testing suite installed to compile. Some examples pull dependencies from various online locations, so an internet connection is required as well.

In addition to a working compiler, the following software is used for the examples:

  • Gcov and Gcovr for the examples on code coverage
  • Cppcheck, Cpplint, and include-what-you-use for the examples on static code analyzers

All examples and source code are available on the GitHub repository of this book at https://github.com...