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)
Part 1: The Basics
Part 2: Practical CMake – Getting Your Hands Dirty with CMake
Part 3: Mastering the Details

Chapter 8, Executing Custom Tasks with CMake

  1. Commands that are added with add_custom_command are executed at build time, while commands that are added with execute_process are executed at configuration time.
  2. One signature is used to create custom build steps, while the other is used to generate files.
  3. Only POST_BUILD is reliably supported across all generators.
  4. Variables can be defined either as ${VAR} or as @VAR@.
  5. Variable substitution can be controlled by either passing @ONLY, which only replaces variables defined as @VAR@, or by specifying the COPYONLY option, which does not perform any substitution at all.
  6. With cmake -E, common tasks can be executed directly. With cmake -P, .cmake files can be executed as scripts.