What is the modern method for setting general compile flags in CMake?

by

For modern CMake (versions 2.8.12 and up) you should use target_compile_options, which uses target properties internally.

CMAKE_<LANG>_FLAGS is a global variable and the most error-prone to use. It also does not support generator expressions, which can come in very handy.

add_compile_options is based on directory properties, which is fine in some situations, but usually not the most natural way to specify options.

target_compile_options works on a per-target basis (through setting the COMPILE_OPTIONS and INTERFACE_COMPILE_OPTIONS target properties), which usually results in the cleanest CMake code, as the compile options for a source file are determined by which project the file belongs to (rather than which directory it is placed in on the hard disk). This has the additional advantage that it automatically takes care of passing options on to dependent targets if requested.

Even though they are little bit more verbose, the per-target commands allow a reasonably fine-grained control over the different build options and (in my personal experience) are the least likely to cause headaches in the long run.

In theory, you could also set the respective properties directly using set_target_properties, but target_compile_options is usually more readable.

For example, to set the compile options of a target foo based on the configuration using generator expressions you could write:

target_compile_options(foo PUBLIC "$<$<CONFIG:DEBUG>:${MY_DEBUG_OPTIONS}>")
target_compile_options(foo PUBLIC "$<$<CONFIG:RELEASE>:${MY_RELEASE_OPTIONS}>")

The PUBLIC, PRIVATE, and INTERFACE keywords define the scope of the options. E.g., if we link foo into bar with target_link_libraries(bar foo):

  • PRIVATE options will only be applied to the target itself (foo) and not to other libraries (consumers) linking against it.
  • INTERFACE options will only be applied to the consuming target bar
  • PUBLIC options will be applied to both, the original target foo and the consuming target bar

More Related Contents:

  1. What’s the CMake syntax to set and use variables?
  2. What is the proper way to use `pkg-config` from `cmake`?
  3. CMake: In which order are files parsed (cache, toolchain, etc.)?
  4. How to specify a compiler in CMake?
  5. Why is cmake file GLOB evil?
  6. What use is find_package() when you need to specify CMAKE_MODULE_PATH?
  7. How to modify environment variables passed to custom CMake target?
  8. How do I change the working directory for my program
  9. Copy file from source directory to binary directory using CMake
  10. Find package Eigen3 for CMake
  11. CMake share library with multiple executables
  12. CMake : How to get the name of all subdirectories of a directory?
  13. Building a tool immediately so it can be used later in same CMake run
  14. MacOS, CMake and OpenMP
  15. What is CMake equivalent of ‘configure –prefix=DIR && make all install ‘?
  16. How to detect if current scope has a parent in CMake?
  17. Making a CMake library accessible by other CMake packages automatically
  18. CMake: How to build external projects and include their targets
  19. cmake: Selecting a generator within CMakeLists.txt
  20. Set CFLAGS and CXXFLAGS options using CMake
  21. Passing compiler options in CMake
  22. how to add prebuilt object files to executable in cmake
  23. Setting CMAKE_INSTALL_PREFIX from CMakeLists.txt file
  24. spacing in -D option in cmake
  25. How do I include a literal double quote in a custom CMake command?
  26. Postpone making custom target until install
  27. Specifying build directory within CMakeLists file
  28. How to list all CMake build options and their default values?
  29. Passing an argument to CMAKE via command prompt
  30. CMake: how to change compiler for individual target

Leave a Comment