kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Help/manual/cmake-generators.7.rst

113 lines
2.8 KiB
ReStructuredText
Raw Normal View History

Help: Glob manual/*.rst in Sphinx configuration Add the man page description line as explicit markup at the top of each Help/manual/*.rst file and scan it from conf.py to automatically generate the man_pages Sphinx configuration value. This reduces the number of places that need to be changed when a new manual is added.
2013-10-30 17:58:25 +04:00
.. cmake-manual-description: CMake Generators Reference
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
cmake-generators(7)
*******************
Help: Drop TOC from latex manuals A latex document can have its own TOC.
2014-11-06 19:37:24 +03:00
.. only:: html
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
.. contents::
Help: Organize and revise the cmake-generators.7 manual Move "extra" generators to their own section instead of duplicating them for each corresponding main generator. Divide the list of main generators into command-line and IDE sections and sort the names within each section. Document the environment from which each kind of generator may be used. Add a section to each "extra" generator documenting which main generators may be used with it.
2013-11-25 18:58:52 +04:00
Introduction
============
A *CMake Generator* is responsible for writing the input files for
a native build system. Exactly one of the `CMake Generators`_ must be
selected for a build tree to determine what native build system is to
be used. Optionally one of the `Extra Generators`_ may be selected
as a variant of some of the `Command-Line Build Tool Generators`_ to
produce project files for an auxiliary IDE.
CMake Generators are platform-specific so each may be available only
on certain platforms. The :manual:`cmake(1)` command-line tool ``--help``
output lists available generators on the current platform. Use its ``-G``
option to specify the generator for a new build tree.
The :manual:`cmake-gui(1)` offers interactive selection of a generator
when creating a new build tree.
CMake Generators
================
Command-Line Build Tool Generators
----------------------------------
These generators support command-line build tools. In order to use them,
one must launch CMake from a command-line prompt whose environment is
already configured for the chosen compiler and build tool.
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Split cmake-generators(7) into linkable subsections Many places in our documentation refer to "Makefile Generators" or "Visual Studio" generators as a group of generators. Give such places a linkable document section to reference since they cannot cross-reference the individual generators in the groups.
2015-04-03 18:04:57 +03:00
.. _`Makefile Generators`:
Makefile Generators
^^^^^^^^^^^^^^^^^^^
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
.. toctree::
Help: Limit reference manual toctree depth to 1 Add a :maxdepth: option to all toctree directives to limit their depth to 1. We do not want subheadings from individual documents to pollute the already large lists of CMake Domain objects.
2013-11-01 19:12:02 +04:00
:maxdepth: 1
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/generator/Borland Makefiles
/generator/MSYS Makefiles
Help: Organize and revise the cmake-generators.7 manual Move "extra" generators to their own section instead of duplicating them for each corresponding main generator. Divide the list of main generators into command-line and IDE sections and sort the names within each section. Document the environment from which each kind of generator may be used. Add a section to each "extra" generator documenting which main generators may be used with it.
2013-11-25 18:58:52 +04:00
/generator/MinGW Makefiles
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/generator/NMake Makefiles
Help: Organize and revise the cmake-generators.7 manual Move "extra" generators to their own section instead of duplicating them for each corresponding main generator. Divide the list of main generators into command-line and IDE sections and sort the names within each section. Document the environment from which each kind of generator may be used. Add a section to each "extra" generator documenting which main generators may be used with it.
2013-11-25 18:58:52 +04:00
/generator/NMake Makefiles JOM
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/generator/Unix Makefiles
Help: Organize and revise the cmake-generators.7 manual Move "extra" generators to their own section instead of duplicating them for each corresponding main generator. Divide the list of main generators into command-line and IDE sections and sort the names within each section. Document the environment from which each kind of generator may be used. Add a section to each "extra" generator documenting which main generators may be used with it.
2013-11-25 18:58:52 +04:00
/generator/Watcom WMake
Help: Split cmake-generators(7) into linkable subsections Many places in our documentation refer to "Makefile Generators" or "Visual Studio" generators as a group of generators. Give such places a linkable document section to reference since they cannot cross-reference the individual generators in the groups.
2015-04-03 18:04:57 +03:00
Ninja Generator
^^^^^^^^^^^^^^^
.. toctree::
:maxdepth: 1
/generator/Ninja
Help: Organize and revise the cmake-generators.7 manual Move "extra" generators to their own section instead of duplicating them for each corresponding main generator. Divide the list of main generators into command-line and IDE sections and sort the names within each section. Document the environment from which each kind of generator may be used. Add a section to each "extra" generator documenting which main generators may be used with it.
2013-11-25 18:58:52 +04:00
IDE Build Tool Generators
-------------------------
These generators support Integrated Development Environment (IDE)
project files. Since the IDEs configure their own environment
one may launch CMake from any environment.
Help: Split cmake-generators(7) into linkable subsections Many places in our documentation refer to "Makefile Generators" or "Visual Studio" generators as a group of generators. Give such places a linkable document section to reference since they cannot cross-reference the individual generators in the groups.
2015-04-03 18:04:57 +03:00
.. _`Visual Studio Generators`:
Visual Studio Generators
^^^^^^^^^^^^^^^^^^^^^^^^
Help: Organize and revise the cmake-generators.7 manual Move "extra" generators to their own section instead of duplicating them for each corresponding main generator. Divide the list of main generators into command-line and IDE sections and sort the names within each section. Document the environment from which each kind of generator may be used. Add a section to each "extra" generator documenting which main generators may be used with it.
2013-11-25 18:58:52 +04:00
.. toctree::
:maxdepth: 1
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/generator/Visual Studio 6
/generator/Visual Studio 7
Help: Organize and revise the cmake-generators.7 manual Move "extra" generators to their own section instead of duplicating them for each corresponding main generator. Divide the list of main generators into command-line and IDE sections and sort the names within each section. Document the environment from which each kind of generator may be used. Add a section to each "extra" generator documenting which main generators may be used with it.
2013-11-25 18:58:52 +04:00
/generator/Visual Studio 7 .NET 2003
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/generator/Visual Studio 8 2005
/generator/Visual Studio 9 2008
Help: Organize and revise the cmake-generators.7 manual Move "extra" generators to their own section instead of duplicating them for each corresponding main generator. Divide the list of main generators into command-line and IDE sections and sort the names within each section. Document the environment from which each kind of generator may be used. Add a section to each "extra" generator documenting which main generators may be used with it.
2013-11-25 18:58:52 +04:00
/generator/Visual Studio 10 2010
/generator/Visual Studio 11 2012
/generator/Visual Studio 12 2013
VS: Rename VS 14 generator to 'Visual Studio 14 2015' Now that we know the year component of this VS version we can add it to the generator name. For convenience, map the name without the year to the name with the year.
2014-11-14 22:21:50 +03:00
/generator/Visual Studio 14 2015
Help: Split cmake-generators(7) into linkable subsections Many places in our documentation refer to "Makefile Generators" or "Visual Studio" generators as a group of generators. Give such places a linkable document section to reference since they cannot cross-reference the individual generators in the groups.
2015-04-03 18:04:57 +03:00
Xcode Generator
^^^^^^^^^^^^^^^
.. toctree::
:maxdepth: 1
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/generator/Xcode
Help: Organize and revise the cmake-generators.7 manual Move "extra" generators to their own section instead of duplicating them for each corresponding main generator. Divide the list of main generators into command-line and IDE sections and sort the names within each section. Document the environment from which each kind of generator may be used. Add a section to each "extra" generator documenting which main generators may be used with it.
2013-11-25 18:58:52 +04:00
Extra Generators
================
Some of the `CMake Generators`_ listed in the :manual:`cmake(1)`
command-line tool ``--help`` output may have variants that specify
an extra generator for an auxiliary IDE tool. Such generator
names have the form ``<extra-generator> - <main-generator>``.
The following extra generators are known to CMake.
.. toctree::
:maxdepth: 1
/generator/CodeBlocks
Add support for codelite IDE project fles
2014-01-10 11:20:11 +04:00
/generator/CodeLite
Help: Organize and revise the cmake-generators.7 manual Move "extra" generators to their own section instead of duplicating them for each corresponding main generator. Divide the list of main generators into command-line and IDE sections and sort the names within each section. Document the environment from which each kind of generator may be used. Add a section to each "extra" generator documenting which main generators may be used with it.
2013-11-25 18:58:52 +04:00
/generator/Eclipse CDT4
/generator/KDevelop3
kate: add some documentation Alex
2013-11-16 19:13:13 +04:00
/generator/Kate
Help: Organize and revise the cmake-generators.7 manual Move "extra" generators to their own section instead of duplicating them for each corresponding main generator. Divide the list of main generators into command-line and IDE sections and sort the names within each section. Document the environment from which each kind of generator may be used. Add a section to each "extra" generator documenting which main generators may be used with it.
2013-11-25 18:58:52 +04:00
/generator/Sublime Text 2
Qbs: Add new 'extra' generator for qbs project files
2015-02-08 15:50:16 +03:00
/generator/Qbs