diff options
| author | James Johnston <johnstonj.public@codenest.com> | 2015-08-18 05:34:01 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-08-21 13:32:08 (GMT) |
| commit | 3bb707f0a1408dc0381ecbf4ec934e9f14d8927c (patch) | |
| tree | 1e6c4f6a4ad78a3d1635070207aa281bbd0e9493 /Help/variable/CMAKE_POLICY_DEFAULT_CMPNNNN.rst | |
| parent | 404d16e7bc1b18027f719cd8642d0a90c679c396 (diff) | |
| download | CMake-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_POLICY_DEFAULT_CMPNNNN.rst')
| -rw-r--r-- | Help/variable/CMAKE_POLICY_DEFAULT_CMPNNNN.rst | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/Help/variable/CMAKE_POLICY_DEFAULT_CMPNNNN.rst b/Help/variable/CMAKE_POLICY_DEFAULT_CMPNNNN.rst index e401aa5..43582be 100644 --- a/Help/variable/CMAKE_POLICY_DEFAULT_CMPNNNN.rst +++ b/Help/variable/CMAKE_POLICY_DEFAULT_CMPNNNN.rst @@ -1,16 +1,17 @@ CMAKE_POLICY_DEFAULT_CMP<NNNN> ------------------------------ -Default for CMake Policy CMP<NNNN> when it is otherwise left unset. +Default for CMake Policy ``CMP<NNNN>`` when it is otherwise left unset. -Commands cmake_minimum_required(VERSION) and cmake_policy(VERSION) by -default leave policies introduced after the given version unset. Set -CMAKE_POLICY_DEFAULT_CMP<NNNN> to OLD or NEW to specify the default -for policy CMP<NNNN>, where <NNNN> is the policy number. +Commands :command:`cmake_minimum_required(VERSION)` and +:command:`cmake_policy(VERSION)` by default leave policies introduced after +the given version unset. Set ``CMAKE_POLICY_DEFAULT_CMP<NNNN>`` to ``OLD`` +or ``NEW`` to specify the default for policy ``CMP<NNNN>``, where ``<NNNN>`` +is the policy number. This variable should not be set by a project in CMake code; use -cmake_policy(SET) instead. Users running CMake may set this variable -in the cache (e.g. -DCMAKE_POLICY_DEFAULT_CMP<NNNN>=<OLD|NEW>) to set -a policy not otherwise set by the project. Set to OLD to quiet a -policy warning while using old behavior or to NEW to try building the +:command:`cmake_policy(SET)` instead. Users running CMake may set this +variable in the cache (e.g. ``-DCMAKE_POLICY_DEFAULT_CMP<NNNN>=<OLD|NEW>``) +to set a policy not otherwise set by the project. Set to ``OLD`` to quiet a +policy warning while using old behavior or to ``NEW`` to try building the project with new behavior. |