Browse Source

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
pull/349/head
Brad King 3 years ago
parent
commit
1b8669c1d6
  1. 7
      Help/manual/cmake.1.rst
  2. 6
      Help/release/3.23.rst

7
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:

6
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

Loading…
Cancel
Save