CMake Targets

From K-3D

Jump to: navigation, search

K-3D builds created by cmake include many build targets that are useful for development, debugging, and maintenance. Some of the most useful include:

  • make help - Lists every make target (many more than listed here).
  • make run - Runs K-3D from the build directory. Saves you the trouble of having to install before you can do any testing.
  • make run-debug - Starts a debugging session with gdb for testing K-3D in the build directory, without having to install. In the gdb session that opens, just do "run" to get the binary going - all options will already be set.
  • make run-strace - Runs K-3D from from the build directory using the strace utility, which logs system calls.
  • make run-valgrind - Runs K-3D from the build directory using valgrind.
  • make run-nui - Runs K-3D from the build directory using the NUI user interface plugin.
  • make run-pyui - Runs K-3D from the build directory using the PYUI user interface plugin.
  • make run-qtui - Runs K-3D from the build directory using the QTUI user interface plugin.
  • make docs-doxygen - Generates source documentation using doxygen. The output files will be in docs/doxygen/html. A great way to browse the source tree!
  • make changelog-branch - Generates the K-3D ChangeLog from the CVS history for the current CVS branch. Maintainers only! Requires cvs2cl.
  • make changelog-trunk - Generates the K-3D ChangeLog from the CVS history for CVS trunk. Maintainers only! Requires cvs2cl.
  • make tag-branch - Branches CVS using the version in the top-level CMakeLists.txt. Maintainers only!
  • make tag-trunk - Tags CVS using the version in the top-level CMakeLists.txt. Maintainers only!
  • make test - Runs the regression test suite.
  • make install - Installs built binaries to their configured destination directory on the local system.
  • make package - Generate installation packages from the built binaries for distribution (package types depend on the local platform type).
  • make edit_cache - Re-run cmake using cached user options.

You can add "/fast" to any of these targets to skip dependency checking - for example, a useful time-saver is 

$ make run/fast

... to run the program when you know all dependencies are up-to-date.

Retrieved from "http://www.k-3d.org/wiki/CMake_Targets"
Personal tools