summaryrefslogtreecommitdiffstats
path: root/Help/guide
diff options
context:
space:
mode:
authorJoseph Snyder <joe.snyder@kitware.com>2021-09-27 14:11:17 (GMT)
committerJoseph Snyder <joe.snyder@kitware.com>2021-09-27 14:11:17 (GMT)
commitf55a02a26e203f09282e1e7e693b6b5afeca966c (patch)
treee9fb54f640da7a636a96ace911e710bf1635a912 /Help/guide
parentb0c2aeaab457a43f8dc4cc89ec9c80f2c49a3929 (diff)
downloadCMake-f55a02a26e203f09282e1e7e693b6b5afeca966c.zip
CMake-f55a02a26e203f09282e1e7e693b6b5afeca966c.tar.gz
CMake-f55a02a26e203f09282e1e7e693b6b5afeca966c.tar.bz2
Tutorial: Enhance CTestConfig info in Step 8
Add a copy of the CTestConfig.cmake from Step 9 into the directory for Step 8. Expand the information about the contents of the CTestConfig file and write a brief explanation of where on CDash to acquire the CTestConfig file for a specific project. CMake Issue: #22663
Diffstat (limited to 'Help/guide')
-rw-r--r--Help/guide/tutorial/Adding Support for a Testing Dashboard.rst20
-rw-r--r--Help/guide/tutorial/Step8/CTestConfig.cmake7
2 files changed, 24 insertions, 3 deletions
diff --git a/Help/guide/tutorial/Adding Support for a Testing Dashboard.rst b/Help/guide/tutorial/Adding Support for a Testing Dashboard.rst
index 26aae4f..c6e0fd0 100644
--- a/Help/guide/tutorial/Adding Support for a Testing Dashboard.rst
+++ b/Help/guide/tutorial/Adding Support for a Testing Dashboard.rst
@@ -28,9 +28,23 @@ With:
The :module:`CTest` module will automatically call ``enable_testing()``, so we
can remove it from our CMake files.
-We will also need to create a ``CTestConfig.cmake`` file in the top-level
-directory where we can specify the name of the project and where to submit the
-dashboard.
+We will also need to acquire a ``CTestConfig.cmake`` file to be placed in the
+top-level directory where we can specify information to CTest about the
+project. It contains:
+
+* The project name
+
+* The project "Nightly" start time
+
+ * The time when a 24 hour "day" starts for this project.
+
+* The URL of the CDash instance where the submission's generated documents
+ will be sent
+
+One has been provided for you in this directory. It would normally be
+downloaded from the ``Settings`` page of the project on the CDash
+instance that will host and display the test results. Once downloaded from
+CDash, the file should not be modified locally.
.. literalinclude:: Step9/CTestConfig.cmake
:caption: CTestConfig.cmake
diff --git a/Help/guide/tutorial/Step8/CTestConfig.cmake b/Help/guide/tutorial/Step8/CTestConfig.cmake
new file mode 100644
index 0000000..73efdb1
--- /dev/null
+++ b/Help/guide/tutorial/Step8/CTestConfig.cmake
@@ -0,0 +1,7 @@
+set(CTEST_PROJECT_NAME "CMakeTutorial")
+set(CTEST_NIGHTLY_START_TIME "00:00:00 EST")
+
+set(CTEST_DROP_METHOD "http")
+set(CTEST_DROP_SITE "my.cdash.org")
+set(CTEST_DROP_LOCATION "/submit.php?project=CMakeTutorial")
+set(CTEST_DROP_SITE_CDASH TRUE)