ctest_build.rst 1.3 KB

12345678910111213141516171819202122232425262728293031323334
  1. ctest_build
  2. -----------
  3. Build the project.
  4. ::
  5. ctest_build([BUILD build_dir] [TARGET target] [RETURN_VALUE res]
  6. [APPEND][NUMBER_ERRORS val] [NUMBER_WARNINGS val])
  7. Builds the given build directory and stores results in Build.xml. If
  8. no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used.
  9. The TARGET variable can be used to specify a build target. If none is
  10. specified, the "all" target will be built.
  11. The RETURN_VALUE option specifies a variable in which to store the
  12. return value of the native build tool. The NUMBER_ERRORS and
  13. NUMBER_WARNINGS options specify variables in which to store the number
  14. of build errors and warnings detected.
  15. The APPEND option marks results for append to those previously
  16. submitted to a dashboard server since the last ctest_start. Append
  17. semantics are defined by the dashboard server in use.
  18. The QUIET option suppresses any CTest-specific non-error output
  19. that would have been printed to the console otherwise. The summary
  20. of warnings / errors, as well as the output from the native build tool
  21. is unaffected by this option.
  22. If set, the contents of the variable CTEST_BUILD_FLAGS are passed as
  23. additional arguments to the underlying build command. This can e.g. be
  24. used to trigger a parallel build using the -j option of make. See
  25. :module:`ProcessorCount` for an example.