ctest_submit.rst 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. ctest_submit
  2. ------------
  3. Perform the :ref:`CTest Submit Step` as a :ref:`Dashboard Client`.
  4. ::
  5. ctest_submit([PARTS <part>...] [FILES <file>...]
  6. [RETRY_COUNT <count>]
  7. [RETRY_DELAY <delay>]
  8. [RETURN_VALUE <result-var>]
  9. [QUIET]
  10. )
  11. Submit results to a dashboard server.
  12. By default all available parts are submitted.
  13. The options are:
  14. ``PARTS <part>...``
  15. Specify a subset of parts to submit. Valid part names are::
  16. Start = nothing
  17. Update = ctest_update results, in Update.xml
  18. Configure = ctest_configure results, in Configure.xml
  19. Build = ctest_build results, in Build.xml
  20. Test = ctest_test results, in Test.xml
  21. Coverage = ctest_coverage results, in Coverage.xml
  22. MemCheck = ctest_memcheck results, in DynamicAnalysis.xml
  23. Notes = Files listed by CTEST_NOTES_FILES, in Notes.xml
  24. ExtraFiles = Files listed by CTEST_EXTRA_SUBMIT_FILES
  25. Upload = Files prepared for upload by ctest_upload(), in Upload.xml
  26. Submit = nothing
  27. ``FILES <file>...``
  28. Specify an explicit list of specific files to be submitted.
  29. Each individual file must exist at the time of the call.
  30. ``RETRY_COUNT <count>``
  31. Specify how many times to retry a timed-out submission.
  32. ``RETRY_DELAY <delay>``
  33. Specify how long (in seconds) to wait after a timed-out submission
  34. before attempting to re-submit.
  35. ``RETURN_VALUE <result-var>``
  36. Store in the ``<result-var>`` variable ``0`` for success and
  37. non-zero on failure.
  38. ``QUIET``
  39. Suppress all non-error messages that would have otherwise been
  40. printed to the console.
  41. Submit to CDash Upload API
  42. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  43. ::
  44. ctest_submit(CDASH_UPLOAD <file> [CDASH_UPLOAD_TYPE <type>])
  45. This second signature is used to upload files to CDash via the CDash
  46. file upload API. The api first sends a request to upload to CDash along
  47. with a content hash of the file. If CDash does not already have the file,
  48. then it is uploaded. Along with the file, a CDash type string is specified
  49. to tell CDash which handler to use to process the data.