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.
This commit is contained in:
Michael Scott 2015-11-08 23:16:58 +00:00 committed by Brad King
parent da688bcb3b
commit b146747ed7
1 changed files with 3 additions and 4 deletions

View File

@ -1,8 +1,7 @@
CMAKE_ERROR_DEPRECATED 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 If ``TRUE``, use of deprecated functionality will issue fatal errors.
errors when deprecated macros or functions are used. This variable is If this variable is not set, CMake behaves as if it were set to ``FALSE``.
``FALSE`` by default.