ctest_submit.rst 2.5 KB

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