diff options
| author | Michael Scott <michael.scott250@gmail.com> | 2015-11-08 23:16:58 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-12-01 15:22:19 (GMT) |
| commit | b146747ed7f3cee8d8ef9c3ea6899ec3135aa527 (patch) | |
| tree | bf801b1b557383f2283a6f56c0e2379a18de6a23 /Help/variable/CMAKE_ERROR_DEPRECATED.rst | |
| parent | da688bcb3b7edc1da19fc8b89e2425f40d3fa7f1 (diff) | |
| download | CMake-b146747ed7f3cee8d8ef9c3ea6899ec3135aa527.zip CMake-b146747ed7f3cee8d8ef9c3ea6899ec3135aa527.tar.gz CMake-b146747ed7f3cee8d8ef9c3ea6899ec3135aa527.tar.bz2 | |
Consistent documentation for deprecation message variables.
Make the documentation for the 'CMAKE_ERROR_DEPRECATED' CMake
variable consistent with the documentation for the
'CMAKE_WARN_DEPRECATED' CMake variable, in terms of wording.
Diffstat (limited to 'Help/variable/CMAKE_ERROR_DEPRECATED.rst')
| -rw-r--r-- | Help/variable/CMAKE_ERROR_DEPRECATED.rst | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/Help/variable/CMAKE_ERROR_DEPRECATED.rst b/Help/variable/CMAKE_ERROR_DEPRECATED.rst index 277a4cc..f3a6738 100644 --- a/Help/variable/CMAKE_ERROR_DEPRECATED.rst +++ b/Help/variable/CMAKE_ERROR_DEPRECATED.rst @@ -1,8 +1,7 @@ CMAKE_ERROR_DEPRECATED ---------------------- -Whether to issue deprecation errors for macros and functions. +Whether to issue errors for deprecated functionality. -If ``TRUE``, this can be used by macros and functions to issue fatal -errors when deprecated macros or functions are used. This variable is -``FALSE`` by default. +If ``TRUE``, use of deprecated functionality will issue fatal errors. +If this variable is not set, CMake behaves as if it were set to ``FALSE``. |