From 123e00216898b1854e506389b49e1042a1b5bf6d Mon Sep 17 00:00:00 2001 From: Brad King Date: Tue, 21 Jan 2025 14:51:37 -0500 Subject: Help: Document CTEST_NOTES_FILES variable --- Help/command/ctest_submit.rst | 6 ++++-- Help/manual/cmake-variables.7.rst | 1 + Help/variable/CTEST_NOTES_FILES.rst | 5 +++++ 3 files changed, 10 insertions(+), 2 deletions(-) create mode 100644 Help/variable/CTEST_NOTES_FILES.rst diff --git a/Help/command/ctest_submit.rst b/Help/command/ctest_submit.rst index 3b6bf3a..c0e0c80 100644 --- a/Help/command/ctest_submit.rst +++ b/Help/command/ctest_submit.rst @@ -22,7 +22,9 @@ By default all available parts are submitted. The options are: ``PARTS ...`` - Specify a subset of parts to submit. Valid part names are:: + Specify a subset of parts to submit. Valid part names are: + + .. parsed-literal:: Start = nothing Update = ctest_update results, in Update.xml @@ -32,7 +34,7 @@ The options are: Coverage = ctest_coverage results, in Coverage.xml MemCheck = ctest_memcheck results, in DynamicAnalysis.xml and DynamicAnalysis-Test.xml - Notes = Files listed by CTEST_NOTES_FILES, in Notes.xml + Notes = Files listed by :variable:`CTEST_NOTES_FILES`, in Notes.xml ExtraFiles = Files listed by CTEST_EXTRA_SUBMIT_FILES Upload = Files prepared for upload by ctest_upload(), in Upload.xml Submit = nothing diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index 087e0a9..89f67fb 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -738,6 +738,7 @@ Variables for CTest /variable/CTEST_MEMORYCHECK_SUPPRESSIONS_FILE /variable/CTEST_MEMORYCHECK_TYPE /variable/CTEST_NIGHTLY_START_TIME + /variable/CTEST_NOTES_FILES /variable/CTEST_P4_CLIENT /variable/CTEST_P4_COMMAND /variable/CTEST_P4_OPTIONS diff --git a/Help/variable/CTEST_NOTES_FILES.rst b/Help/variable/CTEST_NOTES_FILES.rst new file mode 100644 index 0000000..301b78a --- /dev/null +++ b/Help/variable/CTEST_NOTES_FILES.rst @@ -0,0 +1,5 @@ +CTEST_NOTES_FILES +----------------- + +Specify files for :command:`ctest_submit(PARTS Notes)` to submit +in a :manual:`ctest(1)` dashboard client script. -- cgit v0.12