CMake/Help/generator/CodeBlocks.rst
Brad King ef5a4d964b 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
2023-02-15 10:48:26 -05:00

42 lines
1.3 KiB
ReStructuredText

CodeBlocks
----------
.. 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.
Generates CodeBlocks project files.
Project files for CodeBlocks will be created in the top directory and
in every subdirectory which features a ``CMakeLists.txt`` file containing
a :command:`project` call. Additionally a hierarchy of makefiles is generated
into the build tree.
The appropriate make program can build the
project through the default ``all`` target. An ``install`` target is
also provided.
.. versionadded:: 3.10
The :variable:`CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES` variable may
be set to ``ON`` to exclude any files which are located outside of
the project root directory.
This "extra" generator may be specified as:
``CodeBlocks - MinGW Makefiles``
Generate with :generator:`MinGW Makefiles`.
``CodeBlocks - NMake Makefiles``
Generate with :generator:`NMake Makefiles`.
``CodeBlocks - NMake Makefiles JOM``
.. versionadded:: 3.8
Generate with :generator:`NMake Makefiles JOM`.
``CodeBlocks - Ninja``
Generate with :generator:`Ninja`.
``CodeBlocks - Unix Makefiles``
Generate with :generator:`Unix Makefiles`.