ctest_coverage.rst 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. ctest_coverage
  2. --------------
  3. Perform the :ref:`CTest Coverage Step` as a :ref:`Dashboard Client`.
  4. ::
  5. ctest_coverage([BUILD <build-dir>] [APPEND]
  6. [LABELS <label>...]
  7. [RETURN_VALUE <result-var>]
  8. [QUIET]
  9. )
  10. Collect coverage tool results and stores them in ``Coverage.xml``
  11. for submission with the :command:`ctest_submit` command.
  12. The options are:
  13. ``BUILD <build-dir>``
  14. Specify the top-level build directory. If not given, the
  15. :variable:`CTEST_BINARY_DIRECTORY` variable is used.
  16. ``APPEND``
  17. Mark results for append to those previously submitted to a
  18. dashboard server since the last :command:`ctest_start` call.
  19. Append semantics are defined by the dashboard server in use.
  20. ``LABELS``
  21. Filter the coverage report to include only source files labeled
  22. with at least one of the labels specified.
  23. ``RETURN_VALUE <result-var>``
  24. Store in the ``<result-var>`` variable ``0`` if coverage tools
  25. ran without error and non-zero otherwise.
  26. ``QUIET``
  27. Suppress any CTest-specific non-error output that would have been
  28. printed to the console otherwise. The summary indicating how many
  29. lines of code were covered is unaffected by this option.