kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Help/manual/OPTIONS_BUILD.txt

126 lines
4.3 KiB
Plaintext
Raw Normal View History

Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``-C <initial-cache>``
Pre-load a script to populate the cache.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
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.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Document conversion of PATH/FILEPATH cache values to absolute paths Suggested-by: Roger Leigh <rleigh@codelibre.net>
2015-04-01 23:25:42 +03:00
``-D <var>:<type>=<value>, -D <var>=<value>``
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
Create a cmake cache entry.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
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.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Document conversion of PATH/FILEPATH cache values to absolute paths Suggested-by: Roger Leigh <rleigh@codelibre.net>
2015-04-01 23:25:42 +03:00
If the ``:<type>`` portion is given it must be one of the types
specified by the :command:`set` command documentation for its
``CACHE`` signature.
If the ``:<type>`` portion is omitted the entry will be created
with no type if it does not exist with a type already. If a
command in the project sets the type to ``PATH`` or ``FILEPATH``
then the ``<value>`` will be converted to an absolute path.
Help: Spell '-D' option consistently across documentation (#15575) Always show the option with its argument separate in summary text. State in the main documentation that the option and its argument can be given together too.
2015-05-20 15:30:36 +03:00
This option may also be given as a single argument:
``-D<var>:<type>=<value>`` or ``-D<var>=<value>``.
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``-U <globbing_expr>``
Remove matching entries from CMake cache.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
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.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
Use with care, you can make your CMakeCache.txt non-working.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``-G <generator-name>``
Specify a build system generator.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
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
Help: Clarify manual reference for generator names
2015-04-04 17:01:50 +03:00
:manual:`cmake-generators(7)` manual.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``-T <toolset-name>``
Specify toolset name if supported by generator.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
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:
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
::
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
Visual Studio >= 10
Xcode >= 3.0
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
See native build system documentation for allowed toolset names.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
cmake: Add -A option to specify a generator platform Define the 'cmake -A' option to set CMAKE_GENERATOR_PLATFORM without having to spell out the whole variable name. We choose the name '-A' for "platform" because '-P' is already taken, and in the common use case the "platform" is actually an architecture (e.g. x64). Teach the RunCMake test infrastructure to use -A to pass the generator platform. Extend the RunCMake.GeneratorPlatform test with a case to verify that the -A option cannot be repeated.
2014-09-12 17:55:06 +04:00
``-A <platform-name>``
Specify platform name if supported by generator.
Some CMake generators support a platform name to be given to the
Help: Clarify that `cmake -A` option sets VS IDE target architecture
2016-09-30 18:50:46 +03:00
native build system to choose a compiler or SDK. See the
:variable:`CMAKE_GENERATOR_PLATFORM` variable.
This is supported only on specific generators:
cmake: Add -A option to specify a generator platform Define the 'cmake -A' option to set CMAKE_GENERATOR_PLATFORM without having to spell out the whole variable name. We choose the name '-A' for "platform" because '-P' is already taken, and in the common use case the "platform" is actually an architecture (e.g. x64). Teach the RunCMake test infrastructure to use -A to pass the generator platform. Extend the RunCMake.GeneratorPlatform test with a case to verify that the -A option cannot be repeated.
2014-09-12 17:55:06 +04:00
Help: Clarify that `cmake -A` option sets VS IDE target architecture
2016-09-30 18:50:46 +03:00
* For :ref:`Visual Studio Generators` with VS 2005 and above this
specifies the target architecture.
cmake: Add -A option to specify a generator platform Define the 'cmake -A' option to set CMAKE_GENERATOR_PLATFORM without having to spell out the whole variable name. We choose the name '-A' for "platform" because '-P' is already taken, and in the common use case the "platform" is actually an architecture (e.g. x64). Teach the RunCMake test infrastructure to use -A to pass the generator platform. Extend the RunCMake.GeneratorPlatform test with a case to verify that the -A option cannot be repeated.
2014-09-12 17:55:06 +04:00
See native build system documentation for allowed platform names.
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``-Wno-dev``
Suppress developer warnings.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
Suppress warnings that are meant for the author of the
Modify dev warning options to affect deprecated warnings. Change the '-Wdev' and '-Wno-dev' options to also enable and suppress the deprecated warnings output, via the 'CMAKE_WARN_DEPRECATED' CMake variable, by default. This action does not happen if the user specifies a deprecated warning message option. Add tests and update the documentation for the new functionality.
2015-11-09 02:34:59 +03:00
CMakeLists.txt files. By default this will also turn off
deprecation warnings.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
``-Wdev``
Enable developer warnings.
Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations.
2013-10-16 19:24:16 +04:00
Help: Format manual/*.1.rst options as definition lists Convert the command-line option documentation formatting from bullet lists to definition lists.
2013-11-14 19:05:32 +04:00
Enable warnings that are meant for the author of the CMakeLists.txt
Modify dev warning options to affect deprecated warnings. Change the '-Wdev' and '-Wno-dev' options to also enable and suppress the deprecated warnings output, via the 'CMAKE_WARN_DEPRECATED' CMake variable, by default. This action does not happen if the user specifies a deprecated warning message option. Add tests and update the documentation for the new functionality.
2015-11-09 02:34:59 +03:00
files. By default this will also turn on deprecation warnings.
Add -W options to control deprecated warning messages. Add 'deprecated' warning options type, to allow setting CMAKE_WARN_DEPRECATED via the -W '-Wdeprecated' and '-Wno-deprecated' options. Add tests for new options and updated documentation.
2015-11-09 02:06:33 +03:00
Add -Werror and -Wno-error command-line options Expand the -W set of cmake options to include support for the -Werror and -Wno-error format, which is used to control upgrading and downgrading warning and error messages. Implement support for these new formats for the dev and deprecated message types. Add tests and updated documentation for new options.
2015-12-22 00:39:27 +03:00
``-Werror=dev``
Make developer warnings errors.
Make warnings that are meant for the author of the CMakeLists.txt files
errors. By default this will also turn on deprecated warnings as errors.
``-Wno-error=dev``
Make developer warnings not errors.
Make warnings that are meant for the author of the CMakeLists.txt files not
errors. By default this will also turn off deprecated warnings as errors.
Add -W options to control deprecated warning messages. Add 'deprecated' warning options type, to allow setting CMAKE_WARN_DEPRECATED via the -W '-Wdeprecated' and '-Wno-deprecated' options. Add tests for new options and updated documentation.
2015-11-09 02:06:33 +03:00
``-Wdeprecated``
Enable deprecated functionality warnings.
Enable warnings for usage of deprecated functionality, that are meant
for the author of the CMakeLists.txt files.
``-Wno-deprecated``
Suppress deprecated functionality warnings.
Suppress warnings for usage of deprecated functionality, that are meant
for the author of the CMakeLists.txt files.
Add -Werror and -Wno-error command-line options Expand the -W set of cmake options to include support for the -Werror and -Wno-error format, which is used to control upgrading and downgrading warning and error messages. Implement support for these new formats for the dev and deprecated message types. Add tests and updated documentation for new options.
2015-12-22 00:39:27 +03:00
``-Werror=deprecated``
Make deprecated macro and function warnings errors.
Make warnings for usage of deprecated macros and functions, that are meant
for the author of the CMakeLists.txt files, errors.
``-Wno-error=deprecated``
Make deprecated macro and function warnings not errors.
Make warnings for usage of deprecated macros and functions, that are meant
for the author of the CMakeLists.txt files, not errors.