summaryrefslogtreecommitdiffstats
path: root/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst
diff options
context:
space:
mode:
authorJames Johnston <johnstonj.public@codenest.com>2015-08-18 05:34:01 (GMT)
committerBrad King <brad.king@kitware.com>2015-08-21 13:32:08 (GMT)
commit3bb707f0a1408dc0381ecbf4ec934e9f14d8927c (patch)
tree1e6c4f6a4ad78a3d1635070207aa281bbd0e9493 /Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst
parent404d16e7bc1b18027f719cd8642d0a90c679c396 (diff)
downloadCMake-3bb707f0a1408dc0381ecbf4ec934e9f14d8927c.zip
CMake-3bb707f0a1408dc0381ecbf4ec934e9f14d8927c.tar.gz
CMake-3bb707f0a1408dc0381ecbf4ec934e9f14d8927c.tar.bz2
Help: Improve formatting of variable documentation
Improve formatting, primarily by: * Adding links to relevant commands, properties, generators, and so on. * Converting code, symbols, paths, and so on to fixed-width fonts. * Hard wrapping lines to 80 characters or less.
Diffstat (limited to 'Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst')
-rw-r--r--Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst20
1 files changed, 10 insertions, 10 deletions
diff --git a/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst b/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst
index 5a4c86b..9af0d97 100644
--- a/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst
+++ b/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst
@@ -4,20 +4,20 @@ CMAKE_USER_MAKE_RULES_OVERRIDE
Specify a CMake file that overrides platform information.
CMake loads the specified file while enabling support for each
-language from either the project() or enable_language() commands. It
-is loaded after CMake's builtin compiler and platform information
+language from either the :command:`project` or :command:`enable_language`
+commands. It is loaded after CMake's builtin compiler and platform information
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
-used to load a file in cases that a normal include() will work. Use
+used to load a file in cases that a normal :command:`include` will work. Use
it only as a last resort for behavior that cannot be achieved any
-other way. For example, one may set CMAKE_C_FLAGS_INIT to change the
-default value used to initialize CMAKE_C_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
-CMAKE_RUNTIME_OUTPUT_DIRECTORY that affect the placement of binaries.
-Information set in the file will be used for try_compile and try_run
-builds too.
+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.