summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2020-07-27 13:26:21 (GMT)
committerCraig Scott <craig.scott@crascit.com>2020-07-27 22:04:11 (GMT)
commit5fc5f4d26ed0736f4023d1aa1de2aa24d4df15af (patch)
treed315e0d18b95daeea9374e40af817b8bc277bf0c /Help
parent16327086f020e5a2f4267e327e27b50b73e131ca (diff)
downloadCMake-5fc5f4d26ed0736f4023d1aa1de2aa24d4df15af.zip
CMake-5fc5f4d26ed0736f4023d1aa1de2aa24d4df15af.tar.gz
CMake-5fc5f4d26ed0736f4023d1aa1de2aa24d4df15af.tar.bz2
add_test: Revert "Allow special characters in test name"
Revert commit f84af8e270 (add_test: Allow special characters in test name, 2020-05-16, v3.18.0-rc1~142^2). Unfortunately the fix breaks projects that were working around the limitation with manual escaping. The fix can be re-introduced with a policy in a future version. Also add a 3.18.1 release note explaining the change. Fixes: #21017, #20965 Issue: #19391
Diffstat (limited to 'Help')
-rw-r--r--Help/command/add_test.rst5
-rw-r--r--Help/release/3.18.rst7
2 files changed, 9 insertions, 3 deletions
diff --git a/Help/command/add_test.rst b/Help/command/add_test.rst
index c0677d2..a77ba37 100644
--- a/Help/command/add_test.rst
+++ b/Help/command/add_test.rst
@@ -10,9 +10,8 @@ Add a test to the project to be run by :manual:`ctest(1)`.
[WORKING_DIRECTORY <dir>]
[COMMAND_EXPAND_LISTS])
-Adds a test called ``<name>``. The test name may contain arbitrary
-characters except for double-quotes. However, if it contains spaces
-or semicolons it must be enclosed in double-quotes. The options are:
+Adds a test called ``<name>``. The test name may not contain spaces,
+quotes, or other characters special in CMake syntax. The options are:
``COMMAND``
Specify the test command-line. If ``<command>`` specifies an
diff --git a/Help/release/3.18.rst b/Help/release/3.18.rst
index 427840e..ba80d2b 100644
--- a/Help/release/3.18.rst
+++ b/Help/release/3.18.rst
@@ -332,3 +332,10 @@ Changes made since CMake 3.18.0 include the following.
architecture (the Xcode ``ARCHS`` setting). This is needed for Xcode 12
to select the host's architecture, which older versions of Xcode did
by default.
+
+* In CMake 3.18.0 the :command:`add_test` command learned to support
+ special characters in test names. This was accidentally left out of
+ its release notes. Unfortunately the fix breaks existing projects
+ that were using manual quoting or escaping to work around the prior
+ limitation. This fix has been reverted in 3.18.1, but may be
+ re-introduced in future versions of CMake with a policy for compatibility.