add_test: Document test name restrictions (#14298)

2013-07-17 08:11:37 -04:00 · 2013-07-17 08:11:37 -04:00 · d0170584c5
parent ff6de6d325
commit d0170584c5
1 changed files with 3 additions and 0 deletions
--- 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.  "