summaryrefslogtreecommitdiffstats
path: root/Source/cmAddTestCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-07-17 12:11:37 (GMT)
committerBrad King <brad.king@kitware.com>2013-07-17 12:11:37 (GMT)
commitd0170584c54b515b7eb2d044c3d48332523b3a37 (patch)
tree34e9b9e12f724dbb584c2a7ed42f7523e4d68d1d /Source/cmAddTestCommand.h
parentff6de6d325fec9b4f257b27388be4a24fd8cadfe (diff)
downloadCMake-d0170584c54b515b7eb2d044c3d48332523b3a37.zip
CMake-d0170584c54b515b7eb2d044c3d48332523b3a37.tar.gz
CMake-d0170584c54b515b7eb2d044c3d48332523b3a37.tar.bz2
add_test: Document test name restrictions (#14298)
Diffstat (limited to 'Source/cmAddTestCommand.h')
-rw-r--r--Source/cmAddTestCommand.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/Source/cmAddTestCommand.h b/Source/cmAddTestCommand.h
index 6a0cd9d..ec7fda3 100644
--- a/Source/cmAddTestCommand.h
+++ b/Source/cmAddTestCommand.h
@@ -71,6 +71,9 @@ public:
" add_test(NAME <name> [CONFIGURATIONS [Debug|Release|...]]\n"
" [WORKING_DIRECTORY dir]\n"
" COMMAND <command> [arg1 [arg2 ...]])\n"
+ "Add a test called <name>. "
+ "The test name may not contain spaces, quotes, or other characters "
+ "special in CMake syntax. "
"If COMMAND specifies an executable target (created by "
"add_executable) it will automatically be replaced by the location "
"of the executable created at build time. "