Deprecate "extra" generators in favor of cmake-file-api(7)

The "extra" generators were created in CMake's early years to provide
support for users of specific IDEs by directly generating their project
files alongside make or ninja files.  Nowadays the file-api provides a
more generic, maintainable, well-tested, and robust way for IDEs to view
CMake project build trees.  Deprecate the legacy "extra" generators to
encourage the corresponding IDEs to use the file-api.

Fixes: #19090
This commit is contained in:
Brad King
2023-02-15 10:38:45 -05:00
parent 37f068083b
commit ef5a4d964b
17 changed files with 75 additions and 7 deletions

View File

@@ -2,7 +2,8 @@ CMAKE_EDIT_COMMAND
------------------
Full path to :manual:`cmake-gui(1)` or :manual:`ccmake(1)`. Defined only for
:ref:`Makefile Generators` when not using an "extra" generator for an IDE.
:ref:`Makefile Generators` and :ref:`Ninja Generators` when not using any
:ref:`Extra Generators`.
This is the full path to the CMake executable that can graphically
edit the cache. For example, :manual:`cmake-gui(1)` or :manual:`ccmake(1)`.

View File

@@ -1,6 +1,12 @@
CMAKE_EXTRA_GENERATOR
---------------------
.. deprecated:: 3.27
Support for :ref:`Extra Generators` is deprecated and will be removed from
a future version of CMake. IDEs may use the :manual:`cmake-file-api(7)`
to view CMake-generated project build trees.
The extra generator used to build the project. See
:manual:`cmake-generators(7)`.