diff options
| author | Brad King <brad.king@kitware.com> | 2023-02-15 15:38:45 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2023-02-15 15:48:26 (GMT) |
| commit | ef5a4d964ba1743fd7c343f1a6194ff82936d014 (patch) | |
| tree | 3fb2f0b8cba3c32d5ee1c7b276bb710cc7227176 /Help/variable | |
| parent | 37f068083ba53e4140e5660a82bda9708e53c356 (diff) | |
| download | CMake-ef5a4d964ba1743fd7c343f1a6194ff82936d014.zip CMake-ef5a4d964ba1743fd7c343f1a6194ff82936d014.tar.gz CMake-ef5a4d964ba1743fd7c343f1a6194ff82936d014.tar.bz2 | |
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
Diffstat (limited to 'Help/variable')
| -rw-r--r-- | Help/variable/CMAKE_EDIT_COMMAND.rst | 3 | ||||
| -rw-r--r-- | Help/variable/CMAKE_EXTRA_GENERATOR.rst | 6 |
2 files changed, 8 insertions, 1 deletions
diff --git a/Help/variable/CMAKE_EDIT_COMMAND.rst b/Help/variable/CMAKE_EDIT_COMMAND.rst index 2f4ab1f..b21434f 100644 --- a/Help/variable/CMAKE_EDIT_COMMAND.rst +++ b/Help/variable/CMAKE_EDIT_COMMAND.rst @@ -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)`. diff --git a/Help/variable/CMAKE_EXTRA_GENERATOR.rst b/Help/variable/CMAKE_EXTRA_GENERATOR.rst index 2c92323..0a113a5 100644 --- a/Help/variable/CMAKE_EXTRA_GENERATOR.rst +++ b/Help/variable/CMAKE_EXTRA_GENERATOR.rst @@ -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)`. |