summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-03-18 07:26:25 -0400
committerBrad King <brad.king@kitware.com>2022-03-18 07:39:22 -0400
commit1b8669c1d6f6e7c73b3cc2a148a46e545aefb75d (patch)
treee197e970e414b8f6d05ddf7405d7a8eeededcb95
parent6ac27468b48280274c4c106f7ee1d3ff171a4ff1 (diff)
downloadcmake-1b8669c1d6f6e7c73b3cc2a148a46e545aefb75d.tar.gz
Help: Document warning about multiple source paths
Although passing multiple source paths was never documented, it was not diagnosed by CMake 3.22 and below. In CMake 3.23 we now diagnose extra paths and warn. Document this change and add a release note. Issue: #23334
-rw-r--r--Help/manual/cmake.1.rst7
-rw-r--r--Help/release/3.23.rst6
2 files changed, 13 insertions, 0 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index 9a2b2ef8fa..18bdc5fccb 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -171,6 +171,13 @@ is used for the other. For example:
``cmake -B build -S src`` ``src`` ``build``
============================== ============ ===========
+.. versionchanged:: 3.23
+
+ CMake warns when multiple source paths are specified. This has never
+ been officially documented or supported, but older versions accidentally
+ accepted multiple source paths and used the last path specified.
+ Avoid passing multiple source path arguments.
+
After generating a buildsystem one may use the corresponding native
build tool to build the project. For example, after using the
:generator:`Unix Makefiles` generator one may run ``make`` directly:
diff --git a/Help/release/3.23.rst b/Help/release/3.23.rst
index c3bee02b7e..69b935dccb 100644
--- a/Help/release/3.23.rst
+++ b/Help/release/3.23.rst
@@ -225,6 +225,12 @@ CPack
Deprecated and Removed Features
===============================
+* :manual:`cmake(1)` now warns when multiple source paths are specified,
+ as in ``cmake -S src1 src2``. This has never been officially documented
+ or supported, but older versions accidentally accepted multiple source
+ paths and used the last path specified. Update scripts to avoid
+ passing multiple source path arguments.
+
* The :manual:`cpack(1)` undocumented ``OSXX11`` generator has been removed.
Other Changes