cmake/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst

24 lines
1.3 KiB
ReStructuredText
Raw Normal View History

2014-08-03 19:52:23 +02:00
CMAKE_USER_MAKE_RULES_OVERRIDE
------------------------------
Specify a CMake file that overrides platform information.
CMake loads the specified file while enabling support for each
2015-11-17 17:22:37 +01:00
language from either the :command:`project` or :command:`enable_language`
commands. It is loaded after CMake's builtin compiler and platform information
2014-08-03 19:52:23 +02:00
modules have been loaded but before the information is used. The file
may set platform information variables to override CMake's defaults.
This feature is intended for use only in overriding information
variables that must be set before CMake builds its first test project
to check that the compiler for a language works. It should not be
2015-11-17 17:22:37 +01:00
used to load a file in cases that a normal :command:`include` will work. Use
2014-08-03 19:52:23 +02:00
it only as a last resort for behavior that cannot be achieved any
2015-11-17 17:22:37 +01:00
other way. For example, one may set ``CMAKE_C_FLAGS_INIT`` to change the
default value used to initialize :variable:`CMAKE_C_FLAGS <CMAKE_<LANG>_FLAGS>`
before it is cached. The override file should NOT be used to set anything
that could be set after languages are enabled, such as variables like
:variable:`CMAKE_RUNTIME_OUTPUT_DIRECTORY` that affect the placement of
binaries. Information set in the file will be used for :command:`try_compile`
and :command:`try_run` builds too.