reactos/CMake
1
0
Fork 0
mirror of https://github.com/reactos/CMake.git synced 2024-11-28 14:01:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Help: De-duplicate manual/(cmake|ccmake).1.rst build options

Browse Source 
Move common build options out of cmake and ccmake manuals into an
OPTIONS_BUILD.txt file and include it from the original locations.
This commit is contained in:
Brad King 2013-10-16 11:24:16 -04:00
parent ae944d176e
commit 5dde65ac5b
3 changed files with 59 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
Help/manual/OPTIONS_BUILD.txt Normal file
View File

@ -0,0 +1,57 @@
* ``-C <initial-cache>``: Pre-load a script to populate the cache.
When cmake is first run in an empty build tree, it creates a
CMakeCache.txt file and populates it with customizable settings for
the project. This option may be used to specify a file from which
to load cache entries before the first pass through the project's
cmake listfiles. The loaded entries take priority over the
project's default values. The given file should be a CMake script
containing SET commands that use the CACHE option, not a
cache-format file.
* ``-D <var>:<type>=<value>``: Create a cmake cache entry.
When cmake is first run in an empty build tree, it creates a
CMakeCache.txt file and populates it with customizable settings for
the project. This option may be used to specify a setting that
takes priority over the project's default value. The option may be
repeated for as many cache entries as desired.
* ``-U <globbing_expr>``: Remove matching entries from CMake cache.
This option may be used to remove one or more variables from the
CMakeCache.txt file, globbing expressions using * and ? are
supported. The option may be repeated for as many cache entries as
desired.
Use with care, you can make your CMakeCache.txt non-working.
* ``-G <generator-name>``: Specify a build system generator.
CMake may support multiple native build systems on certain
platforms. A generator is responsible for generating a particular
build system. Possible generator names are specified in the
Generators section.
* ``-T <toolset-name>``: Specify toolset name if supported by generator.
Some CMake generators support a toolset name to be given to the
native build system to choose a compiler. This is supported only on
specific generators:
::
Visual Studio >= 10
Xcode >= 3.0
See native build system documentation for allowed toolset names.
* ``-Wno-dev``: Suppress developer warnings.
Suppress warnings that are meant for the author of the
CMakeLists.txt files.
* ``-Wdev``: Enable developer warnings.
Enable warnings that are meant for the author of the CMakeLists.txt
files.

59
Help/manual/ccmake.1.rst
View File

@ -23,64 +23,7 @@ in each directory of a source tree with the name CMakeLists.txt.
Users build a project by using CMake to generate a build system for a Users build a project by using CMake to generate a build system for a
native tool on their platform. native tool on their platform.
.. include:: OPTIONS_BUILD.txt
* ``-C <initial-cache>``: Pre-load a script to populate the cache.
When cmake is first run in an empty build tree, it creates a
CMakeCache.txt file and populates it with customizable settings for
the project. This option may be used to specify a file from which
to load cache entries before the first pass through the project's
cmake listfiles. The loaded entries take priority over the
project's default values. The given file should be a CMake script
containing SET commands that use the CACHE option, not a
cache-format file.
* ``-D <var>:<type>=<value>``: Create a cmake cache entry.
When cmake is first run in an empty build tree, it creates a
CMakeCache.txt file and populates it with customizable settings for
the project. This option may be used to specify a setting that
takes priority over the project's default value. The option may be
repeated for as many cache entries as desired.
* ``-U <globbing_expr>``: Remove matching entries from CMake cache.
This option may be used to remove one or more variables from the
CMakeCache.txt file, globbing expressions using * and ? are
supported. The option may be repeated for as many cache entries as
desired.
Use with care, you can make your CMakeCache.txt non-working.
* ``-G <generator-name>``: Specify a build system generator.
CMake may support multiple native build systems on certain
platforms. A generator is responsible for generating a particular
build system. Possible generator names are specified in the
Generators section.
* ``-T <toolset-name>``: Specify toolset name if supported by generator.
Some CMake generators support a toolset name to be given to the
native build system to choose a compiler. This is supported only on
specific generators:
::
Visual Studio >= 10
Xcode >= 3.0
See native build system documentation for allowed toolset names.
* ``-Wno-dev``: Suppress developer warnings.
Suppress warnings that are meant for the author of the
CMakeLists.txt files.
* ``-Wdev``: Enable developer warnings.
Enable warnings that are meant for the author of the CMakeLists.txt
files.
* ``--copyright [file]``: Print the CMake copyright and exit. * ``--copyright [file]``: Print the CMake copyright and exit.

58
Help/manual/cmake.1.rst
View File

@ -23,63 +23,7 @@ in each directory of a source tree with the name CMakeLists.txt.
Users build a project by using CMake to generate a build system for a Users build a project by using CMake to generate a build system for a
native tool on their platform. native tool on their platform.
* ``-C <initial-cache>``: Pre-load a script to populate the cache. .. include:: OPTIONS_BUILD.txt
When cmake is first run in an empty build tree, it creates a
CMakeCache.txt file and populates it with customizable settings for
the project. This option may be used to specify a file from which
to load cache entries before the first pass through the project's
cmake listfiles. The loaded entries take priority over the
project's default values. The given file should be a CMake script
containing SET commands that use the CACHE option, not a
cache-format file.
* ``-D <var>:<type>=<value>``: Create a cmake cache entry.
When cmake is first run in an empty build tree, it creates a
CMakeCache.txt file and populates it with customizable settings for
the project. This option may be used to specify a setting that
takes priority over the project's default value. The option may be
repeated for as many cache entries as desired.
* ``-U <globbing_expr>``: Remove matching entries from CMake cache.
This option may be used to remove one or more variables from the
CMakeCache.txt file, globbing expressions using * and ? are
supported. The option may be repeated for as many cache entries as
desired.
Use with care, you can make your CMakeCache.txt non-working.
* ``-G <generator-name>``: Specify a build system generator.
CMake may support multiple native build systems on certain
platforms. A generator is responsible for generating a particular
build system. Possible generator names are specified in the
Generators section.
* ``-T <toolset-name>``: Specify toolset name if supported by generator.
Some CMake generators support a toolset name to be given to the
native build system to choose a compiler. This is supported only on
specific generators:
::
Visual Studio >= 10
Xcode >= 3.0
See native build system documentation for allowed toolset names.
* ``-Wno-dev``: Suppress developer warnings.
Suppress warnings that are meant for the author of the
CMakeLists.txt files.
* ``-Wdev``: Enable developer warnings.
Enable warnings that are meant for the author of the CMakeLists.txt
files.
* ``-E``: CMake command mode. * ``-E``: CMake command mode.