Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-20 04:24:36 +08:00
Code Issues Projects Releases Wiki Activity

Tests/RunCMake/CPack: Improve README

Browse Source 
Add hints for newbies.  Fix typos.
This commit is contained in:
Robert Schuster
2024-06-21 16:45:10 +02:00
committed by Brad King
parent 33b0acd8b7
commit a022705a2e
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Tests/RunCMake/CPack/README.txt
View File

@@ -10,8 +10,8 @@ CPack test root directory: 'Tests/RunCMake/CPack/tests'.
All phases are executed separately for each generator that is bound to a test. All phases are executed separately for each generator that is bound to a test.
Tests for each generator are subtests of test 'RunCMake.CPack_<generator_name>'. Tests for each generator are subtests of test 'RunCMake.CPack_<generator_name>'.
Each test must also be added to 'RunCMakeTest.cmake' script located in CPack Each test must be added to list "cpack_tests" in 'Tests/RunCMake/CMakeLists.txt'
test root directory. and also to 'RunCMakeTest.cmake' script located in 'Tests/RunCMake/CPack/'.
Line that adds a test is: Line that adds a test is:
run_cpack_test(<test_name> "<generator_name_list>" <compile_stage> run_cpack_test(<test_name> "<generator_name_list>" <compile_stage>
@@ -53,7 +53,7 @@ Test consists of
- verification of generated files - verification of generated files
The phases are executed once per specified generator, packaging type and subtest The phases are executed once per specified generator, packaging type and subtest
combinatiion. combination.
test prerequirements phase (optional): test prerequirements phase (optional):
-------------------------------------- --------------------------------------
@@ -136,7 +136,7 @@ this step and must contain
- EXPECTED_FILES_COUNT variable that contains the number of expected files that - EXPECTED_FILES_COUNT variable that contains the number of expected files that
will be generated (0 or more) will be generated (0 or more)
- EXPECTED_FILE_<file_number_starting_with_1> that contains globing expression - EXPECTED_FILE_<file_number_starting_with_1> that contains globbing expression
that uniquely defines expected file name (will be used to find expected file) that uniquely defines expected file name (will be used to find expected file)
and should be present once for each expected file. and should be present once for each expected file.
NOTE: This variable should be used only as last resort as it sets generator NOTE: This variable should be used only as last resort as it sets generator