diff --git a/cmake/SimpleTesting/README.md b/cmake/SimpleTesting/README.md index b63c95bb96db..0426aaebfaa4 100644 --- a/cmake/SimpleTesting/README.md +++ b/cmake/SimpleTesting/README.md @@ -1,20 +1,3 @@ -CMake File Structure -==================== -This CMake structure attempts to capture the structure of the original -`TFW_testing_single_configure_prototype` that is used by the current / old Trilinos -Pull-Request (PR) framework. - -**Note**: _Trilinos uses the **`pull_request_changes`** branch from this repository_. - -Specifically, this new configuration will replace the existing `simple_testing.cmake` -script. - -This diagram describes the current structure of the CMake files and how they -interact with each other. -
- CMake Structure Diagram -
- CMake Files ----------- @@ -32,42 +15,6 @@ CMake Files The _guarded_ files use the CMake command [`include_guard()`][1] which should prevent that file from being include more than once in an include chain. -Options and Variables (`simple_testing.cmake`) ----------------------------------------------- -The `simple_testing.cmake` file has a number of optional parameters that can be sent into the -CMake system via `-D:BOOL=` parameters: - -| Option | Required? | Default | PR Override | Purpose | -|----------------------------|:---------:|---------------------------------------------|-------------|----------------------------------| -| `build_name` | YES | N/A | YES | Sets `CTEST_BUILD_NAME` | -| `ctest_submit_retry_count` | NO | 5 | | | -| `ctest_submit_retry_delay` | NO | 3 | | | -| `dashboard_model` | NO | `Experimental` | YES but NO | Set to the same value as default | -| `dashboard_track` | NO | `Experimental` | YES but NO | Set to the same value as default | -| `skip_by_parts_submit` | NO | `ON` | YES | | -| `skip_clean_build_dir` | NO | `ON` | | | -| `skip_single_submit` | NO | `ON` | | | -| `skip_update_step` | NO | `OFF` | YES | | -| `skip_upload_config_files` | NO | `OFF` | | | -| `PARALLEL_LEVEL` | NO | _num cores_ | YES | | -| `TEST_PARALLEL_LEVEL` | NO | `${PARALLEL_LEVEL}` | YES | | -| `build_root` | NO | `${CTEST_SOURCE_DIRECTORY}/nightly_testing` | | | -| `build_dir` | NO | `${build_root}/${CTEST_BUILD_NAME}` | YES | The CMake build dir | -| `configure_script` | YES | N/A | YES | See note below table | -| `package_enables` | YES | N/A | YES | `packageEnables.cmake` | -| `subprojects_file` | YES | N/A | YES | `package_subproject_list.cmake` | - -1. `configure_script` points to the `cmake/std/PullRequestLinuxTestingSettings.cmake` file. - - Example: `${WORKSPACE}/Trilinos/cmake/std/PullRequestLinuxGCC8.3.0TestingSettings.cmake` - -See `TrilinosPRConfigurationStandard.py`[2] for information on what options are set to something -other than the default during normal Trilinos PR operations. - -Expected Operation ------------------- -The expected operation of this set of files to replace the old `simple_testing.cmake` is to load -the [`ctest-driver.cmake`](ctest-driver.cmake) file in its place. - `ctest-driver.cmake` Options ---------------------------- @@ -103,11 +50,11 @@ the [`ctest-driver.cmake`](ctest-driver.cmake) file in its place. Example CTest call from a Trilinos PR ------------------------------------- -This is an example, for reference, of how the `ctest` command is invoked in the current/old Trilinos +This is an example, for reference, of how the `ctest` command is invoked in the current Trilinos PR test driver. ```bash ctest \ - -S simple_testing.cmake \ + -S ctest-driver.cmake \ -Dsource_dir=${WORKSPACE}/Trilinos \ -Dbuild_name=PR-9495-test-Trilinos_pullrequest_gcc_8.3.0-5164 \ -Dskip_by_parts_submit=OFF \ @@ -138,4 +85,4 @@ when only documentation or perhaps the testing framework itself is modified and not need to spend O(5 hours) for the test suite to run. [1]: https://cmake.org/cmake/help/latest/command/include_guard.html -[2]: https://github.com/trilinos/Trilinos/blob/master/cmake/std/trilinosprhelpers/TrilinosPRConfigurationStandard.py +[2]: https://github.com/trilinos/Trilinos/blob/master/packages/framework/pr_tools/trilinosprhelpers/TrilinosPRConfigurationStandard.py