How to Trace CMakeLists.txt [duplicate]

by

There is no CMake debugger or similar¹. What you can do is:

  1. Read the output of CMake, sometimes it already gives hints like “missing INCLUDE_MYLIB_DIR”). Delete you CMakeCache.txt and/or remove the build directory, to be sure you don’t miss output because the result was cached. Repeat and check whether caching had an influence. You get more warnings (those meant for the author/developer of the CMake script, not for the user) with -Wdev. More helpful options are --warn-uninitialized, --warn-unused-vars and --check-system-vars, see the documentation for more details.

  2. Check the generated files like the CMakeCache.txt and additional files you generate like a config.h or input files for Doxygen. Variables with values you expect different, are indicators for further research.

  3. Have a look into CMakeError.log and CMakeOuput.log in the CMakeFiles sub-directory. Unfortunately, many test do not write into these files, but some do. For example C compiler runs put the compiler output there, which helps to find the problem with unintended flags or wrong (cross-)compilers.

  4. Debug with printf. This means when you roughly know where you problem is located, output intermediate variables with message. That is helpful, when you don’t know how a branch or a sub-expression (a part of a expression with AND or OR) is evaluated. Further you can put messages like “in branch where mylib version is > 3.2” inside to follow the workflow.

  5. Reduce complexity. Throw everything out you don’t know, until your problem vanishes. Add the stuff again until the problem reappears. Sometimes it is easier to start a new module to reproduce the problem with a minimal example. Surprisingly, this often helps to pinpoint the problem.

  6. Debug with --debug-output (for debug output) --trace (complete trace) and --trace-expand (trace and expanded variables). For these it is extremely helpful to make progress with point 5., because otherwise the output will flood you.

¹Well, there are the steveire’s CMake Daemon Tools. I haven’t used them myself, but they claim to offer possibilities for introspection that seem to be pretty close to a debugger.
Edit: They are now called CMake-server and are going to be part of CMake 3.7. You can expect that many tools and IDEs will pick this up and improve the way we develop CMake.

More Related Contents:

  1. What is the proper way to use `pkg-config` from `cmake`?
  2. CMake does not find includes / libraries
  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. How to modify environment variables passed to custom CMake target?
  7. Copy file from source directory to binary directory using CMake
  8. Find package Eigen3 for CMake
  9. CMake share library with multiple executables
  10. Listing include_directories in CMake
  11. Recursive list of LINK_LIBRARIES in CMake
  12. Building a tool immediately so it can be used later in same CMake run
  13. How to instruct CMake to use the build architecture compiler
  14. MacOS, CMake and OpenMP
  15. What is CMake equivalent of ‘configure –prefix=DIR && make all install ‘?
  16. What is a CMake generator?
  17. Add Source in a subdirectory to a cmake project
  18. How to detect if current scope has a parent in CMake?
  19. Making a CMake library accessible by other CMake packages automatically
  20. CMake: How to build external projects and include their targets
  21. CMake how to set the build directory to be different than source directory
  22. Passing compiler options in CMake
  23. how to add prebuilt object files to executable in cmake
  24. spacing in -D option in cmake
  25. How do I include a literal double quote in a custom CMake command?
  26. Check CMake Cache Variable in Toolchain File
  27. Postpone making custom target until install
  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